TomTom SDK for iOS RoutePlanningOptions

RoutePlanningOptions

public struct RoutePlanningOptions : RoutingOptionsWithItinerary

Options for route planning.

  • Initializer.

    Note

    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
    ) 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.

  • The list of route locations.

    Declaration

    Swift

    public var itinerary: Itinerary

  • Options governing which paths to prefer.

    Declaration

    Swift

    public var costModel: CostModel?

  • Options for calculating more than one route.

    Declaration

    Swift

    public var alternativeRoutesOptions: AlternativeRoutesOptions?

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

    Declaration

    Swift

    public var routeLegOptions: [RouteLegOptions]

  • Properties for the generated instructions. Instructions will not be generated if the options are not set.

    Important

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

    Declaration

    Swift

    public var guidanceOptions: GuidanceOptions?

  • 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?

  • 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?

  • 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

  • Additional options for electric vehicles to take charging into account.

    Important

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

    Declaration

    Swift

    public var chargingOptions: ChargingOptions?

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

    Declaration

    Swift

    public var queryOptions: QueryOptions?

  • The way of optimizing the order of waypoints

    Declaration

    Swift

    public var waypointOptimization: WaypointOptimization?

  • Defines how much guidance information (instructions and lane guidance) is returned with the route.

    Important

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

    Declaration

    Swift

    public var mode: RouteInformationMode

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

    Declaration

    Swift

    public var arrivalSidePreference: ArrivalSidePreference