Package Exports

turf-erase

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (turf-erase) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

turf-erase

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.<Polygon>	input Polygon feaure
`poly2`	Feature.<Polygon>	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