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	Feature<Point> | Array<number>	特性或几何
line	Feature<LineString>	GeoJSON 特性或几何
options?	Object	可选参数 (默认 {})
options.units?	Units	支持所有有效的 Turf 单位 (默认 "公里")
options.method?	string	是否根据大地测量（椭球体）或平面（平面）方法计算距离。有效选项为 'geodesic' 或 'planar'。(默认 "geodesic")

返回

🌐 Returns

number 点到直线的距离

示例

🌐 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(...);