mirror of
https://github.com/Turfjs/turf.git
synced 2026-01-25 16:07:00 +00:00
@turf/nearest-point
nearestPoint
Takes a reference point and a FeatureCollection of Features with Point geometries and returns the point from the FeatureCollection closest to the reference. This calculation is geodesic.
Parameters
-
targetPointCoord the reference point -
pointsFeatureCollection<Point> against input point set -
optionsObject Optional parameters (optional, default{})options.unitsUnits the units of the numeric result. Supports all valid Turf Units. (optional, default'kilometers')
Examples
var targetPoint = turf.point([28.965797, 41.010086], {"marker-color": "#0F0"});
var points = turf.featureCollection([
turf.point([28.973865, 41.011122]),
turf.point([28.948459, 41.024204]),
turf.point([28.938674, 41.013324])
]);
var nearest = turf.nearestPoint(targetPoint, points);
//addToMap
var addToMap = [targetPoint, points, nearest];
nearest.properties['marker-color'] = '#F00';
Returns Feature<Point> the closest point in the set to the reference point
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
Or install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf