CarPlayMapViewController

open class CarPlayMapViewController : UIViewController

extension CarPlayMapViewController: StyleManagerDelegate

extension CarPlayMapViewController: NavigationMapViewDelegate

extension CarPlayMapViewController: CPSessionConfigurationDelegate

CarPlayMapViewController is responsible for administering the Mapbox map, the interface styles and the map template buttons to display on CarPlay.

Important

Loading CarPlayMapViewController view will start a Free Drive session by default. You can change default behavior using CarPlayMapViewController.startFreeDriveAutomatically property. For more information, see the “Pricing” guide.

UI Elements Configuration

delegate
The view controller’s delegate, that is used by the CarPlayManager.

Do not overwrite this property and use CarPlayManagerDelegate methods directly.
Declaration
Swift

public weak var delegate: CarPlayMapViewControllerDelegate?
View Source on GitHub
styleManager
Controls the styling of CarPlayMapViewController and its components.

The style can be modified programmatically by using StyleManager.applyStyle(type:).
Declaration
Swift

public private(set) var styleManager: StyleManager? { get }
View Source on GitHub
speedLimitView
A view that displays the current speed limit.
Declaration
Swift

public var speedLimitView: SpeedLimitView!
View Source on GitHub
wayNameView
A view that displays the current road name.
Declaration
Swift

public var wayNameView: WayNameView!
View Source on GitHub
userInfo
An optional metadata to be provided as initial value of NavigationEventsManager.userInfo property.
Declaration
Swift

public var userInfo: [String : String?]?
View Source on GitHub
startFreeDriveAutomatically
Controls whether CarPlayMapViewController starts a Free Drive session automatically on map load.

If you set this property to false, you can start a Free Drive session using CarPlayMapViewController.startFreeDriveNavigation() method.
Declaration
Swift

public var startFreeDriveAutomatically: Bool
View Source on GitHub

Bar Buttons Configuration

recenterButton
The map button for recentering the map view if a user action causes it to stop following the user.
Declaration
Swift

public lazy var recenterButton: CPMapButton { get set }
View Source on GitHub
zoomInButton
The map button for zooming in the current map view.
Declaration
Swift

public lazy var zoomInButton: CPMapButton { get set }
View Source on GitHub
zoomOutButton
The map button for zooming out the current map view.
Declaration
Swift

public lazy var zoomOutButton: CPMapButton { get set }
View Source on GitHub
panMapButton
The map button property for hiding or showing the pan map button.
Declaration
Swift

public internal(set) var panMapButton: CPMapButton? { get }
View Source on GitHub
dismissPanningButton
The map button property for exiting the pan map mode.
Declaration
Swift

public internal(set) var dismissPanningButton: CPMapButton? { get }
View Source on GitHub


                    
                    
                    panningInterfaceDisplayButton(for:)

Creates a new pan map button for the CarPlay map view controller.

Declaration

Swift

@discardableResult
public func panningInterfaceDisplayButton(for mapTemplate: CPMapTemplate) -> CPMapButton

Parameters


                                  mapTemplate

The map template available to the pan map button for display.

Return Value

CPMapButton instance.

View Source on GitHub


                    
                    
                    panningInterfaceDismissalButton(for:)

Creates a new close button to dismiss the visible panning buttons on the map.

Declaration

Swift

@discardableResult
public func panningInterfaceDismissalButton(for mapTemplate: CPMapTemplate) -> CPMapButton

Parameters


                                  mapTemplate

The map template available to the pan map button for display.

Return Value

CPMapButton instance.

View Source on GitHub

Initialization Methods


                    
                    
                    init(styles:)

Initializes a new CarPlay map view controller.

Declaration

Swift

public required init(styles: [Style])

Parameters


                                  styles

The interface styles initially available to the style manager for display.

View Source on GitHub


                    
                    
                    init(coder:)

Returns a CarPlayMapViewController object initialized from data in a given unarchiver.

Declaration

Swift

public required init?(coder decoder: NSCoder)

Parameters


                                  coder

An unarchiver object.

View Source on GitHub

startFreeDriveNavigation()
Starts a Free Drive session if it is not started already.

Free Drive session starts automatically on map load by default. You can change this behavior using CarPlayMapViewController.startFreeDriveAutomatically method.

Note
Paused Free Drive sessions are not resumed by this method.
Declaration
Swift

public func startFreeDriveNavigation()
View Source on GitHub

StyleManagerDelegate Methods


                    
                    
                    location(for:)

Declaration

Swift

public func location(for 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

NavigationMapViewDelegate Methods


                    
                    
                    navigationMapView(_:didAdd:pointAnnotationManager:)

Declaration

Swift

public func navigationMapView(_ navigationMapView: NavigationMapView,
                              didAdd finalDestinationAnnotation: PointAnnotation,
                              pointAnnotationManager: PointAnnotationManager)

View Source on GitHub


                    
                    
                    navigationMapView(_:routeLineLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

public func navigationMapView(_ navigationMapView: NavigationMapView,
                              routeLineLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> LineLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:routeCasingLineLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

public func navigationMapView(_ navigationMapView: NavigationMapView,
                              routeCasingLineLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> LineLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:routeRestrictedAreasLineLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

public func navigationMapView(_ navigationMapView: NavigationMapView,
                              routeRestrictedAreasLineLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> LineLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:willAdd:)

Declaration

Swift

public func navigationMapView(_ navigationMapView: NavigationMapView, willAdd layer: Layer) -> Layer?

View Source on GitHub