@turf/shortest-path

shortestPath

Returns the shortest path from start to end without colliding with any Feature in obstacles FeatureCollection<Polygon>

Parameters

• start Coord point

• end Coord point

• options Object optional parameters (optional, default {})

  • options.obstacles (Polygon | Feature<Polygon> | FeatureCollection<Polygon>)? areas which path cannot travel
  • options.units Units unit in which resolution & minimum distance will be expressed in; Supports all valid Turf Units. (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]]]).geometry
};

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

$ npm install @turf/shortest-path

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

$ npm install @turf/turf