Skip to main content

Class: PitchLadder

Defined in: src/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:92

A 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 PitchLadder(props): PitchLadder

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsPitchLadderPropsThe propertis of the component.

Returns​

PitchLadder

Inherited from​

HorizonLayer<PitchLadderProps>.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

HorizonLayer.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​

HorizonLayer.contextType


props​

props: PitchLadderProps & ComponentProps

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

The properties of the component.

Inherited from​

HorizonLayer.props

Methods​

destroy()​

destroy(): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:344

Returns​

void

Inherit Doc​

Overrides​

HorizonLayer.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​

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:87

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/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:128

Returns​

void

Inherit Doc​

Overrides​

HorizonLayer.onAttached


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​

HorizonLayer.onBeforeRender


onDetached()​

onDetached(): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:316

Returns​

void

Inherit Doc​

Overrides​

HorizonLayer.onDetached


onProjectionChanged()​

onProjectionChanged(projection, changeFlags): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:142

Parameters​

ParameterType
projectionHorizonProjection
changeFlagsnumber

Returns​

void

Inherit Doc​

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/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:153

Returns​

void

Inherit Doc​

Overrides​

HorizonLayer.onUpdated


onVisibilityChanged()​

protected onVisibilityChanged(isVisible): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:123

Parameters​

ParameterType
isVisibleboolean

Returns​

void

Inherit Doc​

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/garminsdk/components/nextgenpfd/horizon/PitchLadder.tsx:323

Returns​

VNode

Inherit Doc​

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