Skip to main content

Class: TerrainSystemAnnunciation

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

A Garmin terrain alerting system annunciation display.

Extends​

  • DisplayComponent<TerrainSystemAnnunciationProps>

Constructors​

Constructor​

new TerrainSystemAnnunciation(props): TerrainSystemAnnunciation

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsTerrainSystemAnnunciationPropsThe propertis of the component.

Returns​

TerrainSystemAnnunciation

Inherited from​

DisplayComponent<TerrainSystemAnnunciationProps>.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: TerrainSystemAnnunciationProps & ComponentProps

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

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

Returns​

void

Inherit Doc​

Overrides​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextneverThe context to get the subscription for.

Returns​

never

The requested context.

Throws​

An error if no data for the specified context type could be found.

Inherited from​

DisplayComponent.getContext


onAfterRender()​

onAfterRender(): void

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

Returns​

void

Inherit Doc​

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


render()​

render(): VNode

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

Returns​

VNode

Inherit Doc​

Overrides​

DisplayComponent.render