spatial.withinDistance

Procedure

Returns all geometry nodes and their ordered distance in the layer within the distance to the given coordinate

Signature

spatial.withinDistance(layerName :: STRING, coordinate :: ANY, distanceInKm :: FLOAT) :: (node :: NODE, distance :: FLOAT)

Input parameters

Name Type Default Description

layerName

STRING

null

The name of the layer

coordinate

ANY

null

A valid value for the coordinate is a:

  • JTS Coordinate

  • Neo4j Coordinate

  • Neo4j Point

  • Map with keys 'latitude' and 'longitude'

  • Map with keys 'lat' and 'lon'"

  • Node or Relationship with properties 'latitude' and 'longitude'

  • Node or Relationship with properties 'lat' and 'lon'

distanceInKm

FLOAT

null

The distance in kilometers within which to search for geometries

Output parameters

Name Type Description

node

NODE

distance

FLOAT

Examples

Create a native point layer

CALL spatial.addNativePointLayerXY('geom','x','y')
Table 1. Result
node 
(:SpatialLayer {
    geomencoder: "org.neo4j.gis.spatial.encoders.SimplePointEncoder",
    geomencoder_config: "x:y",
    index_class: "org.neo4j.gis.spatial.index.LayerRTreeIndex",
    layer: "geom",
    layer_class: "org.neo4j.gis.spatial.SimplePointLayer"
})

create a node and add it to the index

CREATE (n:Node {id: 42, x: 5.0, y: 4.0}) WITH n CALL spatial.addNode('geom',n) YIELD node RETURN node

Find node within distance

CALL spatial.withinDistance('geom',point({latitude:4.1,longitude:5.1}),100)
Table 2. Result
distance node 
15.705713907526011
 
(:Node {
    bbox: [ 5.0, 4.0, 5.0, 4.0 ],
    gtype: 1,
    id: 42,
    x: 5.0,
    y: 4.0
})