61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
# @turf/polygon-to-line
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## polygonToLine
|
|
|
|
Converts a [Polygon][1] to [(Multi)LineString][2] or [MultiPolygon][3] to a
|
|
[FeatureCollection][4] of [(Multi)LineString][2].
|
|
|
|
### Parameters
|
|
|
|
* `poly` **[Feature][5]<([Polygon][1] | [MultiPolygon][3])>** Feature to convert
|
|
* `options` **[Object][6]** Optional parameters (optional, default `{}`)
|
|
|
|
* `options.properties` **[Object][6]** translates GeoJSON properties to Feature (optional, default `{}`)
|
|
|
|
### Examples
|
|
|
|
```javascript
|
|
var poly = turf.polygon([[[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]]);
|
|
|
|
var line = turf.polygonToLine(poly);
|
|
|
|
//addToMap
|
|
var addToMap = [line];
|
|
```
|
|
|
|
Returns **([FeatureCollection][4] | [Feature][5]<([LineString][2] | MultiLinestring)>)** converted (Multi)Polygon to (Multi)LineString
|
|
|
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
|
|
|
|
[2]: https://tools.ietf.org/html/rfc7946#section-3.1.4
|
|
|
|
[3]: https://tools.ietf.org/html/rfc7946#section-3.1.7
|
|
|
|
[4]: https://tools.ietf.org/html/rfc7946#section-3.3
|
|
|
|
[5]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
|
|
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
|
|
<!-- 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/polygon-to-line
|
|
```
|
|
|
|
Or install the all-encompassing @turf/turf module that includes all modules as functions:
|
|
|
|
```sh
|
|
$ npm install @turf/turf
|
|
```
|