package
Determines whether the second geometry is completely within the first geometry.
npm install @turf/boolean-containsGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Tests whether geometry a contains geometry b. The interiors of both geometries must intersect, and the interior and boundary of geometry b must not intersect the exterior of geometry a. booleanContains(a, b) is equivalent to booleanWithin(b, a)
feature1 (Geometry | Feature<any>) GeoJSON Feature or Geometryfeature2 (Geometry | Feature<any>) GeoJSON Feature or Geometryvar line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
var point = turf.point([1, 2]);
turf.booleanContains(line, point);
//=trueReturns 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 single module individually:
$ npm install @turf/boolean-containsOr install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf
tmcw
tom@macwright.com
Estimated unpacked size across 20 packages.
1.3 MB
Includes dependencies.
8 direct dependencies.
^2.8.1
2.9.1
7.4.0
7.4.0
7.4.0
7.4.0
^7946.0.10
7946.0.16
7.4.0
7.4.0