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 Guidance Instruction UI 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

Guidance Instruction UI

  • TopBannerViewController

    A view controller that displays the current maneuver instruction as a “banner” flush with the edges of the containing view. The user swipes to one side to preview a subsequent maneuver.

    This class is the default top banner view controller used by NavigationOptions and NavigationViewController. InstructionsCardViewController provides an alternative, user notification–like interface.

    See more

    Declaration

    Swift

    open class TopBannerViewController : UIViewController
    extension TopBannerViewController: NavigationComponent
    extension TopBannerViewController: InstructionsBannerViewDelegate
    extension TopBannerViewController: StepsViewControllerDelegate
    extension TopBannerViewController: CarPlayConnectionObserver
    extension TopBannerViewController: NavigationStatusPresenter
    extension TopBannerViewController: NavigationMapInteractionObserver
    View Source on GitHub
  • TopBannerViewControllerDelegate

    TopBannerViewControllerDelegate provides methods for reacting to the user interactions with TopBannerViewController. Such interactions include:

    • InstructionsBannerView swiping to the left, right, top and bottom.
    • StepTableViewCell selection.
    • Display or dismissal of StepsViewController, which shows list of remaining legs and steps.
    See more

    Declaration

    Swift

    public protocol TopBannerViewControllerDelegate : VisualInstructionDelegate
    View Source on GitHub
  • InstructionsCardViewController

    A view controller that displays the current maneuver instruction as a “card” resembling a user notification. A subsequent maneuver is always partially visible on one side of the view; swiping to one side reveals the full maneuver.

    This class is an alternative to the more traditional banner interface provided by the TopBannerViewController class. To use InstructionsCardViewController, create an instance of it and pass it into the NavigationOptions(styles:navigationService:voiceController:topBanner:bottomBanner:) method.

    See more

    Declaration

    Swift

    open class InstructionsCardViewController : UIViewController
    extension InstructionsCardViewController: UICollectionViewDelegate
    extension InstructionsCardViewController: UICollectionViewDataSource
    extension InstructionsCardViewController: UICollectionViewDelegateFlowLayout
    extension InstructionsCardViewController: NavigationComponent
    extension InstructionsCardViewController: InstructionsCardContainerViewDelegate
    extension InstructionsCardViewController: NavigationMapInteractionObserver
    View Source on GitHub
  • InstructionsCardContainerView

    A container view for the information currently displayed in InstructionsCardViewController.

    See more

    Declaration

    Swift

    public class InstructionsCardContainerView : StylableView, InstructionsCardContainerViewDelegate
    View Source on GitHub
  • InstructionsCardContainerViewDelegate

    The InstructionsCardContainerViewDelegate protocol defines methods that allow an object to customize presented visual instructions within the instructions container view.

    See more

    Declaration

    Swift

    public protocol InstructionsCardContainerViewDelegate : VisualInstructionDelegate
    View Source on GitHub
  • InstructionsBannerView

    A banner view that contains the current step instruction and responds to tap and swipe gestures.

    This class responds and gets updated as the user progresses along a route according to the NavigationComponent and BaseInstructionsBannerView protocol.

    See more

    Declaration

    Swift

    @IBDesignable
    open class InstructionsBannerView : BaseInstructionsBannerView, NavigationComponent
    View Source on GitHub
  • InstructionsBannerViewDelegate

    InstructionsBannerViewDelegate provides methods for reacting to user interactions in InstructionsBannerView.

    See more

    Declaration

    Swift

    public protocol InstructionsBannerViewDelegate : VisualInstructionDelegate
    View Source on GitHub
  • BaseInstructionsBannerView

    A banner view that contains the current step instruction along a route and responds to tap and swipe gestures, as the base of InstructionsCardView and InstructionsBannerView.

    See more

    Declaration

    Swift

    open class BaseInstructionsBannerView : UIControl
    View Source on GitHub
  • ManeuverView

    A view that contains a simple image indicating a type of maneuver.

    See more

    Declaration

    Swift

    @IBDesignable
    open class ManeuverView : UIView
    View Source on GitHub
  • JunctionView

    A junction view shows an image depicting the layout of a highway junction.

    As the user approaches certain junctions, an enlarged illustration of the junction appears in this view to help the user understand a complex maneuver. A junction view only appears when the relevant data is available.

    See more

    Declaration

    Swift

    public class JunctionView : UIImageView
    View Source on GitHub
  • GenericRouteShield

    GenericRouteShield is a class to render routes that do not have route-shields.

    Declaration

    Swift

    public class GenericRouteShield : StylableView
    View Source on GitHub
  • StepsViewControllerDelegate

    StepsViewControllerDelegate provides methods for user interactions in a StepsViewController.

    See more

    Declaration

    Swift

    public protocol StepsViewControllerDelegate : AnyObject
    View Source on GitHub
  • BottomBannerViewController

    A user interface element designed to display the estimated arrival time, distance, and time remaining, as well as give the user a control the cancel the navigation session.

    See more

    Declaration

    Swift

    @IBDesignable
    open class BottomBannerViewController : UIViewController, NavigationComponent
    View Source on GitHub
  • BottomBannerViewControllerDelegate

    BottomBannerViewControllerDelegate provides a method for reacting to the user tapping on the “cancel” button in the BottomBannerViewController.

    See more

    Declaration

    Swift

    public protocol BottomBannerViewControllerDelegate : AnyObject
    View Source on GitHub

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

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