Class: TurnRateIndicator

Defined in: src/garminsdk/components/nextgenpfd/hsi/TurnRateIndicator.tsx:51

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

Extends

• DisplayComponent<TurnRateProps>

Constructors

Constructor

new TurnRateIndicator(props): TurnRateIndicator

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	TurnRateProps	The propertis of the component.

Returns

TurnRateIndicator

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

DisplayComponent.contextType

---

props

props: TurnRateProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

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

DisplayComponent.getContext

---

onAfterRender()

onAfterRender(): void

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

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

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

DisplayComponent.onBeforeRender

---

render()

render(): VNode

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

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

setTurnRate()

setTurnRate(turnRate): void

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

Sets this indicator's displayed turn rate.

Parameters

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

Returns

void