@turf/difference
Advanced tools
@turf/difference is a module in the Turf.js library that allows you to compute the geometric difference between two polygons. This is useful in geospatial analysis for determining the area that is unique to one polygon when compared to another.
Compute Difference Between Two Polygons
This feature allows you to compute the difference between two polygons. The resulting polygon represents the area that is unique to the first polygon when compared to the second polygon.
const turf = require('@turf/turf');
const polygon1 = turf.polygon([[
[-82.574787, 35.594087],
[-82.574787, 35.615581],
[-82.545261, 35.615581],
[-82.545261, 35.594087],
[-82.574787, 35.594087]
]]);
const polygon2 = turf.polygon([[
[-82.560024, 35.585153],
[-82.560024, 35.602602],
[-82.52964, 35.602602],
[-82.52964, 35.585153],
[-82.560024, 35.585153]
]]);
const difference = turf.difference(polygon1, polygon2);
console.log(difference);JSTS is a JavaScript library of spatial predicates and functions for processing geometry. It is a port of the Java Topology Suite (JTS). JSTS provides a more comprehensive set of geometric operations compared to @turf/difference, including union, intersection, and buffer operations.
Martinez Polygon Clipping is a library for performing boolean operations on polygons, such as union, intersection, and difference. It is known for its performance and accuracy, making it a good alternative to @turf/difference for complex polygon operations.
Finds the difference between two polygons by clipping the second polygon from the first.
Parameters
polygon1 Feature<(Polygon | MultiPolygon)> input Polygon featurepolygon2 Feature<(Polygon | MultiPolygon)> Polygon feature to difference from polygon1Examples
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(polygon1, polygon2);
//addToMap
var addToMap = [polygon1, polygon2, difference];
Returns (Feature<(Polygon | MultiPolygon)> | undefined) a Polygon or MultiPolygon feature showing the area of polygon1 excluding the area of polygon2 (if empty returns undefined)
Detect Empty Polygon
Parameters
geom Geometry<(Polygon | MultiPolygon)> Geometry ObjectReturns (Geometry<(Polygon | MultiPolygon)> | undefined) removed any polygons with no areas
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.
Install this module individually:
$ npm install @turf/difference
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
4.7.0
@turf/projection][projection](PR https://github.com/Turfjs/turf/pull/927 - Author @stebogit)
@turf/point-to-line-distance][point-to-line-distance]Returns the minimum distance between a {@link Point} and a {@link LineString}, being the distance from a line the minimum distance between the point and any segment of the LineString.
(PR https://github.com/Turfjs/turf/pull/925 - Author @stebogit)
@turf/boolean-within][boolean-within]Boolean-within returns true if the first geometry is completely within the second geometry. The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a) must not intersect the exterior of the secondary (geometry b). Boolean-within returns the exact opposite result of the [@turf/boolean-contains][boolean-contains].
(PR https://github.com/Turfjs/turf/pull/924 - Author @rowanwins)
@turf/unkink-polygon][unkink-polygon] testing & added flattenEach instead of using flatten.
(PR https://github.com/Turfjs/turf/pull/889)@turf/concave][concave] refactoring, replacing [@turf/union][union] with geojson-dissolve to increase speed and added support to null geometries
(PR https://github.com/Turfjs/turf/pull/907 - Contributor @stebogit @DenisCarriere)@turf/polygonize][polygonize] about "Edges must be correctly noded"
(PR https://github.com/Turfjs/turf/pull/898 - Contributor @stebogit @NickCis)@turf/clone][clone]
(PR https://github.com/Turfjs/turf/pull/904 - Contributor @DenisCarriere)GeoJSON to [@turf/simplify][simplify]
(PR https://github.com/Turfjs/turf/pull/903 - Contributor @DenisCarriere @stebogit)isNumber function and improves type checking for few [@turf/helpers][helpers] methods
(PR https://github.com/Turfjs/turf/pull/920 - Contributor @DenisCarriere @stebogit)MultiPolygons for [@turf/simplify][simplify]
(PR https://github.com/Turfjs/turf/pull/922 - Contributor @DenisCarriere)@turf/bbox-clip point intersection handling, adding sanity-checks the lineclip output
(PR https://github.com/Turfjs/turf/pull/886)@turf/line-split][line-split] endpoint case handling applying [@turf/truncate][truncate] on splitter
(PR https://github.com/Turfjs/turf/pull/892 and https://github.com/Turfjs/turf/pull/855 - Contributor @stebogit)@turf/intersect][intersect] throwing "uncaught exception", adding [@turf/truncate][truncate] to inputs and returning Feature<null> if no geometry
(PR https://github.com/Turfjs/turf/pull/890 - Contributor @stebogit @vicvolk)@turf/hex-grid][hex-grid] not properly cloning the last ring vertex
(PR https://github.com/Turfjs/turf/pull/897 - Contributor @stebogit @DenisCarriere)@turf/boolean-disjoint][boolean-disjoint] incorrect behaviour where a poly was completely contained within another poly
(PR https://github.com/Turfjs/turf/pull/908 - Contributor @rowanwins)@turf/simplify][simplify] process pending on particular geometries, applying [@turf/clean-coords][clean-coords] to input.
(PR https://github.com/Turfjs/turf/pull/903 - Contributor @stebogit @DenisCarriere)boolean properties not being translated with [@turf/clone][clone]
(PR https://github.com/Turfjs/turf/pull/909 - Contributor @DenisCarriere)@turf/boolean-contains][boolean-contains] incorrect output when checking two polygons
(PR https://github.com/Turfjs/turf/pull/923 - Contributor @rowanwins @DenisCarriere)FAQs
turf difference module
The npm package @turf/difference receives a total of 649,290 weekly downloads. As such, @turf/difference popularity was classified as popular.
We found that @turf/difference demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.