Mapbox Navigation SDK for iOS Docs Navigation SDK for iOS Reference (2.8.1)

View on GitHub

Install in Dash

Mapbox Navigation SDK for iOS Reference Directions Extension Reference
  • Guides
    • Using Map Matching
    • Reduce Memory Usage
    • Styling the UI
  • Turn-by-turn UI
    • NavigationViewController
    • NavigationViewControllerDelegate
    • RouteVoiceController
    • SpeechSynthesizing
    • SpeechSynthesizingDelegate
    • MapboxSpeechSynthesizer
    • SystemSpeechSynthesizer
    • MultiplexedSpeechSynthesizer
    • SpeechError
    • SpeechFailureAction
    • NavigationOptions
    • NavigationView
  • Core Navigation Logic
    • NavigationService
    • NavigationServiceDelegate
    • MapboxNavigationService
    • – NotificationUserInfoKey
    • Router
    • RouterDataSource
    • RouteController
    • – NotificationUserInfoKey
    • RouterDelegate
    • RouteProgress
    • RouteLegProgress
    • RouteStep
    • RouteStepProgress
    • CongestionLevel
    • VisualInstruction
    • VisualInstructionDelegate
    • NavigationEventsManager
    • ActiveNavigationEventsManagerDataSource
    • PassiveNavigationEventsManagerDataSource
    • NavigationLocationManager
    • ReplayLocationManager
    • SimulatedLocationManager
    • NavigationRouteOptions
    • RouteOptions
    • NavigationMatchOptions
    • SimulationMode
    • PassiveLocationManager
    • – NotificationUserInfoKey
    • HistoryRecording
  • Maps
    • NavigationMapView
    • NavigationMapViewDelegate
    • MapView
    • PassiveLocationProvider
    • NavigationLocationProvider
    • WaypointStyle
    • UserLocationStyle
  • Styling
    • Style
    • StyleManager
    • StyleManagerNotificationUserInfoKey
    • StyleManagerDelegate
    • DayStyle
    • NightStyle
  • Formatters
    • DistanceFormatter
  • UI Components
    • BottomBannerViewController
    • BottomBannerViewControllerDelegate
    • SpeedLimitView
    • UserPuckCourseView
    • UserHaloCourseView
    • CourseUpdatable
    • NavigationComponent
  • Guidance Instruction UI
    • TopBannerViewController
    • InstructionsCardViewController
    • InstructionsCardContainerView
    • InstructionsCardContainerViewDelegate
    • InstructionsBannerView
    • InstructionsBannerViewDelegate
    • BaseInstructionsBannerView
    • ManeuverView
    • JunctionView
    • GenericRouteShield
  • CarPlay
    • CarPlayManager
    • CarPlayManagerDelegate
    • CarPlayNavigationViewController
    • CarPlayNavigationViewControllerDelegate
    • CarPlayActivity
    • CarPlayCompassView
    • CarPlayMapViewController
    • CarPlayMapViewControllerDelegate
    • CarPlaySearchController
    • CarPlaySearchControllerDelegate
    • CarPlayConnectionObserver
    • RecentItem
    • NavigationGeocodedPlacemark
  • Configuration
    • RouteControllerDeadReckoningTimeInterval
    • RouteControllerMediumAlertInterval
    • RouteControllerHighAlertInterval
    • RouteControllerManeuverZoneRadius
    • RouteSnappingMaxManipulatedCourseAngle
    • RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion
    • RouteControllerMaximumDistanceBeforeRecalculating
    • RouteControllerUserLocationSnappingDistance
    • MapOrnamentPosition
    • CongestionAttribute
    • CurrentLegAttribute
    • RouteLineWidthByZoomLevel
    • NavigationMapViewMinimumDistanceForOverheadZooming
    • NavigationViewMinimumVolumeForWarning
    • GradientCongestionFadingDistance
    • RouteControllerIncorrectCourseMultiplier
    • RouteControllerLinkedInstructionBufferMultiplier
    • RouteControllerMaximumSpeedForUsingCurrentStep
    • RouteControllerMinNumberOfInCorrectCourses
    • RouteControllerMinimumBacktrackingDistanceForRerouting
    • RouteControllerMinimumDistanceForContinueInstruction
    • RouteControllerMinimumDurationRemainingForProactiveRerouting
    • RouteControllerMinimumNumberLocationUpdatesBackwards
    • RouteControllerNumberOfSecondsForRerouteFeedback
    • RouteControllerProactiveReroutingInterval
    • RouteSnappingMinimumHorizontalAccuracy
    • RouteSnappingMinimumSpeed
    • NavigationSettings
  • User Feedback
    • FeedbackViewController
    • FeedbackViewControllerDelegate
    • FeedbackItem
    • ActiveNavigationFeedbackType
    • PassiveNavigationFeedbackType
    • PassiveNavigationIncorrectVisualSubtype
    • ConfusingAudioSubtype
    • RouteQualitySubtype
    • IllegalRouteSubtype
    • RoadClosureSubtype
    • FeedbackSource
    • EndOfRouteFeedback
  • Camera
    • NavigationCamera
    • NavigationCameraType
    • NavigationCameraState
    • CameraStateTransition
    • NavigationCameraStateTransition
    • ViewportDataSource
    • NavigationViewportDataSource
    • ViewportDataSourceType
    • ViewportDataSourceDelegate
  • Electronic Horizon
    • ElectronicHorizonOptions
    • RoadGraph
    • – NotificationUserInfoKey
    • – Edge
    • – Path
    • – Position
    • – SubgraphEdge
    • OpenLRIdentifier
    • OpenLROrientation
    • RoadName
    • RoadObject
    • – EdgeLocation
    • – Kind
    • – Location
    • – Position
    • DistancedRoadObject
    • RoadObjectMatcher
    • RoadObjectStore
    • RoadObjectMatcherDelegate
    • RoadObjectStoreDelegate
    • RoadObjectMatcherError
  • Other Classes
    • DispatchTimer
    • – State
    • FeedbackEvent
    • FloatingButton
    • MapboxRoutingProvider
    • – Source
    • – Request
    • PredictiveCacheManager
    • StepInstructionsView
    • StepTableViewCell
    • WayNameLabel
    • WayNameView
  • Other Global Variables
    • CongestionRangeHeavy
    • CongestionRangeLow
    • CongestionRangeModerate
    • CongestionRangeSevere
    • RestrictedRoadClassAttribute
  • Other Enumerations
    • AlternativeRouteError
    • FeedbackScreenshotOption
    • LooksIncorrectSubtype
    • OpenLRSideOfRoad
    • PassiveNavigationRoadIssueSubtype
    • PassiveNavigationWrongTrafficSubtype
    • ReroutingError
    • RoutesPresentationStyle
    • SimulationIntent
    • SimulationState
  • Other Extensions
    • Array
    • Bundle
    • CGPoint
    • CGSize
    • CLLocation
    • CPInterfaceController
    • CameraOptions
    • CongestionRange
    • Dictionary
    • Directions
    • Locale
    • MapboxNavigationNative.RoadObjectMatcherError
    • MapboxStreetsRoadClass
    • Measurement
    • NSAttributedString
    • – Key
    • Notification
    • – Name
    • ResourceOptionsManager
    • RouteLeg
    • String
    • StyleURI
    • TileStore
    • TilesetDescriptorFactory
    • UIApplication
    • – State
    • UIDevice
    • UIEdgeInsets
    • UIFont
    • UIWindow
    • URLSessionDataTask
  • Other Protocols
    • BimodalCache
    • BimodalDataCache
    • BimodalImageCache
    • FeedbackType
    • NavigationMapInteractionObserver
    • NavigationProviderRequest
    • NavigationStatusPresenter
    • PassiveLocationManagerDelegate
    • RouteVoiceControllerDelegate
    • RoutingProvider
    • StepsViewControllerDelegate
    • TopBannerViewControllerDelegate
    • UnimplementedLogging
  • Other Structures
    • AlternativeRoute
    • – RouteInfo
    • AlternativeRouteDetectionStrategy
    • – RefreshOnEmpty
    • BearingSmoothing
    • BorderCrossing
    • FollowingCameraOptions
    • GeometryFramingAfterManeuver
    • IncidentsOptions
    • IndexedRouteResponse
    • IntersectionDensity
    • MapMatchingResult
    • NavigationViewportDataSourceOptions
    • OverviewCameraOptions
    • PitchNearManeuver
    • PredictiveCacheOptions
    • RouteAlert
    • StatusUpdatingSettings
    • TileStoreConfiguration
    • – Location
    • Tunnel
  • Other Type Aliases
    • AdvanceLegCompletionHandler
    • CarPlayUserInfo
    • CongestionRange
    • ContainerViewController
    • RoutingProviderSource
    • UserCourseView

