shortestPath

描述

¥Description

返回从 start 到 end 的最短 path，且不与任何 特性 或障碍物 FeatureCollection<多边形> 发生碰撞。

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

参数

¥Parameters

名称	类型	描述
start	坐标系	point
end	坐标系	point
options?	对象	可选参数（默认值：）
options.obstacles?	多边形 | 特性<多边形> | FeatureCollection<多边形>	路径无法通行的区域
options.units?	单位	表示分辨率和最小距离的单位；支持所有有效的 Turf 单位。(默认 'kilometers')
options.resolution?	number	用于计算路径的矩阵点之间的距离（默认 100）

返回

¥Returns

特性<LineString> 起点和终点之间的最短路径

¥Feature<LineString> shortest path between start and end

示例

¥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);

安装

¥Installation

$ npm install @turf/shortest-path

import { shortestPath } from "@turf/shortest-path";
const result = shortestPath(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.shortestPath(...);