distance函数

描述

distance函数是Turf.js中的测量函数之一，用于计算两个给定点之间的距离。返回的距离的单位由用户指定。

语法

distance(fromCoords, toCoords, options)

参数

• fromCoords，类型为Array，两个数值元素，表示起点的经纬度坐标。
• toCoords，类型为Array，两个数值元素，表示终点的经纬度坐标。
• 可选项options：
  • units，类型为String，用于指定返回距离的单位。默认单位为千米。可选值有 "kilometers"、"miles"、"degrees"、"radians"、"inches"、"yards"、"metres"。其中 "degrees" 和 "radians" 返回球面距离，而其他单位返回平面距离。

返回

• 返回两个给定点之间的距离，返回值的单位由用户提供的单位决定。

示例

var fromCoords = [-75.343, 39.984];
var toCoords = [-75.534, 39.123];
var options = {units: 'miles'};

var distanceInMiles = turf.distance(fromCoords, toCoords, options);

console.log('The distance between the two coordinates is:', distanceInMiles, 'miles');

备注

• 如果输入的点坐标不合法，会抛出错误。
• 球面距离的计算使用haversine公式，需要注意此公式可能存在微小的偏差。