Route
A wrapper around the native EngineRoute object, representing a complete route from a starting point to a destination, with various alternative paths depending on user preferences or fallback strategies.
Properties
Returns an accessible-friendly version of the optimal route.
Returns a fallback route that bypasses alerts if the optimal route failed due to routing around alerts.
Returns a fallback route that allows bypassing level transition restrictions, such as stairs or ramps, when no compliant path could be found.
Returns the optimal route based on user preferences and constraints. This path aims to be the fastest or most efficient route, depending on the routing configuration.
Functions
Returns the name of the destination location of the route.
Returns the routing error status associated with this route, if any.
Returns the corresponding RoutePath for the given RoutePathType, if available.
Returns the name of the starting location of the route.
Indicates whether any route path was successfully calculated.
Indicates whether the route is from the user's current location