TomTom SDK for iOS RoutePlanningOptions

RoutePlanningOptions

public struct RoutePlanningOptions : RoutingOptionsWithItinerary

Options for route planning.


                    
                    
                    init(itinerary:costModel:alternativeRoutesOptions:routeLegOptions:guidanceOptions:departAt:arriveAt:vehicle:chargingOptions:queryOptions:waypointOptimization:mode:arrivalSidePreference:reconstructionMode:)

Initializer.

Note

The parameters departAt and arriveAt are not yet supported with the Orbis map.

Throws

RoutingOptionsError if invalid routing options provided.

Important

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

Declaration

Swift

public init
    (
        itinerary: Itinerary,
        costModel: CostModel? = nil,
        alternativeRoutesOptions: AlternativeRoutesOptions? = nil,
        routeLegOptions: [RouteLegOptions] = [],
        guidanceOptions: GuidanceOptions? = nil,
        departAt: Date? = nil,
        arriveAt: Date? = nil,
        vehicle: any Vehicle = Car(),
        chargingOptions: ChargingOptions? = nil,
        queryOptions: QueryOptions? = nil,
        waypointOptimization: WaypointOptimization? = nil,
        mode: RouteInformationMode = .complete,
        arrivalSidePreference: ArrivalSidePreference = .anySide,
        reconstructionMode: ReconstructionMode? = nil
    ) throws

Parameters

`itinerary`	The list of route locations.
`costModel`	Options governing which paths to prefer.
`alternativeRoutesOptions`	Options for calculating more than one route.
`routeLegOptions`	Options for each route leg, such as a polyline to follow.
`guidanceOptions`	Properties for the generated instructions. Instructions will not be generated if the options are not set.
`departAt`	A departure time for the route. Cannot be used together with arriveAt.
`arriveAt`	An arrival time for the route. Cannot be used together with departAt.
`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`	Defines how to optimize the order of waypoints.
`mode`	Defines how much guidance information (instructions and land guidance) is returned with the route.
`arrivalSidePreference`	Defines road side on arrival preference for waypoints and destination.
`reconstructionMode`	Defines the reconstruction mode used for route reconstruction.

itinerary
The list of route locations.
Declaration
Swift

public var itinerary: Itinerary
costModel
Options governing which paths to prefer.
Declaration
Swift

public var costModel: CostModel?
alternativeRoutesOptions
Options for calculating more than one route.
Declaration
Swift

public var alternativeRoutesOptions: AlternativeRoutesOptions?
routeLegOptions
Options for each route leg, such as a polyline to follow.
Declaration
Swift

public var routeLegOptions: [RouteLegOptions]
guidanceOptions
Properties for the generated instructions. Instructions will not be generated if the options are not set.
Declaration
Swift

public var guidanceOptions: GuidanceOptions?
departAt
A departure time for the route. Cannot be used together with arriveAt.

Note
This option is not yet supported with the Orbis map.
Declaration
Swift

public var departAt: Date?
arriveAt
An arrival time for the route. Cannot be used together with departAt.

Note
This option is not yet supported with the Orbis map.
Declaration
Swift

public var arriveAt: Date?
vehicle
The vehicle dimensions, restrictions and engine parameters.

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

public var vehicle: any Vehicle
chargingOptions
Additional options for electric vehicles to take charging into account.
Declaration
Swift

public var chargingOptions: ChargingOptions?
queryOptions
Options regarding the way the request is sent to the server.
Declaration
Swift

public var queryOptions: QueryOptions?
waypointOptimization
The way of optimizing the order of waypoints
Declaration
Swift

public var waypointOptimization: WaypointOptimization?
mode
Defines how much guidance information (instructions and lane guidance) is returned with the route.
Declaration
Swift

public var mode: RouteInformationMode
reconstructionMode
Defines the reconstruction mode used for route reconstruction.

Note
This option is not yet supported with the Orbis map.

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

public var reconstructionMode: ReconstructionMode?
arrivalSidePreference
Specifies road side on arrival preference for waypoints and destination.
Declaration
Swift

public var arrivalSidePreference: ArrivalSidePreference