Class: HsiCourseNeedle<P>
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.
Type parameters
Name | Type |
---|---|
P | extends HsiCourseNeedleProps = HsiCourseNeedleProps |
Hierarchy
DisplayComponent
<P
>↳
HsiCourseNeedle
Constructors
constructor
• new HsiCourseNeedle<P
>(props
): HsiCourseNeedle
<P
>
Creates an instance of a DisplayComponent.
Type parameters
Name | Type |
---|---|
P | extends HsiCourseNeedleProps = HsiCourseNeedleProps |
Parameters
Name | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
Inherited from
DisplayComponent<P>.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: P
& ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/PFD/Components/HSI/HsiCourseNeedle.tsx:166
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
getRootCssClass
▸ getRootCssClass(): string
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.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/PFD/Components/HSI/HsiCourseNeedle.tsx:151
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/PFD/Components/HSI/HsiCourseNeedle.tsx:66
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/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/PFD/Components/HSI/HsiCourseNeedle.tsx:135
renderNeedle
▸ renderNeedle(course
, deviation
, toFrom
): VNode
Renders a needle.
Parameters
Name | Type |
---|---|
course | Subscribable <null | number > |
deviation | Subscribable <null | number > |
toFrom | Subscribable <null | VorToFrom > |
Returns
VNode
A needle, as a VNode.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/PFD/Components/HSI/HsiCourseNeedle.tsx:159