TypeScript API
Placelistnavigationtemplate

Class: PlaceListNavigationTemplate

A template that supports showing a list of places alongside a custom drawn map. The template itself does not expose a drawing surface. In order to draw on the canvas, use setSurfaceCallback. Template Restrictions In regards to template refreshes, as described in onGetTemplate, this template is considered a refresh of a previous one if:

  • The previous template is in a loading state (see setLoading, or
  • The template title has not changed, and the number of rows and the title (not counting spans) of each row between the previous and new ItemLists have not changed.
  • The template is sent in response to a user-initiated content refresh request. (see setOnContentRefreshListener. In order to use this template your car app MUST declare that it uses the androidx.car.app.NAVIGATION_TEMPLATES permission in the manifest.

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new PlaceListNavigationTemplate(config): PlaceListNavigationTemplate

Parameters

NameType
configPlaceListNavigationTemplateConfig

Returns

PlaceListNavigationTemplate

Inherited from

AndroidNavigationBaseTemplate<PlaceListNavigationTemplateConfig>.constructor

Defined in

packages/react-native-carplay/src/templates/android/AndroidNavigationBaseTemplate.ts:27 (opens in a new tab)

Properties

config

config: PlaceListNavigationTemplateConfig

Inherited from

AndroidNavigationBaseTemplate.config

Defined in

packages/react-native-carplay/src/templates/android/AndroidNavigationBaseTemplate.ts:27 (opens in a new tab)


id

id: string

Inherited from

AndroidNavigationBaseTemplate.id

Defined in

packages/react-native-carplay/src/templates/Template.ts:86 (opens in a new tab)

Accessors

eventMap

get eventMap(): Object

Returns

Object

NameType
didDismissPanningInterfacestring
didShowPanningInterfacestring

Inherited from

AndroidNavigationBaseTemplate.eventMap

Defined in

packages/react-native-carplay/src/templates/android/AndroidNavigationBaseTemplate.ts:20 (opens in a new tab)


type

get type(): string

Returns

string

Overrides

AndroidNavigationBaseTemplate.type

Defined in

packages/react-native-carplay/src/templates/android/PlaceListNavigationTemplate.ts:54 (opens in a new tab)

Methods

parseConfig

parseConfig(config): any

Parameters

NameType
configany

Returns

any

Inherited from

AndroidNavigationBaseTemplate.parseConfig

Defined in

packages/react-native-carplay/src/templates/Template.ts:147 (opens in a new tab)


updateTemplate

updateTemplate(config): void

Parameters

NameType
configP

Returns

void

Inherited from

AndroidNavigationBaseTemplate.updateTemplate

Defined in

packages/react-native-carplay/src/templates/Template.ts:141 (opens in a new tab)