lineSliceAlong

Description

Takes a line, a specified distance along the line to a start Point, 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.

Parameters

Name	Type	Description
line	Feature<LineString> | LineString	input line
startDist	number	distance along the line to starting point
stopDist	number	distance along the line to ending point
options?	Object	Optional parameters (default {})
options.units?	string	can be degrees, radians, miles, or kilometers (default 'kilometers')

Returns

Feature<LineString> sliced line

Examples

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" });

Installation

$ npm install @turf/line-slice-along

import { lineSliceAlong } from "@turf/line-slice-along";
const result = lineSliceAlong(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.lineSliceAlong(...);