Class: CASDisplay<T>
Defined in: src/garminsdk/components/cas/CAS.tsx:58
A component for displaying CAS messages.
Extends
DisplayComponent
<T
>
Type Parameters
Type Parameter |
---|
T extends CASProps |
Constructors
Constructor
new CASDisplay<
T
>(props
):CASDisplay
<T
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | T | The propertis of the component. |
Returns
CASDisplay
<T
>
Inherited from
DisplayComponent<T>.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:
T
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.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.
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
destroy()
destroy():
void
Defined in: src/garminsdk/components/cas/CAS.tsx:364
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
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
DisplayComponent.getContext
onAfterRender()
onAfterRender():
void
Defined in: src/garminsdk/components/cas/CAS.tsx:77
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
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
render()
render():
VNode
Defined in: src/garminsdk/components/cas/CAS.tsx:356
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
scrollDown()
scrollDown():
void
Defined in: src/garminsdk/components/cas/CAS.tsx:336
Scroll the message window down.
Returns
void
scrollUp()
scrollUp():
void
Defined in: src/garminsdk/components/cas/CAS.tsx:347
Scroll the message window up.
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