Skip to main content

Abstract Class: HsiCourseNeedle<P>

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

A course needle for an HSI.

The course needle recognizes a total of four separate active NAV sources: two of type NAV (radio) and two of type GPS. A CSS class is added to the needle's root element (e.g. hsi-course-needle-nav1) based on which source is currently active.

Extends​

Extended by​

Type Parameters​

Type ParameterDefault type
P extends HsiCourseNeedlePropsHsiCourseNeedleProps

Constructors​

Constructor​

new HsiCourseNeedle<P>(props): HsiCourseNeedle<P>

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsPThe propertis of the component.

Returns​

HsiCourseNeedle<P>

Inherited from​

DisplayComponent.constructor

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


props​

props: P & ComponentProps

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

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

Destroys this component.

Returns​

void

Overrides​

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​

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​

DisplayComponent.getContext


getRootCssClass()​

protected getRootCssClass(): string

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

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.


onAfterRender()​

onAfterRender(): void

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

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:83

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


render()​

render(): VNode

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

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

DisplayComponent.render


renderNeedle()​

abstract protected renderNeedle(course, deviation, toFrom): VNode

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

Renders a needle.

Parameters​

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

Returns​

VNode

A needle, as a VNode.