Wondering what’s next for npm?Check out our public roadmap! »

@spatial/nearest-point
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

@spatial/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

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 module individually:

$ npm install @spatial/nearest-point

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

$ npm install @turf/turf

Install

npm i @spatial/nearest-point

DownloadsWeekly Downloads

0

Version

2.0.0

License

MIT

Unpacked Size

10 kB

Total Files

7

Last publish

Collaborators

  • avatar
  • avatar