turf line-offset module
npm install @spatial/line-offsetTakes a [line][1] and returns a [line][1] at offset by the specified distance.
- geojson ([Geometry][2] \| [Feature][3]<([LineString][4] \| [MultiLineString][5])>) input GeoJSON
- distance [number][6] distance to offset the line (can be of negative value)
- options [Object][7] Optional parameters (optional, default {})
- options.units [string][8] can be degrees, radians, miles, kilometers, inches, yards, meters (optional, default 'kilometers')
``javascript
var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]], { "stroke": "#F00" });
var offsetLine = turf.lineOffset(line, 2, {units: 'miles'});
//addToMap
var addToMap = [offsetLine, line]
offsetLine.properties.stroke = "#00F"
`
Returns [Feature][3]<([LineString][4] \| [MultiLineString][5])> Line offset from the input line
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.4
[2]: https://tools.ietf.org/html/rfc7946#section-3.1
[3]: https://tools.ietf.org/html/rfc7946#section-3.2
[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4
[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
---
This module is part of the Turfjs project, an open source
module collection dedicated to geographic algorithms. It is maintained in the
Turfjs/turf repository, where you can create
PRs and issues.
Install this module individually:
`sh`
$ npm install @spatial/line-offset
Or install the Turf module that includes it as a function:
`sh``
$ npm install @turf/turf