NavigationViewController

@objc(MBNavigationViewController)
open class NavigationViewController : UIViewController

NavigationViewController is fully featured, turn by turn navigation UI.

It provides step by step instructions, an overview of all steps for the given route and support for basic styling.

route
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.
Declaration
Swift

@objc public var route: Route! { get set }
View Source on GitHub
directions
An instance of Directions need for rerouting. See Mapbox Directions for further information.
Declaration
Swift

@objc public var directions: Directions!
View Source on GitHub
pendingCamera
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.
Declaration
Swift

@objc public var pendingCamera: MGLMapCamera?
View Source on GitHub
origin
An instance of MGLAnnotation representing the origin of your route.
Declaration
Swift

@objc public var origin: MGLAnnotation?
View Source on GitHub
delegate
The receiver’s delegate.
Declaration
Swift

@objc public weak var delegate: NavigationViewControllerDelegate?
View Source on GitHub
voiceController
Provides access to various speech synthesizer options.

See RouteVoiceController for more information.
Declaration
Swift

@objc public lazy var voiceController: RouteVoiceController? { get set }
View Source on GitHub
routeController
Provides all routing logic for the user.

See RouteController for more information.
Declaration
Swift

@objc public var routeController: RouteController! { get set }
View Source on GitHub
mapView
The main map view displayed inside the view controller.

Note
Do not change this map view’s delegate.
Declaration
Swift

@objc public var mapView: NavigationMapView? { get }
View Source on GitHub
snapsUserLocationAnnotationToRoute
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

@objc public var snapsUserLocationAnnotationToRoute: Bool
View Source on GitHub
sendsNotifications
Toggles sending of UILocalNotification upon upcoming steps when application is in the background. Defaults to true.
Declaration
Swift

@objc public var sendsNotifications: Bool
View Source on GitHub
showsReportFeedback
Shows a button that allows drivers to report feedback such as accidents, closed roads, poor instructions, etc. Defaults to true.
Declaration
Swift

@objc public var showsReportFeedback: Bool { get set }
View Source on GitHub
showsEndOfRouteFeedback
Shows End of route Feedback UI when the route controller arrives at the final destination. Defaults to true.
Declaration
Swift

@objc public var showsEndOfRouteFeedback: Bool { get set }
View Source on GitHub
automaticallyAdjustsStyleForTimeOfDay
If true, the map style and UI will automatically be updated given the time of day.
Declaration
Swift

@objc public var automaticallyAdjustsStyleForTimeOfDay: Bool { get set }
View Source on GitHub
annotatesSpokenInstructions
A Boolean value that determines whether the map annotates the locations at which instructions are spoken for debugging purposes.
Declaration
Swift

@objc public var annotatesSpokenInstructions: Bool
View Source on GitHub


                    
                    
                    init(for:directions:styles:locationManager:)

Initializes a NavigationViewController that provides turn by turn navigation for the given route. A optional direction object is needed for potential rerouting.

See Mapbox Directions for further information.

Declaration

Swift

@objc(initWithRoute:directions:styles:locationManager:)
required public init(for route: Route,
                     directions: Directions = Directions.shared,
                     styles: [Style]? = [DayStyle(), NightStyle()],
                     locationManager: NavigationLocationManager? = NavigationLocationManager())

View Source on GitHub

RouteMapViewControllerDelegate


                    
                    
                    navigationMapView(_:routeCasingStyleLayerWithIdentifier:source:)

Declaration

Swift

public func navigationMapView(_ mapView: NavigationMapView, routeCasingStyleLayerWithIdentifier identifier: String, source: MGLSource) -> MGLStyleLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:routeStyleLayerWithIdentifier:source:)

Declaration

Swift

public func navigationMapView(_ mapView: NavigationMapView, routeStyleLayerWithIdentifier identifier: String, source: MGLSource) -> MGLStyleLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:didSelect:)

Declaration

Swift

public func navigationMapView(_ mapView: NavigationMapView, didSelect route: Route)

View Source on GitHub


                    
                    
                    navigationMapView(_:shapeFor:)

Declaration

Swift

@objc
public func navigationMapView(_ mapView: NavigationMapView, shapeFor routes: [Route]) -> MGLShape?

View Source on GitHub


                    
                    
                    navigationMapView(_:simplifiedShapeFor:)

Declaration

Swift

@objc
public func navigationMapView(_ mapView: NavigationMapView, simplifiedShapeFor route: Route) -> MGLShape?

