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:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | G3XPitchLadderProps | The propertis of the component. |
Returns
G3XPitchLadder
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
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
props
props:
G3XPitchLadderProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:367
Destroys this component.
Returns
void
Overrides
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
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
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
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
onAttached()
onAttached():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:137
This method is called when this layer is attached to its parent horizon component.
Returns
void
Overrides
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
onDetached()
onDetached():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:339
This method is called when this layer is detached from its parent horizon component.
Returns
void
Overrides
onProjectionChanged()
onProjectionChanged(
projection
,changeFlags
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:151
This method is called when this layer's horizon projection changes.
Parameters
Parameter | Type | Description |
---|---|---|
projection | HorizonProjection | This layer's horizon projection. |
changeFlags | number | The 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
onUpdated()
onUpdated():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:163
This method is called once every update cycle.
Returns
void
Overrides
onVisibilityChanged()
protected
onVisibilityChanged(isVisible
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:132
This method is called when this layer's visibility changes.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether 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
render()
render():
VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HorizonDisplay/PitchLadder/G3XPitchLadder.tsx:346
Renders the component.
Returns
A JSX element to be rendered.
Overrides
setVisible()
setVisible(
val
):void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:47
Sets this layer's visibility.
Parameters
Parameter | Type | Description |
---|---|---|
val | boolean | Whether this layer should be visible. |
Returns
void