@turf/nearest-point-to-line

@turf/nearest-point-to-line

nearestPointToLine

Returns the closest point, of a collection of points, to a line. The returned point has a dist property indicating its distance to the line.

Parameters

• points (FeatureCollection | GeometryCollection<Point>) Point Collection

• line (Feature | Geometry<LineString>) Line Feature

• options Object? Optional parameters

  • options.units string unit of the output distance property (eg: degrees, radians, miles, or kilometers) (optional, default 'kilometers')
  • options.properties Object Translate Properties to Point (optional, default {})

Examples

var pt1 = turf.point([0, 0]);
var pt2 = turf.point([0.5, 0.5]);
var points = turf.featureCollection([pt1, pt2]);
var line = turf.lineString([[1,1], [-1,1]]);

var nearest = turf.nearestPointToLine(points, line);

//addToMap
var addToMap = [nearest, line];

Returns Feature<Point> the closest point

pt

Translate Properties to final Point, priorities:

1. options.properties
2. inherent Point properties
3. dist custom properties created by NearestPointToLine

---

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/nearest-point-to-line

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

$ npm install @turf/turf