@turf/boolean-overlap

@turf/boolean-overlap

booleanOverlap

Compares two geometries of the same dimension and returns true if their intersection set results in a geometry different from both but of the same dimension. It applies to Polygon/Polygon, LineString/LineString, Multipoint/Multipoint, MultiLineString/MultiLineString and MultiPolygon/MultiPolygon.

Parameters

• feature1 (Geometry | Feature<(LineString | MultiLineString | Polygon | MultiPolygon)>) input
• feature2 (Geometry | Feature<(LineString | MultiLineString | Polygon | MultiPolygon)>) input

Examples

var poly1 = turf.polygon([[[0,0],[0,5],[5,5],[5,0],[0,0]]]);
var poly2 = turf.polygon([[[1,1],[1,6],[6,6],[6,1],[1,1]]]);
var poly3 = turf.polygon([[[10,10],[10,15],[15,15],[15,10],[10,10]]]);

turf.booleanOverlap(poly1, poly2)
//=true
turf.booleanOverlap(poly2, poly3)
//=false

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 module individually:

$ npm install @turf/boolean-overlap

Or install the Turf module that includes it as a function:

$ npm install @turf/turf

Diagrams

Changelog

6.4.0

🏅 New Features/Enhancements

• @turf/boolean-point-on-line Added an epislon option to help in floating point comparison. (PR https://github.com/Turfjs/turf/pull/2051 - Author @okcoker)

🐛 Bug Fixes

• @turf/line-slice-along Fixed a bug where the offset distance equal to the length of the line (PR https://github.com/Turfjs/turf/pull/2030 - Author @EricPKerr)

• @turf/helpers Fixed the conversion ratio for converting meters to yards and vice-versa (PR https://github.com/Turfjs/turf/pull/2046 - Author @anotherhale)

• @turf/center-median Fixed a missing TS type import (PR https://github.com/Turfjs/turf/pull/2044 - Author @Seairth)

• `@turf/bezier-spline Fix a bug ensuring the spline result reaches the end of the input (PR https://github.com/Turfjs/turf/pull/2090 - Author @the-nemz)

📖 Documentation

• @turf/transform-rotate and @turf/ellipse) Improve documentation for angle parameter (PR https://github.com/Turfjs/turf/pull/2016 - Author @pasieronen)

• @turf/line-chunk Fix an invalid anchor (PR https://github.com/Turfjs/turf/pull/2071 - Author @GraxMonzo)

• @turf/distance Enhance distance doco so supported inputs are clearer (PR https://github.com/Turfjs/turf/pull/2032 - Author @rowanwins)

🔔 Misc

• @turf/concave Replace deprecated topojson dependency (PR https://github.com/Turfjs/turf/pull/2037 - Author @elliots)

• Work towards enabling TS Strict Mode (PR https://github.com/Turfjs/turf/pull/2053 - Author @mfedderly)