67 lines
1.9 KiB
Markdown
67 lines
1.9 KiB
Markdown
# @turf/bbox-polygon
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## bboxPolygon
|
|
|
|
Takes a bbox and returns an equivalent [polygon][1].
|
|
|
|
**Parameters**
|
|
|
|
- `bbox` **[BBox][2]** extent in [minX, minY, maxX, maxY] order
|
|
- `options` **[Object][3]** Optional parameters (optional, default `{}`)
|
|
- `options.properties` **Properties** Translate properties to Polygon (optional, default `{}`)
|
|
- `options.id` **([string][4] \| [number][5])** Translate Id to Polygon (optional, default `{}`)
|
|
|
|
**Examples**
|
|
|
|
```javascript
|
|
var bbox = [0, 0, 10, 10];
|
|
|
|
var poly = turf.bboxPolygon(bbox);
|
|
|
|
//addToMap
|
|
var addToMap = [poly]
|
|
```
|
|
|
|
Returns **[Feature][6]<[Polygon][7]>** a Polygon representation of the bounding box
|
|
|
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
|
|
|
|
[2]: https://tools.ietf.org/html/rfc7946#section-5
|
|
|
|
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
|
|
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
|
|
|
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
|
|
|
|
[6]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
|
|
[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6
|
|
|
|
<!-- This file is automatically generated. Please don't edit it directly:
|
|
if you find an error, edit the source file (likely index.js), and re-run
|
|
./scripts/generate-readmes in the turf project. -->
|
|
|
|
---
|
|
|
|
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/bbox-polygon
|
|
```
|
|
|
|
Or install the Turf module that includes it as a function:
|
|
|
|
```sh
|
|
$ npm install @turf/turf
|
|
```
|