Class: G3000CASDisplay

A G3000 scrolling CAS display which supports the event bus scroll commands defined by CASControlEvents.

Hierarchy

• CASDisplay<G3000CASDisplayProps>

  ↳ G3000CASDisplay

Constructors

constructor

• new G3000CASDisplay(props): G3000CASDisplay

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	G3000CASDisplayProps	The propertis of the component.

Returns

G3000CASDisplay

Inherited from

CASDisplay<G3000CASDisplayProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

CASDisplay.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

CASDisplay.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

controlEventsPub

• Protected Readonly controlEventsPub: Publisher<CASControlEvents>

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/CAS/CAS.tsx:23

---

controlEventsSub

• Protected Readonly controlEventsSub: EventSubscriber<CASControlEvents>

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/CAS/CAS.tsx:24

---

props

• props: G3000CASDisplayProps & ComponentProps

The properties of the component.

Inherited from

CASDisplay.props

Defined in

src/sdk/components/FSComponent.ts:61

---

topAlertIndex

• Protected topAlertIndex: number = 0

The index of the message that is currently displayed in the top (first) slot.

Inherited from

CASDisplay.topAlertIndex

Defined in

src/garminsdk/components/cas/CAS.tsx:68

Methods

addAnnunciation

▸ addAnnunciation(idx, item): void

Add an annunciation to the active list.

Parameters

Name	Type	Description
idx	number	The index of the annunciations array for the annunciation.
item	CasActiveMessage	The annunciation configuration to add

Returns

void

Inherited from

CASDisplay.addAnnunciation

Defined in

src/garminsdk/components/cas/CAS.tsx:181

---

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

CASDisplay.destroy

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/CAS/CAS.tsx:77

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	Type	Description
context	never	The 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

CASDisplay.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

handleScrollDownEnable

▸ handleScrollDownEnable(enabled): void

Handle a scroll down (en|dis)able event.

Parameters

Name	Type	Description
enabled	boolean	True to enable the control softkey, false to disable.

Returns

void

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/CAS/CAS.tsx:66

---

handleScrollUpEnable

▸ handleScrollUpEnable(enabled): void

Handle a scroll up (en|dis)able event.

Parameters

Name	Type	Description
enabled	boolean	True to enable the control softkey, false to disable.

Returns

void

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/CAS/CAS.tsx:58

---

onAfterRender

▸ onAfterRender(): void

Returns

void

Inherit Doc

Overrides

CASDisplay.onAfterRender

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/CAS/CAS.tsx:29

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

CASDisplay.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

removeAnnunciation

▸ removeAnnunciation(idx, item): void

Remove an annunciation from the active list if present.

Parameters

Name	Type	Description
idx	number	The index of the annunciations array for the annunciation.
item	CasActiveMessage	The item that's being removed.

Returns

void

Inherited from

CASDisplay.removeAnnunciation

Defined in

src/garminsdk/components/cas/CAS.tsx:211

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Inherited from

CASDisplay.render

Defined in

src/garminsdk/components/cas/CAS.tsx:356

---

scrollDown

▸ scrollDown(): void

Scroll the message window down.

Returns

void

Inherited from

CASDisplay.scrollDown

Defined in

src/garminsdk/components/cas/CAS.tsx:336

---

scrollUp

▸ scrollUp(): void

Scroll the message window up.

Returns

void

Inherited from

CASDisplay.scrollUp

Defined in

src/garminsdk/components/cas/CAS.tsx:347

---

subscribeForScollCommands

▸ subscribeForScollCommands(): void

Subscribe for scroll command events

Returns

void

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/CAS/CAS.tsx:71

---

updateDisplayedAnnunciations

▸ updateDisplayedAnnunciations(): void

Update the displayed divs with current annunciation status.

Returns

void

Inherited from

CASDisplay.updateDisplayedAnnunciations

Defined in

src/garminsdk/components/cas/CAS.tsx:275