pointToLineDistance

Description

Calculates the distance between a given point and the nearest point on a line. Sometimes referred to as the cross track distance.

Parameters

Name	Type	Description
pt	Feature<Point> | Array<number>	Feature or Geometry
line	Feature<LineString>	GeoJSON Feature or Geometry
options?	Object	Optional parameters (default {})
options.units?	string	can be anything supported by turf/convertLength (ex: degrees, radians, miles, or kilometers) (default "kilometers")
options.method?	string	whether 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(...);