Class: HorizonDisplay

Defined in: src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:345

A next-generation (NXi, G3000, etc) Garmin PFD horizon display. Includes an artificial horizon, attitude indicator, aircraft symbol, flight director, and synthetic vision technology (SVT) display.

Extends

• DisplayComponent<HorizonDisplayProps>

Constructors

Constructor

new HorizonDisplay(props): HorizonDisplay

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	HorizonDisplayProps	The propertis of the component.

Returns

HorizonDisplay

Inherited from

DisplayComponent<HorizonDisplayProps>.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: HorizonDisplayProps & 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/horizon/HorizonDisplay.tsx:1076

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/horizon/HorizonDisplay.tsx:604

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

---

onProjectionChanged()

onProjectionChanged(projection, changeFlags): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:827

Responds to changes in this horizon display's projection.

Parameters

Parameter	Type	Description
projection	HorizonProjection	This display's horizon projection.
changeFlags	number	The types of changes made to the projection.

Returns

void

---

render()

render(): VNode

Defined in: src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:938

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

---

sleep()

sleep(): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:800

Puts this horizon display to sleep. While asleep, this display will not be updated.

Returns

void

Throws

Error if this horizon display is dead.

---

wake()

wake(): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:775

Wakes this horizon display. While awake, this display will be updated.

Returns

void

Throws

Error if this horizon display is dead.