RoutePlanningOptions

data class RoutePlanningOptions(val itinerary: Itinerary, val costModel: CostModel? = null, val departAt: Date? = null, val arriveAt: Date? = null, val alternativeRoutesOptions: AlternativeRoutesOptions? = null, val guidanceOptions: GuidanceOptions? = null, val routeLegOptions: List<RouteLegOptions> = emptyList(), val vehicle: Vehicle = Vehicle.Car(), val chargingOptions: ChargingOptions? = null, val queryOptions: QueryOptions? = null, val waypointOptimization: WaypointOptimization? = null)

Options for route planning.

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

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.

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.

Constructors

Link copied to clipboard
fun RoutePlanningOptions(itinerary: Itinerary, costModel: CostModel? = null, 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)

Properties

Link copied to clipboard
val arriveAt: Date? = null
Link copied to clipboard
Link copied to clipboard
val costModel: CostModel? = null
Link copied to clipboard
val departAt: Date? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard