73 lines
2.2 KiB
Markdown
Executable File
73 lines
2.2 KiB
Markdown
Executable File
# @turf/boolean-overlap
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## 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][1] \| [Feature][2]<([LineString][3] \| [MultiLineString][4] \| [Polygon][5] \| [MultiPolygon][6])>)** input
|
|
- `feature2` **([Geometry][1] \| [Feature][2]<([LineString][3] \| [MultiLineString][4] \| [Polygon][5] \| [MultiPolygon][6])>)** input
|
|
|
|
**Examples**
|
|
|
|
```javascript
|
|
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][7]** true/false
|
|
|
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1
|
|
|
|
[2]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
|
|
[3]: https://tools.ietf.org/html/rfc7946#section-3.1.4
|
|
|
|
[4]: https://tools.ietf.org/html/rfc7946#section-3.1.5
|
|
|
|
[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6
|
|
|
|
[6]: https://tools.ietf.org/html/rfc7946#section-3.1.7
|
|
|
|
[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
|
|
|
|
<!-- This file is automatically generated. Please don't edit it directly:
|
|
if you find an error, edit the source file (likely index.js), and re-run
|
|
./scripts/generate-readmes in the turf project. -->
|
|
|
|
---
|
|
|
|
This module is part of the [Turfjs project](http://turfjs.org/), an open source
|
|
module collection dedicated to geographic algorithms. It is maintained in the
|
|
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
|
|
PRs and issues.
|
|
|
|
### Installation
|
|
|
|
Install this module individually:
|
|
|
|
```sh
|
|
$ npm install @turf/boolean-overlap
|
|
```
|
|
|
|
Or install the Turf module that includes it as a function:
|
|
|
|
```sh
|
|
$ npm install @turf/turf
|
|
```
|
|
|
|
|
|
### Diagrams
|
|
|
|
 |