@spatial/point-to-line-distance v2.0.0

@spatial/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 Coord Feature or Geometry
• line Feature<LineString> GeoJSON Feature or Geometry
• options Object Optional parameters (optional, default {})
  • 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, {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 module individually:

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

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

$ npm install @turf/turf