Class: CourseNeedleComponent

An interface that describes a course needle component.

Hierarchy

• DisplayComponent<CourseNeedleProps>

  ↳ CourseNeedleComponent

  ↳↳ GpsNeedle

  ↳↳ Nav1Needle

  ↳↳ Nav2Needle

Constructors

constructor

• new CourseNeedleComponent(props): CourseNeedleComponent

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	CourseNeedleProps	The propertis of the component.

Returns

CourseNeedleComponent

Inherited from

DisplayComponent<CourseNeedleProps>.constructor

Defined in

sdk/components/FSComponent.ts:73

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

The context on this component, if any.

Inherited from

DisplayComponent.context

Defined in

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

sdk/components/FSComponent.ts:67

---

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

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

sdk/components/FSComponent.ts:61

---

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

Defined in

sdk/components/FSComponent.ts:98

---

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

sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(): void

A callback called after rendering completes.

Returns

void

Overrides

DisplayComponent.onAfterRender

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:32

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80

---

render

▸ render(): null | VNode

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render

Defined in

sdk/components/FSComponent.ts:93

---

setDeviation

▸ setDeviation(deviation): void

Sets the deviation of the course needle.

Parameters

Name	Type	Description
deviation	number	The deviation of the course needle.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:48

---

setDeviationVisible

▸ setDeviationVisible(isVisible): void

Sets whether or not the course deviation indicator is visible.

Parameters

Name	Type	Description
isVisible	boolean	The visibility of the course deviation indicator.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:67

---

setFromFlag

▸ setFromFlag(from): void

Sets whether the to/from flag should indicate to or from.

Parameters

Name	Type	Description
from	boolean	a bool set to true when the flag should be set to FROM.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:76

---

setRotation

▸ setRotation(rotation): void

Sets the rotation of the course needle.

Parameters

Name	Type	Description
rotation	number	The rotation of the course needle.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:40

---

setVisible

▸ setVisible(isVisible): void

Sets whether or not the course needle is visible.

Parameters

Name	Type	Description
isVisible	boolean	The visibility of the course needle.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CourseNeedleComponent.ts:59