booleanPointOnLine

描述

¥Description

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	whether to ignore the start and end vertices.(默认 false)
options.epsilon?	number	Fractional number to compare with the cross product result.Useful for dealing with floating points such as lng/lat points

返回

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