intersect

Description

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

Parameters

Name	Type	Description
poly1	Feature<Polygon | MultiPolygon>	the first polygon or multipolygon
poly2	Feature<Polygon | MultiPolygon>	the second polygon or multipolygon
options?	Object	Optional Parameters (default {})
options.properties?	Object	Translate GeoJSON Properties to Feature (default {})

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.

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(poly1, poly2);

Installation

$ npm install @turf/intersect

import { intersect } from "@turf/intersect";
const result = intersect(...);

$ npm install @turf/turf

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