Novice, Practiced, Mastered

    @turf/shortest-path
    TypeScript icon, indicating that this package has built-in type declarations

    6.5.0 • Public • Published

    @turf/shortest-path

    shortestPath

    Returns the shortest path from start to end without colliding with any Feature in obstacles

    Parameters

    • start Coord point
    • end Coord point
    • options Object optional parameters (optional, default {})
      • options.obstacles (Geometry | Feature | FeatureCollection<Polygon>)? areas which path cannot travel
      • options.minDistance number? minimum distance between shortest path and obstacles
      • options.units string unit in which resolution & minimum distance will be expressed in; it can be degrees, radians, miles, kilometers, ... (optional, default 'kilometers')
      • options.resolution number distance between matrix points on which the path will be calculated (optional, default 100)

    Examples

    var start = [-5, -6];
    var end = [9, -6];
    var options = {
      obstacles: turf.polygon([[[0, -7], [5, -7], [5, -3], [0, -3], [0, -7]]])
    };
    
    var path = turf.shortestPath(start, end, options);
    
    //addToMap
    var addToMap = [start, end, options.obstacles, path];

    Returns Feature<LineString> shortest path between start and end


    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/shortest-path

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

    $ npm install @turf/turf

    Install

    npm i @turf/shortest-path

    DownloadsWeekly Downloads

    127,924

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    42.5 kB

    Total Files

    7

    Last publish

    Collaborators

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