@turf/union v7.2.0

@turf/union

union

Takes two (Multi)Polygon(s) and returns a combined polygon. If the input polygons are not contiguous, this function returns a MultiPolygon feature.

Parameters

• polygon1 Feature<(Polygon | MultiPolygon)> input Polygon feature
• polygon2 Feature<(Polygon | MultiPolygon)> Polygon feature to difference from polygon1
• options Object Optional Parameters (optional, default {})
  • options.properties Object Translate Properties to output Feature (optional, default {})

Examples

var poly1 = turf.polygon([[
    [-82.574787, 35.594087],
    [-82.574787, 35.615581],
    [-82.545261, 35.615581],
    [-82.545261, 35.594087],
    [-82.574787, 35.594087]
]], {"fill": "#0f0"});
var poly2 = turf.polygon([[
    [-82.560024, 35.585153],
    [-82.560024, 35.602602],
    [-82.52964, 35.602602],
    [-82.52964, 35.585153],
    [-82.560024, 35.585153]
]], {"fill": "#00f"});

var union = turf.union(poly1, poly2);

//addToMap
var addToMap = [poly1, poly2, union];

Returns Feature<(Polygon | MultiPolygon)> a combined Polygon or MultiPolygon feature

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 module individually:

$ npm install @turf/union

Or install the Turf module that includes it as a function:

$ npm install @turf/turf