Class: G3000CASDisplay

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:23

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

Deprecated

This class is no longer supported. Please use G3000CASDisplay2 instead.

Extends

• CASDisplay<G3000CASDisplayProps>

Constructors

Constructor

new G3000CASDisplay(props): G3000CASDisplay

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	G3000CASDisplayProps	The propertis of the component.

Returns

G3000CASDisplay

Inherited from

CASDisplay<G3000CASDisplayProps>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

CASDisplay.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

CASDisplay.contextType

---

controlEventsPub

protected readonly controlEventsPub: Publisher<CASControlEvents>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:24

---

controlEventsSub

protected readonly controlEventsSub: EventSubscriber<CASControlEvents>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:25

---

props

props: G3000CASDisplayProps & ComponentProps

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

The properties of the component.

Inherited from

CASDisplay.props

---

topAlertIndex

protected topAlertIndex: number = 0

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

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

Inherited from

CASDisplay.topAlertIndex

Methods

addAnnunciation()

protected addAnnunciation(idx, item): void

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

Add an annunciation to the active list.

Parameters

Parameter	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

---

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:78

Returns

void

Inherit Doc

Overrides

CASDisplay.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	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

---

handleScrollDownEnable()

protected handleScrollDownEnable(enabled): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:67

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

Parameters

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

Returns

void

---

handleScrollUpEnable()

protected handleScrollUpEnable(enabled): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:59

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

Parameters

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

Returns

void

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:30

Returns

void

Inherit Doc

Overrides

CASDisplay.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

CASDisplay.onBeforeRender

---

removeAnnunciation()

protected removeAnnunciation(idx, item): void

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

Remove an annunciation from the active list if present.

Parameters

Parameter	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

---

render()

render(): VNode

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

Returns

VNode

Inherit Doc

Inherited from

CASDisplay.render

---

scrollDown()

scrollDown(): void

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

Scroll the message window down.

Returns

void

Inherited from

CASDisplay.scrollDown

---

scrollUp()

scrollUp(): void

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

Scroll the message window up.

Returns

void

Inherited from

CASDisplay.scrollUp

---

subscribeForScollCommands()

protected subscribeForScollCommands(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/CAS/G3000CASDisplay.tsx:72

Subscribe for scroll command events

Returns

void

---

updateDisplayedAnnunciations()

protected updateDisplayedAnnunciations(): void

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

Update the displayed divs with current annunciation status.

Returns

void

Inherited from

CASDisplay.updateDisplayedAnnunciations