RoutePlanningOptions
Options for planning routes, which are passed to one of the various route planners.
Important: This is a Public Preview API. It may be changed or removed at any time.
Parameters
The list of route locations.
General strategy for selecting roads during route calculation.
Use live traffic in the route calculation.
Avoidance criteria.
A departure time for the route.
An arrival time for the route. Cannot be used together with departAt.
Options for calculating more than one route.
Properties for the generated instructions. Specify null for no instructions generation.
Options for each route leg, such as a polyline to follow.
The vehicle dimensions, restrictions and engine parameters.
Additional options for electric vehicles to take charging into account.
Options regarding the way the request is sent to the server.
Specifies whether to optimize the order of waypoints, and if so, how.
Specifies how much guidance information (instructions and lane guidance) is returned with the route. Defaults to RouteInformationMode.Complete.
Specifies the road side on arrival preference for waypoints and destination.
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.