turf-erase

erase features

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
turf-erase
211.3.27 years ago8 years agoMinified + gzip package size for turf-erase in KB

Readme

turf-erase
build status
erase features

turf.erase(poly1, poly2)

Finds the difference between two Polygon|polygons by clipping the second polygon from the first.

Parameters

| parameter | type | description | | --------- | -------------------- | ------------------------------------- | | poly1 | Feature\.\ | input Polygon feaure | | poly2 | Feature\.\ | Polygon feature to erase from poly1 |

Example

var poly1 = {
  "type": "Feature",
  "properties": {
    "fill": "#0f0"
  },
  "geometry": {
    "type": "Polygon",
    "coordinates": [[
      [-46.738586, -23.596711],
      [-46.738586, -23.458207],
      [-46.560058, -23.458207],
      [-46.560058, -23.596711],
      [-46.738586, -23.596711]
    ]]
  }
};
var poly2 = {
  "type": "Feature",
  "properties": {
    "fill": "#00f"
  },
  "geometry": {
    "type": "Polygon",
    "coordinates": [[
      [-46.650009, -23.631314],
      [-46.650009, -23.5237],
      [-46.509246, -23.5237],
      [-46.509246, -23.631314],
      [-46.650009, -23.631314]
    ]]
  }
};

var erased = turf.erase(poly1, poly2);
erased.properties.fill = '#f00';

var polygons = {
  "type": "FeatureCollection",
  "features": [poly1, poly2]
};

//=polygons

//=erased

Returns Feature.<Polygon>, a Polygon feature showing the area of poly1 excluding the area of poly2

Installation

Requires nodejs.
$ npm install turf-erase

Tests

$ npm test