Install in Dash
NavigationViewController Class Reference
NavigationViewController
open class NavigationViewController : UIViewController, NavigationStatusPresenter, NavigationViewData, BuildingHighlightingextension NavigationViewController: NavigationMapViewDelegateextension NavigationViewController: NavigationServiceDelegateextension NavigationViewController: StyleManagerDelegateextension NavigationViewController: TopBannerViewControllerDelegateextension NavigationViewController: BottomBannerViewControllerDelegateextension NavigationViewController: CarPlayConnectionObserverNavigationViewController 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 RouteResponse 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.
Route initialization should be configured before view controller’s view is loaded. Usually, that is automatically done during any of the inits, but you may also change this settings via prepareViewLoading(routeResponse:, routeIndex:, routeOptions:, navigationOptions:) methods. For example that could be handy while configuring a ViewController for a UIStoryboardSegue.
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.
Important
Creating an instance of this type with parameters that usesRouteController with will start an Active
Guidance session. The trip session is stopped when the instance is deallocated. For more info read the
Pricing Guide.
-
The
NavigationMapViewdisplayed inside the view controller.Note
Do not changeNavigationMapView.delegateproperty; instead, implement the corresponding methods onNavigationViewControllerDelegate.Declaration
Swift
@objc public var navigationMapView: NavigationMapView? { get set } -
NavigationView, that is displayed inside the view controller.Declaration
Swift
public var navigationView: NavigationView { get } -
Controls whether the main route style layer and its casing disappears as the user location puck travels over it. Defaults to
false.If
true, the part of the route that has been traversed will be rendered with full transparency, to give the illusion of a disappearing route. To customize the color that appears on the traversed section of a route, override thetraversedRouteColorproperty for theNavigationMapView.appearance().Declaration
Swift
public var routeLineTracksTraversal: Bool { get set } -
A Boolean value that determines whether the map annotates the intersections on current step during active navigation.
If
true, the map would display an icon of a traffic control device on the intersection, such as traffic signal, stop sign, yield sign, or railroad crossing. Defaults totrue.Declaration
Swift
public var annotatesIntersectionsAlongRoute: Bool { get set } -
Toggles displaying alternative routes.
If enabled, view will draw actual alternative route lines on the map. Default value is
true.Declaration
Swift
public var showsContinuousAlternatives: Bool { get set } -
AlternativeRoutes user might take during this trip to reach the destination using another road.Array contents are updated automatically duting the trip. Alternative routes may be slower or longer then the main route. To get updates, subscribe to
NavigationViewControllerDelegate.navigationViewController(_:didUpdateAlternatives:removedAlternatives:)orNotification.Name.routeControllerDidUpdateAlternativesnotification.Declaration
Swift
public var continuousAlternatives: [AlternativeRoute] { get }
View Source on GitHub
-
The voice controller that vocalizes spoken instructions along the route at the appropriate times.
Declaration
Swift
public var voiceController: RouteVoiceController! -
A Boolean value that determines whether the map annotates the locations at which instructions are spoken for debugging purposes.
Defaults to
false.Declaration
Swift
public var annotatesSpokenInstructions: Bool { get set } -
Controls whether night style will be used whenever traversing through a tunnel. Defaults to
true.Declaration
Swift
public var usesNightStyleWhileInTunnel: Bool
-
The
NavigationOptionsobject, which is used for the navigation session.Declaration
Swift
public var navigationOptions: NavigationOptions? -
The route options used to get the route.
Declaration
Swift
public var routeOptions: RouteOptions? { get }
-
A
RouteResponseobject constructed by MapboxDirections along with route index in it.In cases where you need to update the route after navigation has started, you can set a new route using
Router.updateRoute(with:routeOptions:completion:)method inNavigationViewController.navigationService.routerandNavigationViewControllerwill update its UI accordingly.For example:
- If you update route with the same waypoints as the current one:
swift navigationViewController.navigationService.router.updateRoute(with: indexedRouteResponse, routeOptions: nil, completion: nil) - In case you update route with different set of waypoints:
swift navigationViewController.navigationService.router.updateRoute(with: indexedRouteResponse, routeOptions: newRouteOptions, completion: nil)
Declaration
Swift
public var indexedRouteResponse: IndexedRouteResponse { get } - If you update route with the same waypoints as the current one:
-
A
Routeobject constructed by MapboxDirections.Declaration
Swift
public var route: Route? { get } -
Current
RouteResponseobject, as provided by MapboxDirections.Declaration
Swift
public var routeResponse: RouteResponse { get } -
The index of the route within the original
RouteResponseobject.Declaration
Swift
public var routeIndex: Int? { get } -
A reference to a MapboxDirections service. Used for rerouting.
Declaration
Swift
@available(*, deprecated, message: "Use `navigationService.routingProvider` instead. If navigation service was not initialized using `Directions` object - this property is unused and ignored.") public var directions: Directions { get } -
The navigation service that coordinates the view controller’s nonvisual components, tracking the user’s location as they proceed along the route.
Declaration
Swift
private(set) public var navigationService: NavigationService! { get set } -
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.Declaration
Swift
public var snapsUserLocationAnnotationToRoute: Bool -
Toggles sending of UILocalNotification upon upcoming steps when application is in the background. Defaults to
true.Declaration
Swift
public var sendsNotifications: Bool
-
The receiver’s delegate.
Declaration
Swift
public weak var delegate: NavigationViewControllerDelegate? -
If
true,UIApplication.isIdleTimerDisabledis set totrueinviewWillAppear(_:)andfalseinviewWillDisappear(_:). If your application manages the idle timer itself, set this property tofalse.Declaration
Swift
public var shouldManageApplicationIdleTimer: Bool { get set } -
Initializes a
NavigationViewControllerthat 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 framework’s
Directions.calculate(_:completionHandler:)method, MapboxCoreNavigationMapboxRoutingProvider.calculateRoutes(options:completionHandler:), or it may be unarchived or created from a JSON object.Declaration
Swift
@available(*, deprecated, renamed: "init(for:navigationOptions:﹚") required public init(for routeResponse: RouteResponse, routeIndex: Int, routeOptions: RouteOptions, navigationOptions: NavigationOptions? = nil)Parameters
routeResponseRouteResponseobject, containing selection of routes to follow.routeIndexThe index of the route within the original
RouteResponseobject.routeOptionsThe route options used to get the route.
navigationOptionsThe navigation options to use for the navigation session.
-
Initializes a
NavigationViewControllerthat 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 framework’sDirections.calculate(_:completionHandler:)method, MapboxCoreNavigationMapboxRoutingProvider.calculateRoutes(options:completionHandler:), or it may be unarchived or created from a JSON object.Declaration
Swift
required public init(for indexedRouteResponse: IndexedRouteResponse, navigationOptions: NavigationOptions? = nil)Parameters
routeResponseIndexedRouteResponseobject, containing selection of routes to follow.navigationOptionsThe navigation options to use for the navigation session.
-
Initializes a
NavigationViewControllerthat 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 framework’sDirections.calculateRoutes(matching:completionHandler:)method, MapboxCoreNavigationMapboxRoutingProvider.calculateRoutes(options:completionHandler:), or it may be unarchived or created from a JSON object.Declaration
Swift
required public convenience init(for mapMatchingResponse: MapMatchingResponse, routeIndex: Int, navigationOptions: NavigationOptions? = nil) throwsParameters
mapMatchingResponseMapMatchingResponseobject, containing selection of routes to follow.routeIndexThe index of the route within the original
RouteResponseobject.navigationOptionsThe navigation options to use for the navigation session.
-
Initializes a
NavigationViewControllerwith the given route and navigation service.Declaration
Swift
public convenience init(navigationService service: NavigationService)Parameters
navigationServiceThe navigation service that manages navigation along the route. Route data and options will be extracted from this instance.
-
Shows a Status for a specified amount of time.
Declaration
Swift
public func show(_ status: StatusView.Status) -
Hides a given Status without hiding the status view.
Declaration
Swift
public func hide(_ status: StatusView.Status) -
Updates key settings before loading the view.
This method basically re-runs the setup which takes place in
init. It could be useful if some of the attributes have changed beforeNavigationViewControllerdid load it’s view, or if you did not have access to initializing logic. For example, as a part ofUIStoryboardSegueconfiguration.Declaration
Swift
@available(*, deprecated, renamed: "prepareViewLoading(indexedRouteResponse:navigationOptions:﹚") public func prepareViewLoading(routeResponse: RouteResponse, routeIndex: Int, routeOptions: RouteOptions, navigationOptions: NavigationOptions? = nil) -> BoolParameters
routeResponseRouteResponseobject, containing selection of routes to follow.routeIndexThe index of the route within the original
RouteResponseobject.routeOptionsThe route options used to get the route.
navigationOptionsThe navigation options to use for the navigation session.
-
Updates key settings before loading the view.
This method basically re-runs the setup which takes place in
init. It could be useful if some of the attributes have changed beforeNavigationViewControllerdid load it’s view, or if you did not have access to initializing logic. For example, as a part ofUIStoryboardSegueconfiguration.Declaration
Swift
public func prepareViewLoading(indexedRouteResponse: IndexedRouteResponse, navigationOptions: NavigationOptions? = nil) -> BoolParameters
indexedRouteResponseIndexedRouteResponseobject, containing selection of routes to follow.navigationOptionsThe navigation options to use for the navigation session.
-
Shows a button that allows drivers to report feedback such as accidents, closed roads, poor instructions, etc. Defaults to
true.Declaration
Swift
public var showsReportFeedback: Bool { get set } -
Shows End of route Feedback UI when the route controller arrives at the final destination.
Defaults to
true.Declaration
Swift
public var showsEndOfRouteFeedback: Bool { get set } -
Shows the current speed limit on the map view.
The default value of this property is
true.Declaration
Swift
public var showsSpeedLimits: Bool { get set } -
Controls whether or not the FeedbackViewController shows a second level of detail for feedback items.
Defaults to
false.Declaration
Swift
public var detailedFeedbackEnabled: Bool { get set } -
The position of floating buttons in a navigation view. The default value is
MapOrnamentPosition.topTrailing.Declaration
Swift
open var floatingButtonsPosition: MapOrnamentPosition? { get set } -
The floating buttons in an array of UIButton in navigation view. The default floating buttons include the overview, mute and feedback report button. The default type of the floatingButtons is
FloatingButton, which is declared withFloatingButton.rounded(image:selectedImage:size:)to be consistent.Declaration
Swift
open var floatingButtons: [UIButton]? { get set }
-
If true, the map style and UI will automatically be updated given the time of day.
Declaration
Swift
public var automaticallyAdjustsStyleForTimeOfDay: Bool { get set } -
Allows to control highlighting of the destination building on arrival. By default destination buildings will not be highlighted.
Declaration
Swift
public var waypointStyle: WaypointStyle -
Controls whether night style will be used whenever dark mode is enabled. Defaults to
false.Declaration
Swift
public var usesNightStyleInDarkMode: Bool -
Controls the styling of NavigationViewController and its components.
The style can be modified programmatically by using
StyleManager.applyStyle(type:).Declaration
Swift
public private(set) var styleManager: StyleManager! { get }
-
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, routeLineLayerWithIdentifier identifier: String, sourceIdentifier: String) -> LineLayer? -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, routeCasingLineLayerWithIdentifier identifier: String, sourceIdentifier: String) -> LineLayer? -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, routeRestrictedAreasLineLayerWithIdentifier identifier: String, sourceIdentifier: String) -> LineLayer? -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, willAdd layer: Layer) -> Layer? -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, waypointCircleLayerWithIdentifier identifier: String, sourceIdentifier: String) -> CircleLayer? -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, waypointSymbolLayerWithIdentifier identifier: String, sourceIdentifier: String) -> SymbolLayer? -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, shapeFor waypoints: [Waypoint], legIndex: Int) -> FeatureCollection? -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, didAdd finalDestinationAnnotation: PointAnnotation, pointAnnotationManager: PointAnnotationManager) -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, didSelect waypoint: Waypoint) -
Declaration
Swift
public func navigationMapView(_ navigationMapView: NavigationMapView, didSelect continuousAlternative: AlternativeRoute)
-
Declaration
Swift
public func navigationService(_ service: NavigationService, shouldRerouteFrom location: CLLocation) -> Bool -
Declaration
Swift
public func navigationService(_ service: NavigationService, shouldProactivelyRerouteFrom location: CLLocation, to route: Route, completion: @escaping () -> Void) -
Declaration
Swift
public func navigationService(_ service: NavigationService, willRerouteFrom location: CLLocation) -
Declaration
Swift
public func navigationService(_ service: NavigationService, modifiedOptionsForReroute options: RouteOptions) -> RouteOptions -
Declaration
Swift
public func navigationService(_ service: NavigationService, didRerouteAlong route: Route, at location: CLLocation?, proactive: Bool) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didFailToRerouteWith error: Error) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didRefresh routeProgress: RouteProgress) -
Declaration
Swift
public func navigationServiceDidFailToRefreshExpiredRoute(_ service: any NavigationService) -
Declaration
Swift
public func navigationService(_ service: NavigationService, shouldDiscard location: CLLocation) -> Bool -
Declaration
Swift
public func navigationService(_ service: NavigationService, didUpdate progress: RouteProgress, with location: CLLocation, rawLocation: CLLocation) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didPassSpokenInstructionPoint instruction: SpokenInstruction, routeProgress: RouteProgress) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didPassVisualInstructionPoint instruction: VisualInstructionBanner, routeProgress: RouteProgress) -
Declaration
Swift
public func navigationService(_ service: NavigationService, willArriveAt waypoint: Waypoint, after remainingTimeInterval: TimeInterval, distance: CLLocationDistance) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didArriveAt waypoint: Waypoint) -> Bool -
Declaration
Swift
public func navigationService(_ service: NavigationService, willBeginSimulating progress: RouteProgress, becauseOf reason: SimulationIntent) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didBeginSimulating progress: RouteProgress, becauseOf reason: SimulationIntent) -
Declaration
Swift
public func navigationService(_ service: NavigationService, willEndSimulating progress: RouteProgress, becauseOf reason: SimulationIntent) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didEndSimulating progress: RouteProgress, becauseOf reason: SimulationIntent) -
Declaration
Swift
public func navigationService(_ service: NavigationService, shouldPreventReroutesWhenArrivingAt waypoint: Waypoint) -> Bool -
Declaration
Swift
public func navigationServiceShouldDisableBatteryMonitoring(_ service: NavigationService) -> Bool -
Declaration
Swift
public func navigationServiceDidChangeAuthorization(_ service: NavigationService, didChangeAuthorizationFor locationManager: CLLocationManager) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didUpdateAlternatives updatedAlternatives: [AlternativeRoute], removedAlternatives: [AlternativeRoute]) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didFailToUpdateAlternatives error: AlternativeRouteError) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didSwitchToCoincidentOnlineRoute coincideRoute: Route) -
Declaration
Swift
public func navigationService(_ service: NavigationService, willTakeAlternativeRoute route: Route, at location: CLLocation?) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didTakeAlternativeRouteAt location: CLLocation?) -
Declaration
Swift
public func navigationService(_ service: NavigationService, didFailToTakeAlternativeRouteAt location: CLLocation?)
-
Declaration
Swift
public func location(for styleManager: StyleManager) -> CLLocation? -
Declaration
Swift
public func styleManager(_ styleManager: StyleManager, didApply style: Style) -
Declaration
Swift
public func styleManagerDidRefreshAppearance(_ styleManager: StyleManager)
-
Declaration
Swift
public func topBanner(_ banner: TopBannerViewController, didSwipeInDirection direction: UISwipeGestureRecognizer.Direction) -
Declaration
Swift
public func topBanner(_ banner: TopBannerViewController, didSelect legIndex: Int, stepIndex: Int, cell: StepTableViewCell) -
Declaration
Swift
public func topBanner(_ banner: TopBannerViewController, didDisplayStepsController: StepsViewController) -
Declaration
Swift
public func label(_ label: InstructionLabel, willPresent instruction: VisualInstruction, as presented: NSAttributedString) -> NSAttributedString?
-
Declaration
Swift
public func didTapCancel(_ sender: Any)
-
Declaration
Swift
public func didConnectToCarPlay() -
Declaration
Swift
public func didDisconnectFromCarPlay()