Procedures & Functions

Neo4j Spatial is also packaged as a ZIP file that can be unzipped into the Neo4j Server $NEO4J_HOME/plugins directory. After restarting the server, you should be able to use the following procedure and function calls from the Cypher query language.

spatial

Qualified Name Type

spatial.addLayer

Adds a new layer with the given type (see spatial.layerTypes) and configuration. Returns the layers root node.

Procedure

spatial.addLayerWithEncoder

Adds a new layer with the given encoder class and configuration, returns the layer root node

Procedure

spatial.addNativePointLayer

Adds a new native point layer, returns the layer root node

Procedure

spatial.addNativePointLayerGeohash

Adds a new native point layer with geohash based index, returns the layer root node

Procedure

spatial.addNativePointLayerHilbert

Adds a new native point layer with hilbert curve based index, returns the layer root node

Procedure

spatial.addNativePointLayerWithConfig

Adds a new native point layer with the given configuration, returns the layer root node

Procedure

spatial.addNativePointLayerXY Deprecated

Adds a new point layer with the given properties for x and y coordinates, returns the layer root node

Procedure

spatial.addNativePointLayerZOrder

Adds a new native point layer with z-order curve based index, returns the layer root node

Procedure

spatial.addNode

Adds the given node to the layer, returns the geometry-node

Procedure

spatial.addNodes

Adds the given nodes list to the layer, returns the count

Procedure

spatial.addPointLayer

Adds a new simple point layer, returns the layer root node

Procedure

spatial.addPointLayerGeohash

Adds a new simple point layer with geohash based index, returns the layer root node

Procedure

spatial.addPointLayerHilbert

Adds a new simple point layer with hilbert curve based index, returns the layer root node

Procedure

spatial.addPointLayerWithConfig

Adds a new simple point layer with the given configuration, returns the layer root node

Procedure

spatial.addPointLayerXY

Adds a new simple point layer with the given properties for x and y coordinates, returns the layer root node

Procedure

spatial.addPointLayerZOrder

Adds a new simple point layer with z-order curve based index, returns the layer root node

Procedure

spatial.addWKT

Adds the given WKT string to the layer, returns the created geometry node

Procedure

spatial.addWKTLayer

Adds a new WKT layer with the given node property to hold the WKT string, returns the layer root node

Procedure

spatial.addWKTs

Adds the given WKT string list to the layer, returns the created geometry nodes

Procedure

spatial.asExternalGeometry Deprecated

Returns a geometry object as an external geometry type to be returned to a client

Procedure

spatial.asGeometry

Returns a geometry object as the Neo4j geometry type, to be passed to other functions or procedures or returned to a client

Function

spatial.asMap

Returns a Map object representing the Geometry, to be passed to other procedures or returned to a client

Function

spatial.bbox

Finds all geometry nodes in the given layer within the lower left and upper right coordinates of a box. 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'

Procedure

spatial.closest

Finds all geometry nodes in the layer within the distance to the given coordinate

Procedure

spatial.decodeGeometry

Returns a geometry of a layer node as the Neo4j geometry type, to be passed to other procedures or returned to a client

Function

spatial.getFeatureAttributes

Returns feature attributes of the given layer

Procedure

spatial.importOSM

Imports the the provided osm-file from URI to a layer of the same name, returns the count of data added

Procedure

spatial.importOSMToLayer

Imports the the provided osm-file from URI to a layer, returns the count of data added

Procedure

spatial.importShapefile

Imports the the provided shape-file from URI to a layer of the same name, returns the count of data added

Procedure

spatial.importShapefileToLayer

Imports the the provided shape-file from URI to the given layer, returns the count of data added

Procedure

spatial.intersects

Returns all geometry nodes that intersect the given geometry (shape, polygon) in the layer

Procedure

spatial.layer

Returns the layer root node for the given layer name

Procedure

spatial.layerTypes

Returns the different registered layer types

Procedure

spatial.layers

Returns name, and details for all layers

Procedure

spatial.neo4jGeometryToWkt

Converts a point or point array to WKT

Function

spatial.procedures

Lists all spatial procedures with name and signature

Procedure

spatial.removeLayer

Removes the given layer

Procedure

spatial.removeNode

Removes the given node from the layer, returns the geometry-node

Procedure

spatial.removeNodes

Removes the given nodes from the layer, returns the count of nodes removed

Procedure

spatial.setFeatureAttributes

Sets the feature attributes of the given layer

Procedure

spatial.upgrade

Upgrades an older spatial data model and returns a list of layers upgraded

Procedure

spatial.withinDistance

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

Procedure

spatial.wktToGeoJson

Converts a WKT to GeoJson structure

Function

spatial.addNode

Qualified Name Type

spatial.addNode.byId

Adds the given node to the layer, returns the geometry-node

Procedure

spatial.addNodes

Qualified Name Type

spatial.addNodes.byId

Adds the given nodes list to the layer, returns the count

Procedure

spatial.removeNode

Qualified Name Type

spatial.removeNode.byId

Removes the given node from the layer, returns the geometry-node

Procedure

spatial.removeNodes

Qualified Name Type

spatial.removeNodes.byId

Removes the given nodes from the layer, returns the count of nodes removed

Procedure