# turf-difference

> [Turf](http://turfjs.org/) difference module

Latest version **3.0.12** (published 2016-07-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install turf-difference
pnpm add turf-difference
yarn add turf-difference
bun add turf-difference
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.12 |
| Published | 2016-07-05 |
| First published | 2015-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | morganherlocker |
| Maintainers | morganherlocker, tmcw |
| Keywords | turf, gis |

## Links

- npm: https://www.npmjs.com/package/turf-difference
- Repository: https://github.com/Turfjs/turf-difference
- Issues: https://github.com/Turfjs/turf-difference/issues
- npm.io page: https://npm.io/package/turf-difference

## Dependencies (2)

- [jsts](https://npm.io/package/jsts.md) 1.1.2
- [turf-helpers](https://npm.io/package/turf-helpers.md) ^3.0.12

## Recent versions

- 3.0.12 (latest) — 2016-07-05
- 3.0.7-canary.ae89c8b3 (canary) — 2016-06-14
- 3.0.10 — 2016-06-15
- 3.0.5 — 2016-05-17
- 3.0.1 — 2016-05-16
- 3.0.0-canary.7879bf6c — 2016-05-16
- 3.0.0-canary.2f5f7167 — 2016-05-16
- 2.0.0 — 2015-05-04

## README

# turf-difference

# difference

Finds the difference between two [polygons](Polygon) by clipping the second
polygon from the first.

**Parameters**

-   `poly1` **Feature<Polygon>** input Polygon feaure
-   `poly2` **Feature<Polygon>** Polygon feature to difference from `poly1`

**Examples**

```javascript
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 differenced = turf.difference(poly1, poly2);
differenced.properties.fill = '#f00';

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

//=polygons

//=differenced
```

Returns **Feature<Polygon>** a Polygon feature showing the area of `poly1` excluding the area of `poly2`

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.

### Installation

Install this module individually:

```sh
$ npm install turf-difference
```

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

```sh
$ npm install turf
```

---
_Source: https://npm.io/package/turf-difference · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._