Interface: GetRouteConfiguration

The parameters to get a route.

Properties

announceFormat?

optional announceFormat: AnnounceFormat;

The format used to announce directions in the instructions. Default to RELATIVE.

finalLocation

finalLocation: RouteLocation

The final location for the route.

initialLocation

initialLocation: RouteLocation

The initial location for the route.

language?

optional language: string;

The language for the instructions. Default to en.

preferAccessibleRoute?

optional preferAccessibleRoute: boolean;

The option to generate a route (if available) for people with mobility disabilities.

Default Value

false.

unitSystem?

optional unitSystem: UnitSystem;

The unit system used for the distance. Default to METRIC.

userBearing?

optional userBearing: number;

The user’s heading, in degrees clockwise from north (0–360), used as the reference direction when announcing turns (e.g. with RELATIVE GetRouteConfiguration.announceFormat). Default to 0.