RoutePlanningOptions

constructor(itinerary: Itinerary, costModel: CostModel? = CostModel(), departAt: Date? = null, arriveAt: Date? = null, alternativeRoutesOptions: AlternativeRoutesOptions? = null, guidanceOptions: GuidanceOptions? = null, routeLegOptions: List<RouteLegOptions> = emptyList(), vehicle: Vehicle = Vehicle.Car(), chargingOptions: ChargingOptions? = null, queryOptions: QueryOptions? = null, waypointOptimization: WaypointOptimization? = null, mode: RouteInformationMode = RouteInformationMode.Complete, arrivalSidePreference: ArrivalSidePreference = ArrivalSidePreference.AnySide, reconstructionMode: ReconstructionMode? = null)

Parameters

itinerary

The list of route locations.

costModel

Options governing which streets to prefer.

departAt

A departure time for the route.

arriveAt

An arrival time for the route. Cannot be used together with departAt.

alternativeRoutesOptions

Options for calculating more than one route.

guidanceOptions

Properties for the generated instructions. Specify null for no instructions generation.

routeLegOptions

Options for each route leg, such as a polyline to follow.

vehicle

The vehicle dimensions, restrictions and engine parameters.

chargingOptions

Additional options for electric vehicles to take charging into account.

queryOptions

Options regarding the way the request is sent to the server.

waypointOptimization

Specifies whether to optimize the order of waypoints, and if so, how.

mode

Specifies how much guidance information (instructions and lane guidance) is returned with the route. Defaults to RouteInformationMode.Complete.

arrivalSidePreference

Specifies the road side on arrival preference for waypoints and destination.

reconstructionMode

Defines the mode used for the route reconstruction. If the value is null and at least one routeLegOptions has supporting points it will be defaulted to ReconstructionMode.Track.

Note: The parameters departAt, arriveAt and reconstructionMode are not supported with the Orbis map.

Throws

if an invalid combination of options is used, such as specifying both departAt and arriveAt, or using chargingOptions with a non-electric vehicle, or specifying reconstructionMode without supportingPoints in routeLegOptions.

Important: This is a Public Preview API. It may be changed or removed at any time.


constructor(itinerary: Itinerary, costModel: CostModel? = CostModel(), departAt: Date? = null, arriveAt: Date? = null, alternativeRoutesOptions: AlternativeRoutesOptions? = null, guidanceOptions: GuidanceOptions? = null, routeLegOptions: List<RouteLegOptions> = emptyList(), vehicle: Vehicle = Vehicle.Car(), chargingOptions: ChargingOptions? = null, queryOptions: QueryOptions? = null, waypointOptimization: WaypointOptimization? = null, mode: RouteInformationMode = RouteInformationMode.Complete, arrivalSidePreference: ArrivalSidePreference = ArrivalSidePreference.AnySide)