@turf/point-to-line-distance

pointToLineDistance

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

Parameters

• pt (Feature<Point> | Array<number>) Feature or Geometry

• line Feature<LineString> GeoJSON Feature or Geometry

• options Object Optional parameters (optional, default {})

  • options.units Units Supports all valid Turf Units (optional, default "kilometers")
  • options.method string whether to calculate the distance based on geodesic (spheroid) or planar (flat) method. Valid options are 'geodesic' or 'planar'. (optional, default "geodesic")

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

Returns number distance between point and line

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this single module individually:

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

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf