Class: TurnRateIndicator

A turn rate indicator for a next-generation (NXi, G3000, etc) HSI.

The turn rate indicator is rendered such that it sits on the top edge of an HSI compass. The indicator spans 24 degrees of arc on either side of the lubber line. Markings are present at 9 and 18 degrees on either side of the lubber line. A turn rate vector is extended along an arc parallel to the compass edge subtending an angle equal to the estimated change in heading over the next 6 seconds. If turn rate exceeds 4 degrees per second, the vector is clamped to 24 degrees of arc and an arrowhead is added to the end.

The turn rate indicator's root element should be positioned such that its bottom edge intersects the center of the HSI compass, and its left edge sits flush with the left edge of the HSI compass (the width of the root element is equal to the diameter of the compass).

Hierarchy

• DisplayComponent<TurnRateProps>

  ↳ TurnRateIndicator

Constructors

constructor

• new TurnRateIndicator(props): TurnRateIndicator

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	TurnRateProps	The propertis of the component.

Returns

TurnRateIndicator

Inherited from

DisplayComponent<TurnRateProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

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

DisplayComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

props

• props: TurnRateProps & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

Defined in

src/sdk/components/FSComponent.ts:98

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	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

Defined in

src/sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

src/garminsdk/components/nextgenpfd/hsi/TurnRateIndicator.tsx:91

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

Defined in

src/garminsdk/components/nextgenpfd/hsi/TurnRateIndicator.tsx:111

---

setTurnRate

▸ setTurnRate(turnRate): void

Sets this indicator's displayed turn rate.

Parameters

Name	Type	Description
turnRate	number	The turn rate, in degrees per second. Positive values indicate a right-hand turn.

Returns

void

Defined in

src/garminsdk/components/nextgenpfd/hsi/TurnRateIndicator.tsx:105