NavigationViewController

NavigationViewController is a fully-featured user interface for turn-by-turn navigation. Do not confuse it with the NavigationController class in UIKit.

You initialize a navigation view controller based on a predefined Route and NavigationOptions. As the user progresses along the route, the navigation view controller shows their surroundings and the route line on a map. Banners above and below the map display key information pertaining to the route. A list of steps and a feedback mechanism are accessible via the navigation view controller.

To be informed of significant events and decision points as the user progresses along the route, set the NavigationService.delegate property of the NavigationService that you provide when creating the navigation options.

CarPlayNavigationViewController manages the corresponding user interface on a CarPlay screen.

  • A Route object constructed by MapboxDirections.

    In cases where you need to update the route after navigation has started you can set a new route here and NavigationViewController will update its UI accordingly.

  • An instance of Directions need for rerouting. See Mapbox Directions for further information.

  • An optional MGLMapCamera you can use to improve the initial transition from a previous viewport and prevent a trigger from an excessive significant location update.

  • An instance of MGLAnnotation representing the origin of your route.

  • The receiver’s delegate.

  • The voice controller that vocalizes spoken instructions along the route at the appropriate times.

  • The navigation service that coordinates the view controller’s nonvisual components, tracking the user’s location as they proceed along the route.

  • The main map view displayed inside the view controller.

    Note

    Do not change this map view’s NavigationMapView.navigationMapDelegate property; instead, implement the corresponding methods on NavigationViewControllerDelegate.

  • Determines whether the user location annotation is moved from the raw user location reported by the device to the nearest location along the route.

    By default, this property is set to true, causing the user location annotation to be snapped to the route.

  • Toggles sending of UILocalNotification upon upcoming steps when application is in the background. Defaults to true.

  • Shows a button that allows drivers to report feedback such as accidents, closed roads, poor instructions, etc. Defaults to true.

  • Shows End of route Feedback UI when the route controller arrives at the final destination. Defaults to true.

  • Shows the current speed limit on the map view.

    The default value of this property is true.

  • If true, the map style and UI will automatically be updated given the time of day.

  • If true, UIApplication.isIdleTimerDisabled is set to true in viewWillAppear(_:) and false in viewWillDisappear(_:). If your application manages the idle timer itself, set this property to false.

  • A Boolean value that determines whether the map annotates the locations at which instructions are spoken for debugging purposes.

  • Initializes a navigation view controller that presents the user interface for following a predefined route based on the given options.

    The route may come directly from the completion handler of the MapboxDirections.swift framework’s Directions.calculate(_:completionHandler:) method, or it may be unarchived or created from a JSON object.

Route controller notifications

RouteMapViewControllerDelegate

StyleManagerDelegate

TopBannerViewControllerDelegate

BottomBannerViewControllerDelegate

CarPlayConnectionObserver