Interface: RollIndicatorScaleComponent

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicatorScaleComponent.tsx:40

A component that is displayed on a PFD roll indicator scale.

Extends

• DisplayComponent<any>

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.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

DisplayComponent.contextType

---

isRollIndicatorScaleComponent

readonly isRollIndicatorScaleComponent: true

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicatorScaleComponent.tsx:42

Flags this object as a RollIndicatorScaleComponent.

---

props

props: any

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

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

DisplayComponent.getContext

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

DisplayComponent.onAfterRender

---

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

DisplayComponent.onBeforeRender

---

onProjectionChanged()

onProjectionChanged(projection, changeFlags): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicatorScaleComponent.tsx:62

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

Parameters

Parameter	Type	Description
projection	HorizonProjection	This component's horizon projection.
changeFlags	number	The types of changes made to the projection.

Returns

void

---

onScaleAttached()

onScaleAttached(): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicatorScaleComponent.tsx:47

This method is called when this component's parent roll indicator is attached to its parent horizon component.

Returns

void

---

onScaleDetached()

onScaleDetached(): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicatorScaleComponent.tsx:74

This method is called when this component's parent roll indicator is detached from its parent horizon component.

Returns

void

---

onScaleVisibilityChanged()

onScaleVisibilityChanged(isVisible): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicatorScaleComponent.tsx:55

This method is called when this component's parent roll indicator's visibility changes. This method is guaranteed to be called only after onScaleAttached() is called. The parent roll indicator is always initially considered to be visible (i.e. if this method is never called, then it is safe to assume the roll indicator is always visible).

Parameters

Parameter	Type	Description
isVisible	boolean	Whether the parent roll indicator is now visible.

Returns

void

---

onUpdated()

onUpdated(time, elapsed): void

Defined in: src/garminsdk/components/nextgenpfd/horizon/RollIndicatorScaleComponent.tsx:69

This method is called once every update cycle.

Parameters

Parameter	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

---

render()

abstract render(): VNode | null

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

Renders the component.

Returns

VNode | null

A JSX element to be rendered.

Inherited from

DisplayComponent.render