Class: NavStatusBoxDtkAlert

Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:26

A component that alerts when the waypoint is about to change.

Extends

• DisplayComponent<NavStatusBoxDtkAlertProps>

Constructors

Constructor

new NavStatusBoxDtkAlert(props): NavStatusBoxDtkAlert

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	NavStatusBoxDtkAlertProps	The propertis of the component.

Returns

NavStatusBoxDtkAlert

Inherited from

DisplayComponent<NavStatusBoxDtkAlertProps>.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: NavStatusBoxDtkAlertProps & 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/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:196

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/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:70

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

---

pause()

pause(): void

Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:91

Pauses this component. This component will not update while it is paused.

Returns

void

---

render()

render(): VNode

Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:177

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

---

resume()

resume(): void

Defined in: src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxDtkAlert.tsx:80

Resumes this component. Once resumed, this component will automatically update.

Returns

void