Skip to main content
Version: Next

difference

Description

Finds the difference between multiple polygons by clipping the subsequent polygon from the first.

Parameters

NameTypeDescription
featuresFeatureCollection<Polygon | MultiPolygon>input Polygon features

Returns

    Feature<Polygon | MultiPolygon> | null a Polygon or MultiPolygon feature showing the area of polygon1 excluding the area of polygon2 (if empty returns null)

Examples

var polygon1 = turf.polygon(
[
[
[128, -26],
[141, -26],
[141, -21],
[128, -21],
[128, -26],
],
],
{
fill: "#F00",
"fill-opacity": 0.1,
},
);
var polygon2 = turf.polygon(
[
[
[126, -28],
[140, -28],
[140, -20],
[126, -20],
[126, -28],
],
],
{
fill: "#00F",
"fill-opacity": 0.1,
},
);

var difference = turf.difference(turf.featureCollection([polygon1, polygon2]));

Installation

$ npm install @turf/difference

import { difference } from "@turf/difference";
const result = difference(...);
$ npm install @turf/turf

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