@turf/intersect

@turf/intersect

intersect

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

Parameters

• features FeatureCollection<(Polygon | MultiPolygon)> the features to intersect

• options Object Optional Parameters (optional, default {})

  • options.properties Object Translate GeoJSON Properties to Feature (optional, default {})

Examples

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 | null) returns a feature representing the area they share (either a Polygon or MultiPolygon). If they do not share any area, returns null.

---

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/intersect

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

$ npm install @turf/turf