Skip to main content

Class: G3XPitchLadder

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:100

A G3X Touch PFD pitch ladder. Displays major, medium, and minor pitch lines, each with optional pitch angle labels. Also displays unusual attitude chevrons between major pitch lines above threshold positive and negative pitch angles. Does not display a zero-pitch line.

Extends​

Constructors​

Constructor​

new G3XPitchLadder(props): G3XPitchLadder

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsG3XPitchLadderPropsThe propertis of the component.

Returns​

G3XPitchLadder

Inherited from​

HorizonLayer.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

HorizonLayer.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

HorizonLayer.contextType


props​

props: G3XPitchLadderProps & ComponentProps

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

The properties of the component.

Inherited from​

HorizonLayer.props

Methods​

destroy()​

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:366

Destroys this component.

Returns​

void

Overrides​

HorizonLayer.destroy


getContext()​

protected getContext(context): never

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

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​

HorizonLayer.getContext


isAttached()​

protected isAttached(): boolean

Defined in: src/sdk/components/horizon/HorizonLayer.ts:31

Checks whether this layer is attached to a horizon component.

Returns​

boolean

Whether this layer is attached to a horizon component.

Inherited from​

HorizonLayer.isAttached


isVisible()​

isVisible(): boolean

Defined in: src/sdk/components/horizon/HorizonLayer.ts:39

Checks whether this layer is visible.

Returns​

boolean

whether this layer is visible.

Inherited from​

HorizonLayer.isVisible


onAfterRender()​

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

HorizonLayer.onAfterRender


onAttached()​

onAttached(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:135

This method is called when this layer is attached to its parent horizon component.

Returns​

void

Overrides​

HorizonLayer.onAttached


onBeforeRender()​

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

HorizonLayer.onBeforeRender


onDetached()​

onDetached(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:338

This method is called when this layer is detached from its parent horizon component.

Returns​

void

Overrides​

HorizonLayer.onDetached


onProjectionChanged()​

onProjectionChanged(projection, changeFlags): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:150

This method is called when this layer's horizon projection changes.

Parameters​

ParameterTypeDescription
projectionHorizonProjectionThis layer's horizon projection.
changeFlagsnumberThe types of changes made to the projection.

Returns​

void

Overrides​

HorizonLayer.onProjectionChanged


onSleep()​

onSleep(): void

Defined in: src/sdk/components/horizon/HorizonLayer.ts:88

This method is called when this layer's parent horizon component is put to sleep.

Returns​

void

Inherited from​

HorizonLayer.onSleep


onUpdated()​

onUpdated(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:162

This method is called once every update cycle.

Returns​

void

Overrides​

HorizonLayer.onUpdated


onVisibilityChanged()​

protected onVisibilityChanged(isVisible): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:130

This method is called when this layer's visibility changes.

Parameters​

ParameterTypeDescription
isVisiblebooleanWhether the layer is now visible.

Returns​

void

Overrides​

HorizonLayer.onVisibilityChanged


onWake()​

onWake(): void

Defined in: src/sdk/components/horizon/HorizonLayer.ts:81

This method is called when this layer's parent horizon component is awakened.

Returns​

void

Inherited from​

HorizonLayer.onWake


render()​

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:345

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

HorizonLayer.render


setVisible()​

setVisible(val): void

Defined in: src/sdk/components/horizon/HorizonLayer.ts:47

Sets this layer's visibility.

Parameters​

ParameterTypeDescription
valbooleanWhether this layer should be visible.

Returns​

void

Inherited from​

HorizonLayer.setVisible