pointToLineDistance

描述

¥Description

Calculates the distance between a given point and the nearest point on a line.Sometimes referred to as the cross track distance.

参数

¥Parameters

名称	类型	描述
pt	特性<点> | 数组<number>	要素或几何图形
line	特性<LineString>	GeoJSON 要素或几何体
options?	对象	可选参数（默认 ）
options.units?	string	can be anything supported by turf/convertLength (ex: degrees, radians, miles, or kilometers) (default "kilometers")
options.method?	string	whether to calculate the distance based on geodesic (spheroid) or planar (flat) method.Valid options are 'geodesic' or 'planar'.(默认 "geodesic")

返回

¥Returns

number distance between point and line

示例

¥Examples

var pt = turf.point([0, 0]);
var line = turf.lineString([
  [1, 1],
  [-1, 1],
]);

var distance = turf.pointToLineDistance(pt, line, { units: "miles" });
//=69.11854715938406

安装

¥Installation

$ npm install @turf/point-to-line-distance

import { pointToLineDistance } from "@turf/point-to-line-distance";
const result = pointToLineDistance(...);

$ npm install @turf/turf

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