Class: NavStatusBoxDtkAlert
A component that alerts when the waypoint is about to change.
Hierarchy
DisplayComponent<NavStatusBoxDtkAlertProps>↳
NavStatusBoxDtkAlert
Constructors
constructor
• new NavStatusBoxDtkAlert(props): NavStatusBoxDtkAlert
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | NavStatusBoxDtkAlertProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<NavStatusBoxDtkAlertProps>.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: NavStatusBoxDtkAlertProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:196
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/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:70
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
pause
▸ pause(): void
Pauses this component. This component will not update while it is paused.
Returns
void
Defined in
src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:91
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:177
resume
▸ resume(): void
Resumes this component. Once resumed, this component will automatically update.
Returns
void
Defined in
src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:80