@turf/boolean-contains
Advanced tools
@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.
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); // trueCheck 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); // trueCheck 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); // trueGeolib 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 (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 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.
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
feature1 (Geometry | Feature<any>) GeoJSON Feature or Geometryfeature2 (Geometry | Feature<any>) GeoJSON Feature or GeometryExamples
var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
var point = turf.point([1, 2]);
turf.booleanContains(line, point);
//=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.
Install this module individually:
$ npm install @turf/boolean-contains
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
6.2.0
After a bit of hiatus, TurfJS is resuming releases.
@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)
@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)
@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)
@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)
@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)
FAQs
turf boolean-contains module
The npm package @turf/boolean-contains receives a total of 0 weekly downloads. As such, @turf/boolean-contains popularity was classified as not popular.
We found that @turf/boolean-contains demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.