turf-envelope
Advanced tools
Comparing version 3.0.10 to 3.0.12
{ | ||
"name": "turf-envelope", | ||
"version": "3.0.10", | ||
"version": "3.0.12", | ||
"description": "turf envelope module", | ||
@@ -31,5 +31,5 @@ "main": "index.js", | ||
"dependencies": { | ||
"turf-bbox-polygon": "^3.0.10", | ||
"turf-bbox": "^3.0.10" | ||
"turf-bbox-polygon": "^3.0.12", | ||
"turf-bbox": "^3.0.12" | ||
} | ||
} |
# turf-envelope | ||
[![build status](https://secure.travis-ci.org/Turfjs/turf-envelope.png)](http://travis-ci.org/Turfjs/turf-envelope) | ||
# envelope | ||
turf envelope module | ||
Takes any number of features and returns a rectangular [Polygon](Polygon) that encompasses all vertices. | ||
**Parameters** | ||
### `turf.envelope(fc)` | ||
- `fc` **FeatureCollection** input features | ||
Takes any number of features and returns a rectangular Polygon that encompasses all vertices. | ||
**Examples** | ||
### Parameters | ||
| parameter | type | description | | ||
| --------- | ----------------- | -------------- | | ||
| `fc` | FeatureCollection | input features | | ||
### Example | ||
```js | ||
```javascript | ||
var fc = { | ||
@@ -68,9 +59,15 @@ "type": "FeatureCollection", | ||
Returns **Feature<Polygon>** a rectangular Polygon feature that encompasses all vertices | ||
**Returns** `Feature.<Polygon>`, a rectangular Polygon feature that encompasses all vertices | ||
--- | ||
## Installation | ||
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. | ||
Requires [nodejs](http://nodejs.org/). | ||
### Installation | ||
Install this module individually: | ||
```sh | ||
@@ -80,8 +77,6 @@ $ npm install turf-envelope | ||
## Tests | ||
Or install the Turf module that includes it as a function: | ||
```sh | ||
$ npm test | ||
$ npm install turf | ||
``` | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
5629
81
Updatedturf-bbox@^3.0.12
Updatedturf-bbox-polygon@^3.0.12