turf/packages/turf-boolean-crosses

@turf/boolean-crosses

booleanCrosses

Boolean-Crosses returns True if the intersection results in a geometry whose dimension is one less than the maximum dimension of the two source geometries and the intersection set is interior to both source geometries.

Boolean-Crosses returns t (TRUE) for only multipoint/polygon, multipoint/linestring, linestring/linestring, linestring/polygon, and linestring/multipolygon comparisons. Other comparisons are not supported as they are outside the OpenGIS Simple Features spec and may give unexpected results.

Parameters

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

Examples

var line1 = turf.lineString([[-2, 2], [4, 2]]);
var line2 = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);

var cross = turf.booleanCrosses(line1, line2);
//=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 single module individually:

$ npm install @turf/boolean-crosses

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf

Diagrams