booleanPointOnLine

描述

¥Description

如果点位于直线上，则返回 true。接受可选参数以忽略线串的起始和终止顶点。

¥Returns true if a point is on a line. Accepts a optional parameter to ignore the start and end vertices of the linestring.

参数

¥Parameters

名称	类型	描述
pt	坐标系	GeoJSON 点
line	特性<LineString>	GeoJSON 线串
options?	对象	可选参数（默认 {}）
options.ignoreEndVertices?	boolean	是否忽略起点和终点。(默认 false)
options.epsilon?	number	用于与叉积结果进行比较的分数。用于处理浮点数，例如经纬度点

返回

¥Returns

boolean 真/假

¥boolean true/false

示例

¥Examples

var pt = turf.point([0, 0]);
var line = turf.lineString([
  [-1, -1],
  [1, 1],
  [1.5, 2.2],
]);
var isPointOnLine = turf.booleanPointOnLine(pt, line);
//=true

安装

¥Installation

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

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

$ npm install @turf/turf

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