Package Exports

@turf/point-to-line-distance

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/point-to-line-distance) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/point-to-line-distance

pointToLineDistance

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

pt (Feature<Point> | Array<number>) Feature or Geometry
line (Feature<LineString> | Array<Array<number>>) GeoJSON Feature or Geometry
options Object? Optional parameters
- options.units string can be degrees, radians, miles, or kilometers (optional, default 'kilometers')
- options.mercator boolean if distance should be on Mercator or WGS84 projection (optional, default false)

Examples

var pt = turf.point([0, 0]);
var line = turf.lineString([[1, 1],[-1, 1]]);

var distance = turf.pointToLineDistance(pt, line, '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 module individually:

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

Or install the Turf module that includes it as a function:

$ npm install @turf/turf