One Logo Pool Ball
X
Github
Discord

System

CarPlay · IOS API REFERENCE

CPMapTemplate

class · iOS 12.0+ · SDK 27.1

@MainActor class CPMapTemplate

Members (30)

method · iOS 12.0+

dismissNavigationAlert

TypeScript
dismissNavigationAlert(animated: boolean, completion: ((arg0: boolean) => void)): Promise<void>
Swift declaration
func dismissNavigationAlert(animated: Bool) async -> Bool
method · iOS 12.0+

dismissPanningInterface

TypeScript
dismissPanningInterface(animated: boolean): Promise<void>
Swift declaration
func dismissPanningInterface(animated: Bool)
method · iOS 27.0+

hidePanel

TypeScript
hidePanel(completion?: (((arg0: boolean, arg1: (NativeError) | null) => void)) | null): Promise<void>
Swift declaration
func hidePanel() async throws -> Bool
method · iOS 12.0+

hideTripPreviews

TypeScript
hideTripPreviews(): Promise<void>
Swift declaration
func hideTripPreviews()
init

init

TypeScript
static init(): Promise<CPMapTemplate>
Swift declaration
init()
method · iOS 27.0+

popPanel

TypeScript
popPanel(completion?: (((arg0: boolean, arg1: (NativeError) | null) => void)) | null): Promise<void>
Swift declaration
func popPanel() async throws -> Bool
method · iOS 12.0+

present

TypeScript
present(navigationAlert: CPNavigationAlert, animated: boolean): Promise<void>
Swift declaration
func present(navigationAlert: CPNavigationAlert, animated: Bool)
method · iOS 27.0+

pushPanel

TypeScript
pushPanel(panel: CPMapPanel, completion?: (((arg0: boolean, arg1: (NativeError) | null) => void)) | null): Promise<void>
Swift declaration
func pushPanel(_ panel: CPMapPanel) async throws -> Bool
method · iOS 27.0+

showPanel

TypeScript
showPanel(panel: CPMapPanel, completion?: (((arg0: boolean, arg1: (NativeError) | null) => void)) | null): Promise<void>
Swift declaration
func showPanel(_ panel: CPMapPanel) async throws -> Bool
method · iOS 12.0+

showPanningInterface

TypeScript
showPanningInterface(animated: boolean): Promise<void>
Swift declaration
func showPanningInterface(animated: Bool)
method · iOS 12.0+

showRouteChoicesPreview

TypeScript
showRouteChoicesPreview(tripPreview: CPTrip, textConfiguration?: (CPTripPreviewTextConfiguration) | null): Promise<void>
Swift declaration
func showRouteChoicesPreview(for tripPreview: CPTrip, textConfiguration: CPTripPreviewTextConfiguration?)
method · iOS 14.0+

showTripPreviews

TypeScript
showTripPreviewsSelectedTripTextConfiguration(tripPreviews: Array<CPTrip>, selectedTrip?: (CPTrip) | null, textConfiguration?: (CPTripPreviewTextConfiguration) | null): Promise<void>
Swift declaration
func showTripPreviews(_ tripPreviews: [CPTrip], selectedTrip: CPTrip?, textConfiguration: CPTripPreviewTextConfiguration?)
method · iOS 12.0+

showTripPreviews

TypeScript
showTripPreviewsTextConfiguration(tripPreviews: Array<CPTrip>, textConfiguration?: (CPTripPreviewTextConfiguration) | null): Promise<void>
Swift declaration
func showTripPreviews(_ tripPreviews: [CPTrip], textConfiguration: CPTripPreviewTextConfiguration?)
method · iOS 12.0+

startNavigationSession

TypeScript
startNavigationSession(trip: CPTrip): Promise<CPNavigationSession>
Swift declaration
func startNavigationSession(for trip: CPTrip) -> CPNavigationSession
method · iOS 12.0+

updateEstimates

TypeScript
updateEstimates(estimates: CPTravelEstimates, trip: CPTrip): Promise<void>
Swift declaration
func updateEstimates(_ estimates: CPTravelEstimates, for trip: CPTrip)
method · iOS 12.0+

update

TypeScript
update(estimates: CPTravelEstimates, trip: CPTrip, timeRemainingColor: CPTimeRemainingColor): Promise<void>
Swift declaration
func update(_ estimates: CPTravelEstimates, for trip: CPTrip, with timeRemainingColor: CPTimeRemainingColor)
get · iOS 12.0+

automaticallyHidesNavigationBar

TypeScript
get automaticallyHidesNavigationBar(): Promise<boolean>
Swift declaration
var automaticallyHidesNavigationBar: Bool { get set }
set · iOS 12.0+

automaticallyHidesNavigationBar

TypeScript
setAutomaticallyHidesNavigationBar(value: boolean): Promise<void>
Swift declaration
var automaticallyHidesNavigationBar: Bool { get set }
get · iOS 12.0+

currentNavigationAlert

TypeScript
get currentNavigationAlert(): Promise<(CPNavigationAlert) | null>
Swift declaration
var currentNavigationAlert: CPNavigationAlert? { get }
get · iOS 12.0+

guidanceBackgroundColor

TypeScript
get guidanceBackgroundColor(): Promise<_UIKit_UIColor>
Swift declaration
var guidanceBackgroundColor: UIColor { get set }
set · iOS 12.0+

guidanceBackgroundColor

TypeScript
setGuidanceBackgroundColor(value: _UIKit_UIColor): Promise<void>
Swift declaration
var guidanceBackgroundColor: UIColor { get set }
get · iOS 12.0+

hidesButtonsWithNavigationBar

TypeScript
get hidesButtonsWithNavigationBar(): Promise<boolean>
Swift declaration
var hidesButtonsWithNavigationBar: Bool { get set }
set · iOS 12.0+

hidesButtonsWithNavigationBar

TypeScript
setHidesButtonsWithNavigationBar(value: boolean): Promise<void>
Swift declaration
var hidesButtonsWithNavigationBar: Bool { get set }
get · iOS 12.0+

mapButtons

TypeScript
get mapButtons(): Promise<Array<CPMapButton>>
Swift declaration
var mapButtons: [CPMapButton] { get set }
set · iOS 12.0+

mapButtons

TypeScript
setMapButtons(value: Array<CPMapButton>): Promise<void>
Swift declaration
var mapButtons: [CPMapButton] { get set }
get · iOS 12.0+

mapDelegate

TypeScript
get mapDelegate(): Promise<(SDKHandle) | null>
Swift declaration
weak var mapDelegate: (any CPMapTemplateDelegate)? { get set }
set · iOS 12.0+

mapDelegate

TypeScript
setMapDelegate(value?: (Implements<CPMapTemplateDelegate> | SDKHandle) | null): Promise<void>
Swift declaration
weak var mapDelegate: (any CPMapTemplateDelegate)? { get set }
get · iOS 12.0+

isPanningInterfaceVisible

TypeScript
get isPanningInterfaceVisible(): Promise<boolean>
Swift declaration
var isPanningInterfaceVisible: Bool { get }
get · iOS 12.0+

tripEstimateStyle

TypeScript
get tripEstimateStyle(): Promise<CPTripEstimateStyle>
Swift declaration
var tripEstimateStyle: CPTripEstimateStyle { get set }
set · iOS 12.0+

tripEstimateStyle

TypeScript
setTripEstimateStyle(value: CPTripEstimateStyle): Promise<void>
Swift declaration
var tripEstimateStyle: CPTripEstimateStyle { get set }

Skipped declarations

No declarations were skipped in this snapshot.

All CarPlay types →