Directions

extension Directions: RoutingProvider
  • calculateRoutes(options:completionHandler:)

    Declaration

    Swift

    @discardableResult
    public func calculateRoutes(options: RouteOptions, completionHandler: @escaping RouteCompletionHandler) -> NavigationProviderRequest?
    View Source on GitHub
  • calculateRoutes(options:completionHandler:)

    Declaration

    Swift

    @discardableResult
    public func calculateRoutes(options: MatchOptions, completionHandler: @escaping MatchCompletionHandler) -> NavigationProviderRequest?
    View Source on GitHub
  • refreshRoute(indexedRouteResponse:fromLegAtIndex:completionHandler:)

    Declaration

    Swift

    @discardableResult
    public func refreshRoute(indexedRouteResponse: IndexedRouteResponse, fromLegAtIndex: UInt32, completionHandler: @escaping RouteCompletionHandler) -> NavigationProviderRequest?
    View Source on GitHub
  • calculateWithCache(options:completionHandler:)

    Begins asynchronously calculating routes using the given options and delivers the results to a closure.

    This method retrieves the routes asynchronously from the Mapbox Directions API over a network connection. If a server error occurs, details about the error are passed into the given completion handler in lieu of the routes. If network error is encountered, onboard routing engine will attempt to provide directions using existing cached tiles.

    Routes may be displayed atop a Mapbox map.

    Declaration

    Swift

    @discardableResult
    public func calculateWithCache(options: RouteOptions, completionHandler: @escaping RouteCompletionHandler) -> URLSessionDataTask?

    Parameters

    options

    A RouteOptions object specifying the requirements for the resulting routes.

    completionHandler

    The closure (block) to call with the resulting routes. This closure is executed on the application’s main thread.

    Return Value

    The data task used to perform the HTTP request. If, while waiting for the completion handler to execute, you no longer want the resulting routes, cancel this task.

    View Source on GitHub
  • calculateOffline(options:completionHandler:)

    Begins asynchronously calculating routes using the given options and delivers the results to a closure.

    This method retrieves the routes asynchronously from onboard routing engine using existing cached tiles.

    Routes may be displayed atop a Mapbox map.

    Declaration

    Swift

    public func calculateOffline(options: RouteOptions, completionHandler: @escaping RouteCompletionHandler)

    Parameters

    options

    A RouteOptions object specifying the requirements for the resulting routes.

    completionHandler

    The closure (block) to call with the resulting routes. This closure is executed on the application’s main thread.

    View Source on GitHub

© 2014–2022 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.14.2, a Realm project.