Skip to main content

Interface: TerrainSystemAnnunciationProps

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:39

Component props for TerrainSystemAnnunciation.

Extends​

  • ComponentProps

Properties​

alertDefs?​

optional alertDefs: Readonly<Partial<Record<string, Readonly<TerrainSystemAnnunciationDef>>>>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:77

Definitions for displaying alert annunciations. If a definition is not provided for an alert, then no annunciation will be displayed for that alert.

children?​

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from​

ComponentProps.children

class?​

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:86

CSS class(es) to apply to the display's root element.

flashDuration?​

optional flashDuration: number

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:83

The duration, in milliseconds, for which the flashing state is applied after a new annunciation is displayed. Defaults to 5000.

inhibitDefs?​

optional inhibitDefs: Readonly<Partial<Record<string, Readonly<TerrainSystemAnnunciationPriorityDef>>>>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:71

Definitions for displaying inhibit flag annunciations. If a definition is not provided for a inhibit flag, then no annunciation will be displayed for that flag.

inhibitFlags​

inhibitFlags: SubscribableSet<string>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:50

The terrain system's active inhibit flags.

operatingMode​

operatingMode: Subscribable<TerrainSystemOperatingMode>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:44

The terrain system's operating mode.

prioritizedAlert​

prioritizedAlert: Subscribable<null | string>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:53

The terrain system's prioritized active alert.

ref?​

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from​

ComponentProps.ref

show​

show: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:41

Whether to show the display.

statusDefs?​

optional statusDefs: Readonly<Partial<Record<string, Readonly<TerrainSystemAnnunciationPriorityDef>>>>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:65

Definitions for displaying status flag annunciations. If a definition is not provided for a status flag, then no annunciation will be displayed for that flag.

statusFlags​

statusFlags: SubscribableSet<string>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:47

The terrain system's active status flags.

testModeDef?​

optional testModeDef: Readonly<TerrainSystemAnnunciationDef>

Defined in: src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:59

A definition for displaying a test mode annunciation. If not defined, then an annunciation will not be displayed when the terrain system is in test mode.