Class: RollIndicator

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:101

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

Extends

• HorizonLayer<RollIndicatorProps>

Constructors

Constructor

new RollIndicator(props): RollIndicator

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	RollIndicatorProps	The propertis of the component.

Returns

RollIndicator

Inherited from

HorizonLayer<RollIndicatorProps>.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: RollIndicatorProps & 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/RollIndicator.tsx:515

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

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

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

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

HorizonLayer.onAfterRender

---

onAttached()

onAttached(): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:140

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/RollIndicator.tsx:235

Returns

void

Inherit Doc

Overrides

HorizonLayer.onDetached

---

onProjectionChanged()

onProjectionChanged(projection, changeFlags): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:164

Parameters

Parameter	Type
projection	HorizonProjection
changeFlags	number

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(time, elapsed): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:188

Parameters

Parameter	Type
time	number
elapsed	number

Returns

void

Inherit Doc

Overrides

HorizonLayer.onUpdated

---

onVisibilityChanged()

protected onVisibilityChanged(isVisible): void

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

Parameters

Parameter	Type
isVisible	boolean

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/RollIndicator.tsx:246

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

Parameter	Type	Description
val	boolean	Whether this layer should be visible.

Returns

void

Inherited from

HorizonLayer.setVisible