nearest

Returns the geometry with the minimum distance to the query geometry.

Cartesian distance is calculated between the actual geometries, not their bounding boxes.

If there are multiple equidistant geometries, this function will return only one of them. To return all such geometries, use nearestAll.

Parameters

Name	Type	Description
geometry	Geometry	Geometry for which the nearest neighbor is queried

Returns

G | undefined

The nearest geometry or undefined if the tree is empty

Throws

• GEOSError if any of the considered candidates for the nearest geometry is one of unsupported geometry types (curved)

Examples

const geometries = [
    point([ 0, 2 ]), lineString([ [ 4, 2 ], [ 8, 2 ] ]),
    point([ 0, 4 ]), point([ 4, 4 ]), point([ 8, 4 ]),
];
const target = lineString([ [ 1, 0 ], [ 1, 5 ], [ 3, 6 ] ]);

const tree = strTreeIndex(geometries);
const nearestMatch = tree.nearest(target);
// <POINT (0 2)>
const nearestAllMatches = tree.nearestAll(target);
// [ <POINT (0 2)>, <POINT (0 4)> ]

const geometries = [ point([ 0, 2 ]), lineString([ [ 4, 2 ], [ 8, 2 ] ]), point([ 0, 4 ]), point([ 4, 4 ]), point([ 8, 4 ]), ]; const target = lineString([ [ 1, 0 ], [ 1, 5 ], [ 3, 6 ] ]); const tree = strTreeIndex(geometries); const nearestMatch = tree.nearest(target); // <POINT (0 2)> const nearestAllMatches = tree.nearestAll(target); // [ <POINT (0 2)>, <POINT (0 4)> ]