Skip to main content
Version: Next

pointToPolygonDistance

描述

¥Description

Calculates the distance from a point to the edges of a polygon or multi-polygon.Returns negative values for points inside the polygon.Handles polygons with holes and multi-polygons.A hole is treated as the exterior of the polygon.

参数

¥Parameters

名称类型描述
point特性<> | | Position输入点
polygonOrMultiPolygon特性<多边形 | MultiPolygon> | 多边形 | MultiPolygon输入多边形或多多边形
options对象可选参数(默认
options.units单位Units of the result e.g. "kilometers", "miles", "meters"
options.method"geodesic" | "planar"结果方法

返回

¥Returns

number Distance in meters (negative values for points inside the polygon)

安装

¥Installation

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

import { pointToPolygonDistance } from "@turf/point-to-polygon-distance";
const result = pointToPolygonDistance(...);
$ npm install @turf/turf

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