55 lines
1.6 KiB
Markdown
55 lines
1.6 KiB
Markdown
# @turf/envelope
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## envelope
|
|
|
|
Takes any number of features and returns a rectangular [Polygon][1] that encompasses all vertices.
|
|
|
|
### Parameters
|
|
|
|
* `geojson` **[GeoJSON][2]** input features
|
|
|
|
### Examples
|
|
|
|
```javascript
|
|
var features = turf.featureCollection([
|
|
turf.point([-75.343, 39.984], {"name": "Location A"}),
|
|
turf.point([-75.833, 39.284], {"name": "Location B"}),
|
|
turf.point([-75.534, 39.123], {"name": "Location C"})
|
|
]);
|
|
|
|
var enveloped = turf.envelope(features);
|
|
|
|
//addToMap
|
|
var addToMap = [features, enveloped];
|
|
```
|
|
|
|
Returns **[Feature][3]<[Polygon][1]>** a rectangular Polygon feature that encompasses all vertices
|
|
|
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
|
|
|
|
[2]: https://tools.ietf.org/html/rfc7946#section-3
|
|
|
|
[3]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
|
|
<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
|
|
|
|
---
|
|
|
|
This module is part of the [Turfjs project](https://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 single module individually:
|
|
|
|
```sh
|
|
$ npm install @turf/envelope
|
|
```
|
|
|
|
Or install the all-encompassing @turf/turf module that includes all modules as functions:
|
|
|
|
```sh
|
|
$ npm install @turf/turf
|
|
```
|