Class TerraRoute

Implements

Router

Index

Constructors

Methods

buildRouteGraph expandRouteGraph getRoute

Constructors

constructor

new TerraRoute(
    options?: {
        distanceMeasurement?: (a: Position, b: Position) => number;
        heap?: HeapConstructor;
    },
): TerraRoute
Parameters
- Optionaloptions: {
  distanceMeasurement?: (a: Position, b: Position) => number;
  heap?: HeapConstructor;
  }
Returns TerraRoute
- Defined in terra-route.ts:52

Methods

buildRouteGraph

buildRouteGraph(network: FeatureCollection<LineString>): void
Builds a graph (CSR) from a LineString FeatureCollection. Two-pass build: pass 1 assigns node indices and counts degrees; pass 2 fills CSR arrays.
Parameters
- network: FeatureCollection<LineString>
Returns void
Implementation of Router.buildRouteGraph
- Defined in terra-route.ts:64

expandRouteGraph

expandRouteGraph(network: FeatureCollection<LineString>): void
Expands (merges) the existing graph with an additional LineString FeatureCollection.
Parameters
- network: FeatureCollection<LineString>
Returns void
Implementation of Router.expandRouteGraph
- Defined in terra-route.ts:151

getRoute

getRoute(
start: Feature<Point>,
end: Feature<Point>,
): null | Feature<LineString, GeoJsonProperties>
Computes the shortest route between two points in the network using the A* algorithm.
Parameters
- start: Feature<Point>
  A GeoJSON Point Feature representing the start location.
- end: Feature<Point>
  A GeoJSON Point Feature representing the end location.
Returns null | Feature<LineString, GeoJsonProperties>
A GeoJSON LineString Feature representing the shortest path, or null if no path is found.

Throws
Error if the network has not been built yet with buildRouteGraph(network).
Implementation of Router.getRoute
- Defined in terra-route.ts:278