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

View on GitHub

Install in Dash

Mapbox Navigation SDK for iOS Reference Reading History 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
    • DirectionsOptions
    • NavigationMatchOptions
    • SimulationMode
    • SimulationIntent
    • SimulationState
    • PassiveLocationManager
    • – NotificationUserInfoKey
    • PassiveLocationManagerDelegate
  • Maps
    • NavigationMapView
    • NavigationMapViewDelegate
    • MapView
    • PassiveLocationProvider
    • NavigationLocationProvider
    • WaypointStyle
    • UserLocationStyle
  • Styling
    • Style
    • StyleManager
    • StyleManagerNotificationUserInfoKey
    • StyleManagerDelegate
    • DayStyle
    • NightStyle
  • Formatters
    • DistanceFormatter
  • UI Components
    • SpeedLimitView
    • UserPuckCourseView
    • UserHaloCourseView
    • UserCourseView
    • CourseUpdatable
    • NavigationComponent
    • FloatingButton
    • WayNameLabel
    • WayNameView
  • Guidance Instruction UI
    • TopBannerViewController
    • TopBannerViewControllerDelegate
    • InstructionsCardViewController
    • InstructionsCardContainerView
    • InstructionsCardContainerViewDelegate
    • InstructionsBannerView
    • InstructionsBannerViewDelegate
    • BaseInstructionsBannerView
    • ManeuverView
    • JunctionView
    • GenericRouteShield
    • StepsViewControllerDelegate
    • BottomBannerViewController
    • BottomBannerViewControllerDelegate
  • CarPlay
    • CarPlayManager
    • CarPlayManagerDelegate
    • CarPlayNavigationViewController
    • CarPlayNavigationViewControllerDelegate
    • CarPlayActivity
    • CarPlayCompassView
    • CarPlayMapViewController
    • CarPlayMapViewControllerDelegate
    • CarPlaySearchController
    • CarPlaySearchControllerDelegate
    • CarPlayConnectionObserver
    • RecentItem
    • NavigationGeocodedPlacemark
    • CarPlayUserInfo
  • 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
    • FeedbackEvent
    • FeedbackScreenshotOption
    • FeedbackType
    • PassiveNavigationRoadIssueSubtype
    • PassiveNavigationWrongTrafficSubtype
    • LooksIncorrectSubtype
  • Camera
    • NavigationCamera
    • NavigationCameraType
    • NavigationCameraState
    • CameraStateTransition
    • NavigationCameraStateTransition
    • ViewportDataSource
    • NavigationViewportDataSource
    • ViewportDataSourceType
    • ViewportDataSourceDelegate
    • FollowingCameraOptions
    • IntersectionDensity
    • BearingSmoothing
    • GeometryFramingAfterManeuver
    • PitchNearManeuver
    • OverviewCameraOptions
    • NavigationViewportDataSourceOptions
    • CameraOptions
  • Preview
    • PreviewOptions
    • PreviewViewController
    • PreviewViewControllerDelegate
    • Banner
    • BannerConfiguration
    • BannerDismissalViewController
    • BannerDismissalViewControllerDelegate
    • DestinationPreviewViewController
    • DestinationPreviewViewControllerDelegate
    • DestinationOptions
    • DestinationDataSource
    • RoutePreviewViewController
    • RoutePreviewViewControllerDelegate
    • RoutePreviewOptions
    • RoutePreviewDataSource
  • Electronic Horizon
    • ElectronicHorizonOptions
    • RoadGraph
    • – NotificationUserInfoKey
    • – Edge
    • – Path
    • – Position
    • – SubgraphEdge
    • OpenLRIdentifier
    • OpenLROrientation
    • RoadName
    • RoadObject
    • – EdgeLocation
    • – Kind
    • – Location
    • – Position
    • DistancedRoadObject
    • RoadObjectMatcher
    • RoadObjectStore
    • RoadObjectMatcherDelegate
    • RoadObjectStoreDelegate
    • RoadObjectMatcherError
    • OpenLRSideOfRoad
  • Reading History
    • HistoryReader
    • – ReadOptions
    • – Iterator
    • HistoryEvent
    • UnknownHistoryEvent
    • RouteAssignmentHistoryEvent
    • LocationUpdateHistoryEvent
    • History
    • HistoryRecording
  • Other Classes
    • DispatchTimer
    • – State
    • MapboxRoutingProvider
    • – Source
    • – Request
    • PredictiveCacheManager
    • StepInstructionsView
    • StepTableViewCell
  • Other Global Variables
    • CongestionRangeHeavy
    • CongestionRangeLow
    • CongestionRangeModerate
    • CongestionRangeSevere
    • RestrictedRoadClassAttribute
  • Other Enumerations
    • AlternativeRouteError
    • ReroutingError
    • RoutesPresentationStyle
  • Other Extensions
    • Array
    • Bundle
    • CGPoint
    • CGSize
    • CLLocation
    • CPInterfaceController
    • 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
    • NavigationMapInteractionObserver
    • NavigationProviderRequest
    • NavigationStatusPresenter
    • RouteVoiceControllerDelegate
    • RoutingProvider
    • UnimplementedLogging
  • Other Structures
    • AlternativeRoute
    • – RouteInfo
    • AlternativeRouteDetectionStrategy
    • – RefreshOnEmpty
    • BorderCrossing
    • IncidentsOptions
    • IndexedRouteResponse
    • MapMatchingResult
    • PredictiveCacheLocationOptions
    • PredictiveCacheMapsOptions
    • PredictiveCacheNavigationOptions
    • PredictiveCacheOptions
    • RouteAlert
    • StatusUpdatingSettings
    • TileStoreConfiguration
    • – Location
    • Tunnel
  • Other Type Aliases
    • AdvanceLegCompletionHandler
    • CongestionRange
    • ContainerViewController
    • RoutingProviderSource

Reading History

  • HistoryReader

    Provides event-by-event access to history files contents.

    Supports pbf.gz files. History files are created by HistoryRecording.stopRecordingHistory(writingFileWith:) and saved to HistoryRecording.historyDirectoryURL.

    See more

    Declaration

    Swift

    public struct HistoryReader : Sequence
    View Source on GitHub
  • HistoryEvent

    Describes history events produced by HistoryReader

    See more

    Declaration

    Swift

    public protocol HistoryEvent
    View Source on GitHub
  • UnknownHistoryEvent

    History event of unrecognized type.

    Such events usually mean that this type of events is not yet supported or this one is for service use only.

    See more

    Declaration

    Swift

    public class UnknownHistoryEvent : HistoryEvent
    View Source on GitHub
  • RouteAssignmentHistoryEvent

    History event of when route was set.

    See more

    Declaration

    Swift

    public struct RouteAssignmentHistoryEvent : HistoryEvent
    View Source on GitHub
  • LocationUpdateHistoryEvent

    History event of when location was updated.

    See more

    Declaration

    Swift

    public struct LocationUpdateHistoryEvent : HistoryEvent
    View Source on GitHub
  • History

    Digest of history file contents produced by HistoryReader.

    See more

    Declaration

    Swift

    public struct History
    View Source on GitHub
  • HistoryRecording

    Types that conform to this protocol record low-level details as the user goes through a trip for debugging purposes.

    See more

    Declaration

    Swift

    public protocol HistoryRecording
    View Source on GitHub

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

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