Skip to main content

Abstract Class: CourseNeedle

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/CourseNeedle.tsx:42

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​

Constructors​

Constructor​

new CourseNeedle(props): CourseNeedle

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsCourseNeedlePropsThe propertis of the component.

Returns​

CourseNeedle

Inherited from​

DisplayComponent<CourseNeedleProps>.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: CourseNeedleProps & ComponentProps

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/CourseNeedle.tsx:201

Returns​

void

Inherit Doc​

Overrides​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

Defined in: 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​

DisplayComponent.getContext


getRootCssClass()​

protected getRootCssClass(): string

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/CourseNeedle.tsx:184

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: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/CourseNeedle.tsx:91

Returns​

void

Inherit Doc​

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: 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: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/CourseNeedle.tsx:168

Returns​

VNode

Inherit Doc​

Overrides​

DisplayComponent.render


renderMapNeedle()​

abstract protected renderMapNeedle(rotationStyle): VNode

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/CourseNeedle.tsx:198

Renders needles for an HSI map.

Parameters​

ParameterType
rotationStyleObjectSubject<any>

Returns​

VNode

Needles for an HSI map, as a VNode.


renderRoseNeedle()​

abstract protected renderRoseNeedle(rotationStyle, deviationStyle, toFromStyle): VNode

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/CourseNeedle.tsx:192

Renders needles for an HSI rose.

Parameters​

ParameterType
rotationStyleObjectSubject<any>
deviationStyleObjectSubject<any>
toFromStyleObjectSubject<any>

Returns​

VNode

Needles for an HSI rose, as a VNode.