TomTom SDK for iOS OnRouteDetourDetails

OnRouteDetourDetails

public struct OnRouteDetourDetails : Hashable

Describes the detour details related to points of interest along the route.

Important

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

  • The detour distance added to the route length, after a point of interest has been added to the route.

    Declaration

    Swift

    public let distance: Measurement<UnitLength>?

  • The detour duration for a passenger car, measured in seconds.

    Declaration

    Swift

    public let duration: Measurement<UnitDuration>?

  • Initializes new on route detour details.

    Declaration

    Swift

    public init(
    duration: Measurement<UnitDuration>? = nil,
    distance: Measurement<UnitLength>? = nil,
    offset: Measurement<UnitLength>? = nil
)

    Parameters

    duration

    The detour duration for a passenger car, measured in seconds. The detour duration is the value added to the estimated time of arrival (of the final destination), after a point of interest is added to the route. If the route that passes through the new POI is faster than the original one, the detour duration value is negative.
    distance

    The detour distance is the added value to the route length, after a point of interest has been added to the route. If the route that passes through the new POI is shorter than the original one, the detour distance value is negative.
    offset

    The length of the route part from the starting point to the detour starting point.

  • The length of the route part from the starting point to the detour starting point.

    Declaration

    Swift

    public let offset: Measurement<UnitLength>?