View Source on GitHub


                    
                    
                    navigationMapView(_:waypointStyleLayerWithIdentifier:source:)

Declaration

Swift

public func navigationMapView(_ mapView: NavigationMapView, waypointStyleLayerWithIdentifier identifier: String, source: MGLSource) -> MGLStyleLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:waypointSymbolStyleLayerWithIdentifier:source:)

Declaration

Swift

public func navigationMapView(_ mapView: NavigationMapView, waypointSymbolStyleLayerWithIdentifier identifier: String, source: MGLSource) -> MGLStyleLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:shapeFor:legIndex:)

Declaration

Swift

@objc
public func navigationMapView(_ mapView: NavigationMapView, shapeFor waypoints: [Waypoint], legIndex: Int) -> MGLShape?

View Source on GitHub


                    
                    
                    navigationMapView(_:imageFor:)

Declaration

Swift

@objc
public func navigationMapView(_ mapView: MGLMapView, imageFor annotation: MGLAnnotation) -> MGLAnnotationImage?

View Source on GitHub


                    
                    
                    navigationMapView(_:viewFor:)

Declaration

Swift

@objc
public func navigationMapView(_ mapView: MGLMapView, viewFor annotation: MGLAnnotation) -> MGLAnnotationView?

View Source on GitHub


                    
                    
                    navigationMapViewUserAnchorPoint(_:)

Declaration

Swift

public func navigationMapViewUserAnchorPoint(_ mapView: NavigationMapView) -> CGPoint

View Source on GitHub


                    
                    
                    label(_:willPresent:as:)

Declaration

Swift

@objc
public func label(_ label: InstructionLabel, willPresent instruction: VisualInstruction, as presented: NSAttributedString) -> NSAttributedString?

View Source on GitHub

RouteControllerDelegate


                    
                    
                    routeController(_:shouldRerouteFrom:)

Declaration

Swift

@objc
public func routeController(_ routeController: RouteController, shouldRerouteFrom location: CLLocation) -> Bool

View Source on GitHub


                    
                    
                    routeController(_:willRerouteFrom:)

Declaration

Swift

@objc
public func routeController(_ routeController: RouteController, willRerouteFrom location: CLLocation)

View Source on GitHub


                    
                    
                    routeController(_:didRerouteAlong:)

Declaration

Swift

@objc
public func routeController(_ routeController: RouteController, didRerouteAlong route: Route)

View Source on GitHub


                    
                    
                    routeController(_:didFailToRerouteWith:)

Declaration

Swift

@objc
public func routeController(_ routeController: RouteController, didFailToRerouteWith error: Error)

View Source on GitHub


                    
                    
                    routeController(_:shouldDiscard:)

Declaration

Swift

@objc
public func routeController(_ routeController: RouteController, shouldDiscard location: CLLocation) -> Bool

View Source on GitHub


                    
                    
                    routeController(_:didUpdate:)

Declaration

Swift

@objc
public func routeController(_ routeController: RouteController, didUpdate locations: [CLLocation])

View Source on GitHub


                    
                    
                    routeController(_:didArriveAt:)

Declaration

Swift

@objc
public func routeController(_ routeController: RouteController, didArriveAt waypoint: Waypoint) -> Bool

View Source on GitHub

RouteControllerDelegate


                    
                    
                    tunnelIntersectionManager(_:willEnableAnimationAt:)

Declaration

Swift

public func tunnelIntersectionManager(_ manager: TunnelIntersectionManager, willEnableAnimationAt location: CLLocation)

View Source on GitHub


                    
                    
                    tunnelIntersectionManager(_:willDisableAnimationAt:)

Declaration

Swift

public func tunnelIntersectionManager(_ manager: TunnelIntersectionManager, willDisableAnimationAt location: CLLocation)

View Source on GitHub

RouteControllerDelegate


                    
                    
                    locationFor(styleManager:)

Declaration

Swift

public func locationFor(styleManager: StyleManager) -> CLLocation?

View Source on GitHub


                    
                    
                    styleManager(_:didApply:)

Declaration

Swift

public func styleManager(_ styleManager: StyleManager, didApply style: Style)

View Source on GitHub


                    
                    
                    styleManagerDidRefreshAppearance(_:)

Declaration

Swift

public func styleManagerDidRefreshAppearance(_ styleManager: StyleManager)

View Source on GitHub