turf-nearest

WebJar for turf-nearest

License	MIT
GroupId	org.webjars.npm
ArtifactId	turf-nearest
Last Version	3.0.12
Release Date	Apr 13, 2018
Type	jar
Description	turf-nearest WebJar for turf-nearest
Project URL	http://webjars.org
Source Code Management	https://github.com/turf-junkyard/turf-nearest

Download turf-nearest

Filename	Size
turf-nearest-3.0.12.pom
turf-nearest-3.0.12.jar	7 KB
turf-nearest-3.0.12-sources.jar	22 bytes
turf-nearest-3.0.12-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/turf-nearest/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>turf-nearest</artifactId>
    <version>3.0.12</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/turf-nearest/
implementation 'org.webjars.npm:turf-nearest:3.0.12'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/turf-nearest/
implementation ("org.webjars.npm:turf-nearest:3.0.12")

Apache Buildr

'org.webjars.npm:turf-nearest:jar:3.0.12'

Apache Ivy

<dependency org="org.webjars.npm" name="turf-nearest" rev="3.0.12">
  <artifact name="turf-nearest" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='turf-nearest', version='3.0.12')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "turf-nearest" % "3.0.12"

Leiningen

[org.webjars.npm/turf-nearest "3.0.12"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : turf-distance	jar	[3.0.12,4)

Project Modules

There are no modules declared in this project.

turf-nearest

turf nearest module

turf.nearest(point, against)

Takes a reference Point|point and a set of points and returns the point from the set closest to the reference.

Parameters

parameter	type	description
point	Feature.<Point>	the reference point
against	FeatureCollection.<Point>	input point set

Example

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

Installation

Requires nodejs.

$ npm install turf-nearest

Tests

$ npm test

deprecated turf modules: do not use or reference, for redirects only

turf is now a monorepo: all turf modules are in Turfjs/turf

Versions

Version
3.0.12 Apr 13, 2018