@turf/line-slice-along
    TypeScript icon, indicating that this package has built-in type declarations

    6.5.0 • Public • Published

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

    $ npm install @turf/line-slice-along

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

    $ npm install @turf/turf

    Install

    npm i @turf/line-slice-along

    DownloadsWeekly Downloads

    137,291

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    11.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • rowanwins
    • tmcw
    • morganherlocker
    • tcql
    • deniscarriere
    • mdfedderly