@turf/boolean-within

What is @turf/boolean-within?

@turf/boolean-within is a module from the Turf.js library that provides geospatial analysis tools. This specific module is used to determine if a given geometry (point, line, polygon) is within another geometry. It is useful for spatial queries and geographic information system (GIS) applications.

What are @turf/boolean-within's main functionalities?

Point within Polygon

This feature checks if a point is within a polygon. The code sample creates a point and a polygon, then uses the booleanWithin function to determine if the point is inside the polygon.

const turf = require('@turf/turf');
const point = turf.point([2, 2]);
const polygon = turf.polygon([[
  [0, 0], [0, 5], [5, 5], [5, 0], [0, 0]
]]);
const isWithin = turf.booleanWithin(point, polygon);
console.log(isWithin); // true

LineString within Polygon

This feature checks if a LineString is within a polygon. The code sample creates a LineString and a polygon, then uses the booleanWithin function to determine if the LineString is inside the polygon.

const turf = require('@turf/turf');
const line = turf.lineString([[1, 1], [2, 2], [3, 3]]);
const polygon = turf.polygon([[
  [0, 0], [0, 5], [5, 5], [5, 0], [0, 0]
]]);
const isWithin = turf.booleanWithin(line, polygon);
console.log(isWithin); // true

Polygon within Polygon

This feature checks if a polygon is within another polygon. The code sample creates an inner polygon and an outer polygon, then uses the booleanWithin function to determine if the inner polygon is inside the outer polygon.

const turf = require('@turf/turf');
const innerPolygon = turf.polygon([[
  [1, 1], [1, 4], [4, 4], [4, 1], [1, 1]
]]);
const outerPolygon = turf.polygon([[
  [0, 0], [0, 5], [5, 5], [5, 0], [0, 0]
]]);
const isWithin = turf.booleanWithin(innerPolygon, outerPolygon);
console.log(isWithin); // true

Other packages similar to @turf/boolean-within

geolib

Geolib is a library for geospatial calculations. It provides functions to check if a point is inside a polygon, similar to @turf/boolean-within. However, it does not support more complex geometries like LineStrings or Polygons within Polygons.

jsts

JSTS (JavaScript Topology Suite) is a library for performing various geometric operations. It includes functions to check if geometries are within other geometries, similar to @turf/boolean-within. JSTS is more comprehensive and supports a wider range of geometric operations.

leaflet

Leaflet is a popular library for interactive maps. It includes basic geospatial analysis functions, such as checking if a point is within a polygon. However, its primary focus is on map rendering and interaction, not on complex geospatial analysis.

README

@turf/boolean-within

booleanWithin

Boolean-within returns true if the first geometry is completely within the second geometry. The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a) must not intersect the exterior of the secondary (geometry b). Boolean-within returns the exact opposite result of the @turf/boolean-contains.

Parameters

• feature1 (Geometry | Feature<any>) GeoJSON Feature or Geometry
• feature2 (Geometry | Feature<any>) GeoJSON Feature or Geometry

Examples

var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
var point = turf.point([1, 2]);

turf.booleanWithin(point, line);
//=true

Returns boolean true/false

---

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @turf/boolean-within

Or install the Turf module that includes it as a function:

$ npm install @turf/turf

Changelog

6.2.0

After a bit of hiatus, TurfJS is resuming releases.

⭐️ Major Updates

• ES Modules available for all packages
• Tree shaking should significantly reduce import size of @turf/turf
• Better support for ESM modules (PR https://github.com/Turfjs/turf/pull/1942 - Author @diachedelic)
• Clean-up of test and benchmark running to make publishing easier
• Enforce styling using Prettier
• Enable ESLint and get rid of unused variables
• Upgrade rollup for more correct javascript module builds
• Only include ES5 code

🚀 New Modules

[@turf/boolean-touches][boolean-touches]

Determines if two features touch but do not intersect

[@turf/boolean-valid][boolean-valid]

Checks if the geometry is a valid according to the OGC Simple Feature Specification

[@turf/quadrat-analysis][quadrat-analysis]

Performs a quadrat analysis on a set of points

[@turf/rectangle-grid][rectangle-grid]

Creates a grid of rectangles from a bounding box

[@turf/voroni][voronoi]

Typescript types for the options parameter have been fixed (PR https://github.com/Turfjs/turf/pull/1424 - Author @stevage)

[@turf/points-within-polygon][points-within-polygon]

Typescript types around the Feature's Properties will now be preserved. (PR https://github.com/Turfjs/turf/pull/1761 - Author @rugheid)

[@turf/rewind][rewind]

Typescript types for the 'reverse' option are now correct. Previously it was misnamed as 'reversed'. (PR https://github.com/Turfjs/turf/pull/1786 - Author @jonnycornwell)

[@turf/difference][difference]

No longer publishes an .mjs file.

[@turf/meta][meta]

No longer publishes an .mjs file.

[@turf/tag][tag]

Add MultiPolygon support. (PR https://github.com/Turfjs/turf/pull/1996 - Author bryceroney)

🐛 Bug Fixes

• @turf/centroid Don't visit first point twice when calculating centroid (PR https://github.com/Turfjs/turf/pull/1894 - Author @rowanwins)

• @turf/transform-translate Better handling of negative distances (PR https://github.com/Turfjs/turf/pull/1895 - Author @rowanwins)

• @turf/union, @turf/difference, @turf/intersect Use polygon-clipping library to fix correctness issues (PR https://github.com/Turfjs/turf/pull/1916 - Authors @mbullington, @ngottlieb)

• @turf/buffer Change default number of steps to 8, and actually support the steps option (PR https://github.com/Turfjs/turf/pull/1931 - Author stevenchanin)

• @turf/buffer Fix projection issues that produce undersized buffers at non-equatorial latitudes (PR https://github.com/Turfjs/turf/pull/1956 - Author dyakovlev)

• @turf/helpers Add runtime checks to point() method, fixing an API break (PR https://github.com/Turfjs/turf/pull/1964)

🏅 New Features/Enhancements

• @turf/boolean-overlap Better performance for MultiPoint geometries (PR https://github.com/Turfjs/turf/pull/1910 - Author @mfedderly)

• @turf/helpers Add hectares to convertArea (PR https://github.com/Turfjs/turf/pull/1943 - Author @DanielJDufour)

• @turf/great-circle Update Typescript types to support MultiLineString input (PR https://github.com/Turfjs/turf/pull/1928 - Author kronick)

📖 Documentation

• @turf/square-grid Clarify inputs (PR https://github.com/Turfjs/turf/pull/1885 - Author @raphael-leger)

• @turf/greater-circle Clarify properties option example (PR https://github.com/Turfjs/turf/pull/1888 - Author @chris-catignani)

⚠️ Breaking Change

• @turf/line-to-polygon no longer modifies its input unless the mutate option is true (PR https://github.com/Turfjs/turf/pull/1879 - Author @MortenBirk)

• @turf/unkink-polygon remove Number.prototype.modulo override (PR https://github.com/Turfjs/turf/pull/1978)