@spatial/line-slice-along

turf line-slice-along module

Usage no npm install needed!

<script type="module">
  import spatialLineSliceAlong from 'https://cdn.skypack.dev/@spatial/line-slice-along';
</script>

README

@spatial/line-slice-along

lineSliceAlong

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

  • 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 (optional, default {})
    • options.units string can be degrees, radians, miles, or kilometers (optional, default 'kilometers')

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

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

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-along

Or install the Turf module that includes it as a function:

$ npm install @turf/turf