Abstract Class: CourseNeedleComponent
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:17
An interface that describes a course needle component.
Extends
DisplayComponent
<CourseNeedleProps
>
Extended by
Constructors
Constructor
new CourseNeedleComponent(
props
):CourseNeedleComponent
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | CourseNeedleProps | The propertis of the component. |
Returns
CourseNeedleComponent
Inherited from
DisplayComponent<CourseNeedleProps>.constructor
Properties
animator?
protected
optional
animator:NeedleAnimator
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:25
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
currentDeviation
protected
currentDeviation:number
=0
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:27
deviationRef
protected
readonly
deviationRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:21
needleRef
protected
readonly
needleRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:19
props
props:
CourseNeedleProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
toFromRef
protected
readonly
toFromRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:23
Methods
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: 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: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:32
A callback called after rendering completes.
Returns
void
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()
abstract
render():null
|VNode
Defined in: sdk/components/FSComponent.ts:93
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.
Inherited from
DisplayComponent.render
setDeviation()
setDeviation(
deviation
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:48
Sets the deviation of the course needle.
Parameters
Parameter | Type | Description |
---|---|---|
deviation | number | The deviation of the course needle. |
Returns
void
setDeviationVisible()
setDeviationVisible(
isVisible
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:67
Sets whether or not the course deviation indicator is visible.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | The visibility of the course deviation indicator. |
Returns
void
setFromFlag()
setFromFlag(
from
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:76
Sets whether the to/from flag should indicate to or from.
Parameters
Parameter | Type | Description |
---|---|---|
from | boolean | a bool set to true when the flag should be set to FROM. |
Returns
void
setRotation()
setRotation(
rotation
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:40
Sets the rotation of the course needle.
Parameters
Parameter | Type | Description |
---|---|---|
rotation | number | The rotation of the course needle. |
Returns
void
setVisible()
setVisible(
isVisible
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:59
Sets whether or not the course needle is visible.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | The visibility of the course needle. |
Returns
void