Skip to main content
Version: Next

booleanCrosses

Description

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

NameTypeDescription
feature1Geometry | Feature<any>GeoJSON Feature or Geometry
feature2Geometry | Feature<any>GeoJSON Feature or Geometry

Returns

    boolean true/false

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

Installation

$ npm install @turf/boolean-crosses

import { booleanCrosses } from "@turf/boolean-crosses";
const result = booleanCrosses(...);
$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.booleanCrosses(...);