Skip to main content

Interface: TerrainSystemAnnunciationProps

Component props for TerrainSystemAnnunciation.

Hierarchy​

  • ComponentProps

    ↳ TerrainSystemAnnunciationProps

Properties​

alertDefs​

• Optional alertDefs: Readonly<Partial<Record<string, Readonly<TerrainSystemAnnunciationDef>>>>

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

Defined in​

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

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

ComponentProps.children

Defined in​

src/sdk/components/FSComponent.ts:122

class​

• Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

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

Defined in​

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

flashDuration​

• Optional flashDuration: number

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

Defined in​

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

inhibitDefs​

• Optional inhibitDefs: Readonly<Partial<Record<string, Readonly<TerrainSystemAnnunciationPriorityDef>>>>

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.

Defined in​

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

inhibitFlags​

• inhibitFlags: SubscribableSet<string>

The terrain system's active inhibit flags.

Defined in​

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

operatingMode​

• operatingMode: Subscribable<TerrainSystemOperatingMode>

The terrain system's operating mode.

Defined in​

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

prioritizedAlert​

• prioritizedAlert: Subscribable<null | string>

The terrain system's prioritized active alert.

Defined in​

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

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

ComponentProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125

show​

• show: boolean | Subscribable<boolean>

Whether to show the display.

Defined in​

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

statusDefs​

• Optional statusDefs: Readonly<Partial<Record<string, Readonly<TerrainSystemAnnunciationPriorityDef>>>>

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.

Defined in​

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

statusFlags​

• statusFlags: SubscribableSet<string>

The terrain system's active status flags.

Defined in​

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

testModeDef​

• Optional testModeDef: Readonly<TerrainSystemAnnunciationDef>

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.

Defined in​

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