CarPlay · IOS API REFERENCE

CPImageOverlay

class · iOS 26.4+ · SDK 27.1

@MainActor class CPImageOverlay

Members (7)

init · iOS 26.4+

init

TypeScript

static initImageAlignment(image: _UIKit_UIImage, alignment: CPImageOverlay_Alignment): Promise<CPImageOverlay>

Swift declaration

init(image: UIImage, alignment: CPImageOverlay.Alignment)

init · iOS 26.4+

init

TypeScript

static initTextTextColorBackgroundColorAlignment(text: string, textColor: _UIKit_UIColor, backgroundColor: _UIKit_UIColor, alignment: CPImageOverlay_Alignment): Promise<CPImageOverlay>

Swift declaration

init(text: String, textColor: UIColor, backgroundColor: UIColor, alignment: CPImageOverlay.Alignment)

get · iOS 26.4+

alignment

TypeScript

get alignment(): Promise<CPImageOverlay_Alignment>

Swift declaration

var alignment: CPImageOverlay.Alignment { get }

get · iOS 26.4+

backgroundColor

TypeScript

get backgroundColor(): Promise<(_UIKit_UIColor) | null>

Swift declaration

var backgroundColor: UIColor? { get }

get · iOS 26.4+

image

TypeScript

get image(): Promise<(_UIKit_UIImage) | null>

Swift declaration

var image: UIImage? { get }

get · iOS 26.4+

text

TypeScript

get text(): Promise<(string) | null>

Swift declaration

var text: String? { get }

get · iOS 26.4+

textColor

TypeScript

get textColor(): Promise<(_UIKit_UIColor) | null>

Swift declaration

var textColor: UIColor? { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CPImageOverlay.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All CarPlay types →