Skip to main content

Class: G3XHorizonDisplay

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/G3XHorizonDisplay.tsx:132

A G3X Touch Garmin PFD horizon display. Includes an artificial horizon, attitude indicator, aircraft symbol, flight director, and synthetic vision technology (SVT) display.

Extends​

Constructors​

Constructor​

new G3XHorizonDisplay(props): G3XHorizonDisplay

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsG3XHorizonDisplayPropsThe propertis of the component.

Returns​

G3XHorizonDisplay

Inherited from​

DisplayComponent<G3XHorizonDisplayProps>.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: G3XHorizonDisplayProps & 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/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/G3XHorizonDisplay.tsx:572

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​

ParameterTypeDescription
contextneverThe 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/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/G3XHorizonDisplay.tsx:271

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/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/G3XHorizonDisplay.tsx:479

Returns​

VNode

Inherit Doc​

Overrides​

DisplayComponent.render


sleep()​

sleep(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/G3XHorizonDisplay.tsx:440

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/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/G3XHorizonDisplay.tsx:411

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

Returns​

void

Throws​

Error if this horizon display is dead.