nearestPointOnLine

描述

¥Description

返回直线上距离给定点最近的点。

¥Returns the nearest point on a line to a given point.

参数

¥Parameters

名称	类型	描述
lines	几何图形 | 特性<LineString | MultiLineString>	要捕捉到的线
pt	几何图形 | 特性<点> | 数组<number>	要捕捉的点
options?	对象	可选参数（默认 {}）
options.units?	string	可以是度、弧度、英里或千米（默认 'kilometers'）

返回

¥Returns

特性<点> line 到 point 之间的最近点。属性对象将包含四个值：index：在第 n 行部分 multiFeatureIndex 处找到最近点：在第 n 行部分 MultiLineString 处找到最近点：点与最近点之间的距离，location：起点与最近点之间的直线距离。

¥Feature<Point> closest point on the line to point. The properties object will contain four values: index: closest point was found on nth line part, multiFeatureIndex: closest point was found on the nth line of the MultiLineString, dist: distance between pt and the closest point, location: distance along the line between start and the closest point.

示例

¥Examples

var line = turf.lineString([
  [-77.031669, 38.878605],
  [-77.029609, 38.881946],
  [-77.020339, 38.884084],
  [-77.025661, 38.885821],
  [-77.021884, 38.889563],
  [-77.019824, 38.892368],
]);
var pt = turf.point([-77.037076, 38.884017]);

var snapped = turf.nearestPointOnLine(line, pt, { units: "miles" });

安装

¥Installation

$ npm install @turf/nearest-point-on-line

import { nearestPointOnLine } from "@turf/nearest-point-on-line";
const result = nearestPointOnLine(...);

$ npm install @turf/turf

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