NavigationOptions

public struct NavigationOptions

A struct containing information about the navigation options

  • A struct containing information about the navigation stop options.

    See more

    Declaration

    Swift

    public struct StopOptions

  • The struct containing information about itinerary options.

    Declaration

    Swift

    public let itineraryOptions: ItineraryOptions

  • The mode used to track the user location on the map. Default is nil, which means that after the navigation is started, the user tracking mode remains unchanged

    Declaration

    Swift

    public let userTrackingMode: MLNUserTrackingMode?

  • The struct containing information about the navigation stop options.

    Declaration

    Swift

    public let stopNavigationOptions: StopOptions

  • The distance measured in meters indicates when the user’s location will no longer be projected onto the itinerary and navigation will be recalculated. Default is 25 meters

    Declaration

    Swift

    public let userPositionThreshold: CLLocationDistance

  • The navigation recalculation time interval, measured in seconds, indicates the interval between consecutive navigation recalculations. An interval of less than 5 seconds is forbidden. Default is 5 seconds

    Declaration

    Swift

    public let navigationRecalculationTimeInterval: TimeInterval

  • Initializes and returns a newly allocated navigation options with the specified parameters.

    Declaration

    Swift

    public init(
    itineraryOptions: ItineraryOptions = .init(),
    userTrackingMode: MLNUserTrackingMode? = nil,
    stopNavigationOptions: StopOptions = .init(),
    userPositionThreshold: CLLocationDistance = 25,
    navigationRecalculationTimeInterval: TimeInterval = 5
)

    Parameters

    itineraryOptions

    The struct containing information about itinerary options.
    userTrackingMode

    The mode used to track the user location on the map. Default is nil, which means that after the navigation is started, the user tracking mode remains unchanged
    stopNavigationOptions

    The struct containing information about the navigation stop options.
    userPositionThreshold

    The distance measured in meters indicates when the user’s location will no longer be projected onto the itinerary and navigation will be recalculated. Default is 25 meters
    navigationRecalculationTimeInterval

    The navigation recalculation time interval, measured in seconds, indicates the interval between consecutive navigation recalculations. An interval of less than 5 seconds is forbidden. Default is 5 seconds