@turf/line-slice-along

lineSliceAlong

Takes a [line][1], a specified distance along the line to a start [Point][2],
and a specified distance along the line to a stop point
and returns a subsection of the line in-between those points.

This can be useful for extracting only the part of a route between two distances.

$3

* line ([Feature][3]<[LineString][1]> | [LineString][1]) input line
* startDist [number][4] distance along the line to starting point
* stopDist [number][4] distance along the line to ending point
* options [Object][5] Optional parameters (optional, default {})

* options.units Units Supports all valid Turf [Units][6] (optional, default 'kilometers')

$3

``javascript
var line = turf.lineString([[7, 45], [9, 45], [14, 40], [14, 41]]);
var start = 12.5;
var stop = 25;
var sliced = turf.lineSliceAlong(line, start, stop, {units: 'miles'});

//addToMap
var addToMap = [line, start, stop, sliced]
`

Returns [Feature][3]<[LineString][1]> sliced line

[1]: https://tools.ietf.org/html/rfc7946#section-3.1.4

[2]: https://tools.ietf.org/html/rfc7946#section-3.1.2

[3]: https://tools.ietf.org/html/rfc7946#section-3.2

[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[6]: https://turfjs.org/docs/api/types/Units

---

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.

$3

Install this single module individually:

`sh
$ npm install @turf/line-slice-along
`

Or install the all-encompassing @turf/turf module that includes all modules as functions:

`sh
$ npm install @turf/turf
``