CarPlay · IOS API REFERENCE

CPListImageRowItem

class · iOS 14.0+ · SDK 27.1

@MainActor class CPListImageRowItem

Members (22)

get · iOS 14.0+ · Deprecated in iOS 26.0

maximumImageSize

TypeScript

static get maximumImageSize(): Promise<{ width: number; height: number }>

Swift declaration

class var maximumImageSize: CGSize { get }

init · iOS 26.0+

init

TypeScript

static initTextCardElementsAllowsMultipleLines(text: (string) | null, elements: Array<CPListImageRowItemCardElement>, allowsMultipleLines: boolean): Promise<CPListImageRowItem>

Swift declaration

init(text: String?, cardElements elements: [CPListImageRowItemCardElement], allowsMultipleLines: Bool)

init · iOS 26.0+

init

TypeScript

static initTextCondensedElementsAllowsMultipleLines(text: (string) | null, elements: Array<CPListImageRowItemCondensedElement>, allowsMultipleLines: boolean): Promise<CPListImageRowItem>

Swift declaration

init(text: String?, condensedElements elements: [CPListImageRowItemCondensedElement], allowsMultipleLines: Bool)

init · iOS 26.0+

init

TypeScript

static initTextElementsAllowsMultipleLines(text: (string) | null, elements: Array<CPListImageRowItemRowElement>, allowsMultipleLines: boolean): Promise<CPListImageRowItem>

Swift declaration

init(text: String?, elements: [CPListImageRowItemRowElement], allowsMultipleLines: Bool)

init · iOS 26.0+

init

TypeScript

static initTextGridElementsAllowsMultipleLines(text: (string) | null, elements: Array<CPListImageRowItemGridElement>, allowsMultipleLines: boolean): Promise<CPListImageRowItem>

Swift declaration

init(text: String?, gridElements elements: [CPListImageRowItemGridElement], allowsMultipleLines: Bool)

init · iOS 26.0+

init

TypeScript

static initTextImageGridElementsAllowsMultipleLines(text: (string) | null, elements: Array<CPListImageRowItemImageGridElement>, allowsMultipleLines: boolean): Promise<CPListImageRowItem>

Swift declaration

init(text: String?, imageGridElements elements: [CPListImageRowItemImageGridElement], allowsMultipleLines: Bool)

init · iOS 14.0+ · Deprecated in iOS 26.0

init

TypeScript

static initTextImages(text: string, images: Array<_UIKit_UIImage>): Promise<CPListImageRowItem>

Swift declaration

init(text: String, images: [UIImage])

init · iOS 17.4+ · Deprecated in iOS 26.0

init

TypeScript

static initTextImagesImageTitles(text: string, images: Array<_UIKit_UIImage>, imageTitles: Array<string>): Promise<CPListImageRowItem>

Swift declaration

init(text: String, images: [UIImage], imageTitles: [String])

method · iOS 14.0+ · Deprecated in iOS 26.0

update

TypeScript

update(gridImages: Array<_UIKit_UIImage>): Promise<void>

Swift declaration

func update(_ gridImages: [UIImage])

get · iOS 26.0+

allowsMultipleLines

TypeScript

get allowsMultipleLines(): Promise<boolean>

Swift declaration

var allowsMultipleLines: Bool { get }

get · iOS 26.0+

elements

TypeScript

get elements(): Promise<Array<CPListImageRowItemElement>>

Swift declaration

var elements: [CPListImageRowItemElement] { get set }

set · iOS 26.0+

elements

TypeScript

setElements(value: Array<CPListImageRowItemElement>): Promise<void>

Swift declaration

var elements: [CPListImageRowItemElement] { get set }

get · iOS 15.0+

isEnabled

TypeScript

get isEnabled(): Promise<boolean>

Swift declaration

var isEnabled: Bool { get set }

set · iOS 15.0+

isEnabled

TypeScript

setIsEnabled(value: boolean): Promise<void>

Swift declaration

var isEnabled: Bool { get set }

get · iOS 14.0+ · Deprecated in iOS 26.0

gridImages

TypeScript

get gridImages(): Promise<Array<_UIKit_UIImage>>

Swift declaration

var gridImages: [UIImage] { get }

get · iOS 14.0+

handler

TypeScript

get handler(): Promise<(((arg0: SDKHandle, arg1: (() => void)) => Promise<void>)) | null>

Swift declaration

var handler: ((any CPSelectableListItem, @escaping () -> Void) -> Void)? { get set }

get · iOS 17.4+ · Deprecated in iOS 26.0

imageTitles

TypeScript

get imageTitles(): Promise<Array<string>>

Swift declaration

var imageTitles: [String] { get }

get · iOS 14.0+

listImageRowHandler

TypeScript

get listImageRowHandler(): Promise<(((arg0: CPListImageRowItem, arg1: number, arg2: (() => void)) => Promise<void>)) | null>

Swift declaration

var listImageRowHandler: ((CPListImageRowItem, Int, @escaping () -> Void) -> Void)? { get set }

get · iOS 14.0+

text

TypeScript

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

Swift declaration

var text: String? { get set }

set · iOS 14.0+

text

TypeScript

setText(value?: (string) | null): Promise<void>

Swift declaration

var text: String? { get set }

get · iOS 14.0+

userInfo

TypeScript

get userInfo(): Promise<(unknown) | null>

Swift declaration

var userInfo: Any? { get set }

set · iOS 14.0+

userInfo

TypeScript

setUserInfo(value?: (unknown) | null): Promise<void>

Swift declaration

var userInfo: Any? { get set }

Skipped declarations

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

CPListImageRowItem.handler

The iOS SDK compiler rejected this binding: converting non-escaping value to 'T' may allow it to escape

CPListImageRowItem.listImageRowHandler

The iOS SDK compiler rejected this binding: converting non-escaping value to 'T' may allow it to escape

CPListImageRowItem.init()

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

All CarPlay types →