Skip to main content

Class: HsiActiveNavNeedle

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiActiveNavNeedle.tsx:55

An HSI course needle for the active nav source, consisting of an arrow, to/from flag, and a course deviation indicator (CDI) with hollow dot markers representing full- and half-scale deviation.

The course needle supports four different styles: regular HSI rose style, HSI map style, and a closed (solid color) style and an open (color outline with transparent middle) style for each of the first two. The HSI rose style includes a course deviation indicator, while the HSI map style does not.

Extends

Constructors

Constructor

new HsiActiveNavNeedle(props): HsiActiveNavNeedle

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsHsiActiveNavNeedlePropsThe propertis of the component.

Returns

HsiActiveNavNeedle

Inherited from

HsiCourseNeedle.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

HsiCourseNeedle.contextType


props

props: HsiActiveNavNeedleProps & ComponentProps

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

The properties of the component.

Inherited from

HsiCourseNeedle.props

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiActiveNavNeedle.tsx:246

Returns

void

Inherit Doc

Overrides

HsiCourseNeedle.destroy


getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
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

HsiCourseNeedle.getContext


getRootCssClass()

protected getRootCssClass(): string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiActiveNavNeedle.tsx:121

Gets the CSS class(es) to apply to this needle's root element.

Returns

string

The CSS class(es) to apply to this needle's root element.

Overrides

HsiCourseNeedle.getRootCssClass


onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiCourseNeedle.tsx:66

Returns

void

Inherit Doc

Inherited from

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

HsiCourseNeedle.onBeforeRender


render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiCourseNeedle.tsx:135

Returns

VNode

Inherit Doc

Inherited from

HsiCourseNeedle.render


renderNeedle()

protected renderNeedle(course, deviation, toFrom): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiActiveNavNeedle.tsx:126

Renders a needle.

Parameters

ParameterType
courseSubscribable<null | number>
deviationSubscribable<null | number>
toFromSubscribable<null | VorToFrom>

Returns

VNode

A needle, as a VNode.

Overrides

HsiCourseNeedle.renderNeedle