@turf/dissolve

turf dissolve module

Usage no npm install needed!

<script type="module">
  import turfDissolve from 'https://cdn.skypack.dev/@turf/dissolve';
</script>

README

@turf/dissolve

dissolve

Dissolves a FeatureCollection of polygon features, filtered by an optional property name:value. Note that mulitpolygon features within the collection are not supported

Parameters

  • featureCollection FeatureCollection<Polygon> input feature collection to be dissolved
  • options Object Optional parameters (optional, default {})
    • options.propertyName string? features with equals 'propertyName' in properties will be merged

Examples

var features = turf.featureCollection([
  turf.polygon(
    [
      [
        [0, 0],
        [0, 1],
        [1, 1],
        [1, 0],
        [0, 0],
      ],
    ],
    { combine: "yes" }
  ),
  turf.polygon(
    [
      [
        [0, -1],
        [0, 0],
        [1, 0],
        [1, -1],
        [0, -1],
      ],
    ],
    { combine: "yes" }
  ),
  turf.polygon(
    [
      [
        [1, -1],
        [1, 0],
        [2, 0],
        [2, -1],
        [1, -1],
      ],
    ],
    { combine: "no" }
  ),
]);

var dissolved = turf.dissolve(features, { propertyName: "combine" });

//addToMap
var addToMap = [features, dissolved];

Returns FeatureCollection<Polygon> a FeatureCollection containing the dissolved polygons


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

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

$ npm install @turf/turf