@turf/line-slice-along

What is @turf/line-slice-along?

@turf/line-slice-along is a module from the Turf.js library that allows you to slice a line segment from a given GeoJSON LineString based on start and stop distances along the line. This is useful for various geospatial operations where you need to extract a specific segment of a line based on distance measurements.

What are @turf/line-slice-along's main functionalities?

Slice a LineString

This feature allows you to slice a segment from a LineString based on start and stop distances. The code sample demonstrates how to use the `lineSliceAlong` function to extract a segment from a given LineString.

const turf = require('@turf/turf');

const 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]
]);

const start = 0.5; // start distance in kilometers
const stop = 2.5; // stop distance in kilometers

const slicedLine = turf.lineSliceAlong(line, start, stop);
console.log(JSON.stringify(slicedLine));

Other packages similar to @turf/line-slice-along

polyline

The 'polyline' package is used for encoding and decoding Google Maps Polylines. While it does not provide slicing functionality directly, it can be used in conjunction with other geospatial libraries to achieve similar results. It focuses more on the encoding and decoding of polyline data rather than slicing based on distances.

turf-line-distance

The 'turf-line-distance' package is another module from the Turf.js library that calculates the distance along a LineString. While it does not slice the line, it can be used to measure distances which can then be used to determine slicing points when combined with other Turf.js functions.

geolib

The 'geolib' package provides a variety of geospatial functions, including distance calculations and point transformations. It can be used to achieve similar slicing functionality by calculating distances and extracting segments, although it may require more manual implementation compared to the direct slicing provided by @turf/line-slice-along.

README

@turf/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 single module individually:

$ npm install @turf/line-slice-along

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

$ npm install @turf/turf