Interface RouteDataInterface

The route data which contains all the necessary information about the route between two points.


  • RouteDataInterface


available: boolean

Flag which states whether the path is available or not.

Calculated route path.

instructions: InstructionApiInterface[]

Instructions for navigating through a route.

message: string

The message stating why finding a route failed. If finding a route was successful this will be empty.

routeLength: number

The route length in meters.

If routing to/from a point which is not on the ground, the projection on the ground of this point will be used to calculate the total length. Returns the distance from the ground projected start until the ground projected end [m].

Generated using TypeDoc