mirror of
https://github.com/Turfjs/turf.git
synced 2025-12-08 20:26:16 +00:00
@turf/boolean-intersects
booleanIntersects
Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.
Parameters
-
feature1(Geometry | Feature<any>) GeoJSON Feature or Geometry -
feature2(Geometry | Feature<any>) GeoJSON Feature or Geometry -
optionsObject Optional parameters (optional, default{})options.ignoreSelfIntersectionsboolean ignore self-intersections on input features (optional, defaulttrue)
Examples
var point1 = turf.point([2, 2]);
var point2 = turf.point([1, 2]);
var line = turf.lineString([[1, 1], [1, 3], [1, 4]]);
turf.booleanIntersects(line, point1);
//=false
turf.booleanIntersects(line, point2);
//=true
//addToMap
var addToMap = [point1, point2, line];
point1.properties['marker-color'] = '#f00'
point2.properties['marker-color'] = '#0f0'
Returns boolean true if geometries intersect, false otherwise
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 single module individually:
$ npm install @turf/boolean-intersects
Or install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf