Class: GpsNeedle
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/GpsNeedle.tsx:8
A GPS course needle component.
Extends
Constructors
Constructor
new GpsNeedle(
props
):GpsNeedle
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
GpsNeedle
Inherited from
CourseNeedleComponent
.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
Inherited from
CourseNeedleComponent
.animator
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
CourseNeedleComponent
.contextType
currentDeviation
protected
currentDeviation:number
=0
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:27
Inherited from
CourseNeedleComponent
.currentDeviation
deviationRef
protected
readonly
deviationRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:21
Inherited from
CourseNeedleComponent
.deviationRef
needleRef
protected
readonly
needleRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:19
Inherited from
CourseNeedleComponent
.needleRef
props
props:
CourseNeedleProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
toFromRef
protected
readonly
toFromRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:23
Inherited from
CourseNeedleComponent
.toFromRef
Methods
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
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
CourseNeedleComponent
.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
Inherited from
CourseNeedleComponent
.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
CourseNeedleComponent
.onBeforeRender
render()
render():
VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/GpsNeedle.tsx:14
Renders the component.
Returns
VNode
The rendered VNode.
Overrides
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
Inherited from
CourseNeedleComponent
.setDeviation
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
Inherited from
CourseNeedleComponent
.setDeviationVisible
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
Inherited from
CourseNeedleComponent
.setFromFlag
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
Inherited from
CourseNeedleComponent
.setRotation
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