What is @turf/boolean-contains?
@turf/boolean-contains is a module from the Turf.js library that provides geospatial analysis tools. This specific module is used to determine if one GeoJSON geometry contains another GeoJSON geometry.
What are @turf/boolean-contains's main functionalities?
Check if a Polygon contains another Polygon
This feature checks if one polygon contains another polygon. In this example, polygon1 contains polygon2, so the result is true.
const turf = require('@turf/turf');
const polygon1 = turf.polygon([[[0, 0], [0, 10], [10, 10], [10, 0], [0, 0]]]);
const polygon2 = turf.polygon([[[2, 2], [2, 8], [8, 8], [8, 2], [2, 2]]]);
const contains = turf.booleanContains(polygon1, polygon2);
console.log(contains); // true
Check if a Polygon contains a Point
This feature checks if a polygon contains a point. In this example, the polygon contains the point, so the result is true.
const turf = require('@turf/turf');
const polygon = turf.polygon([[[0, 0], [0, 10], [10, 10], [10, 0], [0, 0]]]);
const point = turf.point([5, 5]);
const contains = turf.booleanContains(polygon, point);
console.log(contains); // true
Check if a MultiPolygon contains a Polygon
This feature checks if a MultiPolygon contains a polygon. In this example, the MultiPolygon contains the polygon, so the result is true.
const turf = require('@turf/turf');
const multiPolygon = turf.multiPolygon([[[[0, 0], [0, 10], [10, 10], [10, 0], [0, 0]]], [[[20, 20], [20, 30], [30, 30], [30, 20], [20, 20]]]]);
const polygon = turf.polygon([[[2, 2], [2, 8], [8, 8], [8, 2], [2, 2]]]);
const contains = turf.booleanContains(multiPolygon, polygon);
console.log(contains); // true
Other packages similar to @turf/boolean-contains
geolib
Geolib is a library for geospatial calculations. It provides functions to check if a point is inside a polygon, calculate distances, and more. Compared to @turf/boolean-contains, geolib offers a broader range of geospatial functions but may not be as specialized in GeoJSON operations.
jsts
JSTS (JavaScript Topology Suite) is a library for performing operations on geometries. It includes functions for spatial relationships like contains, intersects, and more. JSTS is more comprehensive in terms of geometric operations but can be more complex to use compared to @turf/boolean-contains.
leaflet
Leaflet is a popular library for interactive maps. It includes basic geospatial functions like checking if a point is within a polygon. While Leaflet is primarily focused on map rendering and interaction, it provides some geospatial analysis capabilities similar to @turf/boolean-contains.
@turf/boolean-contains
booleanContains
Boolean-contains returns True if the second geometry is completely contained by the first geometry.
The interiors of both geometries must intersect and, the interior and boundary of the secondary (geometry b)
must not intersect the exterior of the primary (geometry a).
Boolean-contains returns the exact opposite result of the @turf/boolean-within
.
Parameters
Examples
var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
var point = turf.point([1, 2]);
turf.booleanContains(line, point);
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-contains
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
Diagrams
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)