Class: CasDisplay2
Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:108
A scrolling CAS display.
Extends
DisplayComponent
<CasDisplay2Props
>
Constructors
Constructor
new CasDisplay2(
props
):CasDisplay2
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | CasDisplay2Props | The propertis of the component. |
Returns
CasDisplay2
Inherited from
DisplayComponent<CasDisplay2Props>.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:
CasDisplay2Props
&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/cas/CasDisplay2.tsx:555
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/CasDisplay2.tsx:136
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/cas/CasDisplay2.tsx:534
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
scrollDown()
scrollDown(
delta
):void
Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:174
Scrolls this display's scrollable messages down.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
delta | number | 1 | The number of slots to scroll down. |
Returns
void
scrollTo()
scrollTo(
pos
):void
Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:154
Scrolls this display's scrollable messages to a specific position.
Parameters
Parameter | Type | Description |
---|---|---|
pos | number | The position to which to scroll. A value of 0 indicates that the first scrollable message is displayed in the first scrollable message slot, 1 indicates that the second scrollable message is displayed in the first scrollable message slot, and so on. |
Returns
void
scrollUp()
scrollUp(
delta
):void
Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:166
Scrolls this display's scrollable messages up.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
delta | number | 1 | The number of slots to scroll up. |
Returns
void