Class: CASDisplay<T>
A component for displaying CAS messages.
Type parameters
| Name | Type |
|---|---|
T | extends CASProps |
Hierarchy
DisplayComponent<T>↳
CASDisplay
Constructors
constructor
• new CASDisplay<T>(props): CASDisplay<T>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
T | extends CASProps |
Parameters
| Name | Type | Description |
|---|---|---|
props | T | The propertis of the component. |
Returns
CASDisplay<T>
Inherited from
DisplayComponent<T>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.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
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: T & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.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.
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
Defined in
src/garminsdk/components/cas/CAS.tsx:181
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/garminsdk/components/cas/CAS.tsx:364
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
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/garminsdk/components/cas/CAS.tsx:77
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.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
Defined in
src/garminsdk/components/cas/CAS.tsx:211
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/garminsdk/components/cas/CAS.tsx:356
scrollDown
▸ scrollDown(): void
Scroll the message window down.
Returns
void
Defined in
src/garminsdk/components/cas/CAS.tsx:336
scrollUp
▸ scrollUp(): void
Scroll the message window up.
Returns
void
Defined in
src/garminsdk/components/cas/CAS.tsx:347
updateDisplayedAnnunciations
▸ updateDisplayedAnnunciations(): void
Update the displayed divs with current annunciation status.
Returns
void
Defined in
src/garminsdk/components/cas/CAS.tsx:275