This package has been deprecated

Author message:

Turf packages are now namespaced: please use @turf/nearest instead

turf-nearest

3.0.12 • Public • Published

turf-nearest

nearest

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

  • targetPoint Feature<Point> the reference point
  • points FeatureCollection<Point> against input point set

Examples

var point = {
  "type": "Feature",
  "properties": {
    "marker-color": "#0f0"
  },
  "geometry": {
    "type": "Point",
    "coordinates": [28.965797, 41.010086]
  }
};
var against = {
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [28.973865, 41.011122]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [28.948459, 41.024204]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [28.938674, 41.013324]
      }
    }
  ]
};
 
var nearest = turf.nearest(point, against);
nearest.properties['marker-color'] = '#f00';
 
var resultFeatures = against.features.concat(point);
var result = {
  "type": "FeatureCollection",
  "features": resultFeatures
};
 
//=result

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 turf-nearest

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

$ npm install turf

Readme

Keywords

Package Sidebar

Install

npm i turf-nearest

Weekly Downloads

14,299

Version

3.0.12

License

MIT

Last publish

Collaborators

  • tcql
  • mourner
  • jvrousseau
  • jseppi
  • morganherlocker
  • cspanring
  • cwmma
  • lyzidiamond
  • tmcw