Skip to main content
Version: Next

pointToLineDistance

Description

Returns the minimum distance between a Point and a LineString, being the distance from a line the minimum distance between the point and any segment of the LineString.

Parameters

NameTypeDescription
ptFeature<Point> | Array<number>Feature or Geometry
lineFeature<LineString>GeoJSON Feature or Geometry
options?ObjectOptional parameters (default {})
options.units?stringcan be anything supported by turf/convertLength (ex: degrees, radians, miles, or kilometers) (default "kilometers")
options.method?stringwether to calculate the distance based on geodesic (spheroid) or planar (flat) method. Valid options are 'geodesic' or 'planar'. (default "geodesic")

Returns

    number distance between point and line

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