47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# @turf/square
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## square
|
|
|
|
Takes a bounding box and calculates the minimum square bounding box that
|
|
would contain the input.
|
|
|
|
### Parameters
|
|
|
|
* `bbox` **[BBox][1]** extent in \[west, south, east, north] order
|
|
|
|
### Examples
|
|
|
|
```javascript
|
|
const bbox = [-20, -20, -15, 0];
|
|
const squared = turf.square(bbox);
|
|
|
|
//addToMap
|
|
const addToMap = [turf.bboxPolygon(bbox), turf.bboxPolygon(squared)]
|
|
```
|
|
|
|
Returns **[BBox][1]** a square surrounding `bbox`
|
|
|
|
[1]: https://tools.ietf.org/html/rfc7946#section-5
|
|
|
|
<!-- 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/square
|
|
```
|
|
|
|
Or install the all-encompassing @turf/turf module that includes all modules as functions:
|
|
|
|
```sh
|
|
$ npm install @turf/turf
|
|
```
|