@turf/line-slice-along
Advanced tools
@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.
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));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.
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.
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.
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 linestartDist number distance along the line to starting pointstopDist number distance along the line to ending pointoptions 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.
Install this module individually:
$ npm install @turf/line-slice-along
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
6.2.0
After a bit of hiatus, TurfJS is resuming releases.
@turf/boolean-touches][boolean-touches]Determines if two features touch but do not intersect
@turf/boolean-valid][boolean-valid]Checks if the geometry is a valid according to the OGC Simple Feature Specification
@turf/quadrat-analysis][quadrat-analysis]Performs a quadrat analysis on a set of points
@turf/rectangle-grid][rectangle-grid]Creates a grid of rectangles from a bounding box
@turf/voroni][voronoi]Typescript types for the options parameter have been fixed (PR https://github.com/Turfjs/turf/pull/1424 - Author @stevage)
@turf/points-within-polygon][points-within-polygon]Typescript types around the Feature's Properties will now be preserved. (PR https://github.com/Turfjs/turf/pull/1761 - Author @rugheid)
@turf/rewind][rewind]Typescript types for the 'reverse' option are now correct. Previously it was misnamed as 'reversed'. (PR https://github.com/Turfjs/turf/pull/1786 - Author @jonnycornwell)
@turf/difference][difference]No longer publishes an .mjs file.
@turf/meta][meta]No longer publishes an .mjs file.
@turf/tag][tag]Add MultiPolygon support. (PR https://github.com/Turfjs/turf/pull/1996 - Author bryceroney)
@turf/centroid Don't visit first point twice when calculating centroid
(PR https://github.com/Turfjs/turf/pull/1894 - Author @rowanwins)
@turf/transform-translate Better handling of negative distances
(PR https://github.com/Turfjs/turf/pull/1895 - Author @rowanwins)
@turf/union, @turf/difference, @turf/intersect Use polygon-clipping library to fix correctness issues
(PR https://github.com/Turfjs/turf/pull/1916 - Authors @mbullington, @ngottlieb)
@turf/buffer Change default number of steps to 8, and actually support the steps option
(PR https://github.com/Turfjs/turf/pull/1931 - Author stevenchanin)
@turf/buffer Fix projection issues that produce undersized buffers at non-equatorial latitudes
(PR https://github.com/Turfjs/turf/pull/1956 - Author dyakovlev)
@turf/helpers Add runtime checks to point() method, fixing an API break
(PR https://github.com/Turfjs/turf/pull/1964)
@turf/boolean-overlap Better performance for MultiPoint geometries
(PR https://github.com/Turfjs/turf/pull/1910 - Author @mfedderly)
@turf/helpers Add hectares to convertArea
(PR https://github.com/Turfjs/turf/pull/1943 - Author @DanielJDufour)
@turf/great-circle Update Typescript types to support MultiLineString input
(PR https://github.com/Turfjs/turf/pull/1928 - Author kronick)
@turf/square-grid Clarify inputs
(PR https://github.com/Turfjs/turf/pull/1885 - Author @raphael-leger)
@turf/greater-circle Clarify properties option example
(PR https://github.com/Turfjs/turf/pull/1888 - Author @chris-catignani)
@turf/line-to-polygon no longer modifies its input unless the mutate option is true
(PR https://github.com/Turfjs/turf/pull/1879 - Author @MortenBirk)
@turf/unkink-polygon remove Number.prototype.modulo override
(PR https://github.com/Turfjs/turf/pull/1978)
FAQs
turf line-slice-along module
We found that @turf/line-slice-along demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.