@turf/intersect

intersect

Takes [polygon][1] or [multi-polygon][2] geometries and
finds their polygonal intersection. If they don't intersect, returns null.

$3

* features [FeatureCollection][3]<([Polygon][1] | [MultiPolygon][2])> the features to intersect
* options [Object][4] Optional Parameters (optional, default {})

* options.properties [Object][4] Translate GeoJSON Properties to Feature (optional, default {})

$3

``javascript
var poly1 = turf.polygon([[
[-122.801742, 45.48565],
[-122.801742, 45.60491],
[-122.584762, 45.60491],
[-122.584762, 45.48565],
[-122.801742, 45.48565]
]]);

var poly2 = turf.polygon([[
[-122.520217, 45.535693],
[-122.64038, 45.553967],
[-122.720031, 45.526554],
[-122.669906, 45.507309],
[-122.723464, 45.446643],
[-122.532577, 45.408574],
[-122.487258, 45.477466],
[-122.520217, 45.535693]
]]);

var intersection = turf.intersect(turf.featureCollection([poly1, poly2]));

//addToMap
var addToMap = [poly1, poly2, intersection];
`

Returns ([Feature][5] | null) returns a feature representing the area they share (either a [Polygon][1] or
[MultiPolygon][2]). If they do not share any area, returns null.

[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6

[2]: https://tools.ietf.org/html/rfc7946#section-3.1.7

[3]: https://tools.ietf.org/html/rfc7946#section-3.3

[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[5]: https://tools.ietf.org/html/rfc7946#section-3.2

---

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.

$3

Install this single module individually:

`sh
$ npm install @turf/intersect
`

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

`sh
$ npm install @turf/turf
``