Skip to main content

Class: RollIndicator

A PFD roll indicator. Displays a roll scale, roll pointer, and slip-skid indicator.

Hierarchy

Constructors

constructor

new RollIndicator(props): RollIndicator

Creates an instance of a DisplayComponent.

Parameters

NameTypeDescription
propsRollIndicatorPropsThe propertis of the component.

Returns

RollIndicator

Inherited from

HorizonLayer<RollIndicatorProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

HorizonLayer.context

Defined in

src/sdk/components/FSComponent.ts:64


contextType

Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

HorizonLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67


props

props: RollIndicatorProps & ComponentProps

The properties of the component.

Inherited from

HorizonLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

destroy(): void

Returns

void

Inherit Doc

Overrides

HorizonLayer.destroy

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:431


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
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

Defined in

src/sdk/components/FSComponent.ts:106


isAttached

isAttached(): boolean

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

Defined in

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


isVisible

isVisible(): boolean

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

HorizonLayer.isVisible

Defined in

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


onAfterRender

onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

HorizonLayer.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87


onAttached

onAttached(): void

Returns

void

Inherit Doc

Overrides

HorizonLayer.onAttached

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:117


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

HorizonLayer.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80


onDetached

onDetached(): void

Returns

void

Inherit Doc

Overrides

HorizonLayer.onDetached

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:192


onProjectionChanged

onProjectionChanged(projection, changeFlags): void

Parameters

NameType
projectionHorizonProjection
changeFlagsnumber

Returns

void

Inherit Doc

Overrides

HorizonLayer.onProjectionChanged

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:131


onSleep

onSleep(): void

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

Returns

void

Inherited from

HorizonLayer.onSleep

Defined in

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


onUpdated

onUpdated(): void

Returns

void

Inherit Doc

Overrides

HorizonLayer.onUpdated

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:151


onVisibilityChanged

onVisibilityChanged(isVisible): void

Parameters

NameType
isVisibleboolean

Returns

void

Inherit Doc

Overrides

HorizonLayer.onVisibilityChanged

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:112


onWake

onWake(): void

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

Returns

void

Inherited from

HorizonLayer.onWake

Defined in

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


render

render(): VNode

Returns

VNode

Inherit Doc

Overrides

HorizonLayer.render

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:199


setVisible

setVisible(val): void

Sets this layer's visibility.

Parameters

NameTypeDescription
valbooleanWhether this layer should be visible.

Returns

void

Inherited from

HorizonLayer.setVisible

Defined in

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