@spatial/line-slice
v1.0.5
Published
turf line-slice module
Downloads
4
Readme
@spatial/line-slice
lineSlice
Takes a line, a start Point, and a stop point and returns a subsection of the line in-between those points. The start & stop points don't need to fall exactly on the line.
This can be useful for extracting only the part of a route between waypoints.
Parameters
startPt
Coord starting pointstopPt
Coord stopping pointline
(Feature<LineString> | LineString) line to slice
Examples
var line = turf.lineString([
[-77.031669, 38.878605],
[-77.029609, 38.881946],
[-77.020339, 38.884084],
[-77.025661, 38.885821],
[-77.021884, 38.889563],
[-77.019824, 38.892368]
]);
var start = turf.point([-77.029609, 38.881946]);
var stop = turf.point([-77.021884, 38.889563]);
var sliced = turf.lineSlice(start, stop, line);
//addToMap
var addToMap = [start, stop, line]
Returns Feature<LineString> sliced line
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.
Installation
Install this module individually:
$ npm install @spatial/line-slice
Or install the Turf module that includes it as a function:
$ npm install @turf/turf