Class: CompassRose
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CompassRose.tsx:21
A compass rose display component.
Extends
DisplayComponent
<CompassRoseProps
>
Constructors
Constructor
new CompassRose(
props
):CompassRose
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | CompassRoseProps | The propertis of the component. |
Returns
CompassRose
Inherited from
DisplayComponent<CompassRoseProps>.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:
CompassRoseProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
buildRose()
buildRose():
SVGLineElement
[]
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CompassRose.tsx:30
Builds the compass rose tick marks.
Returns
SVGLineElement
[]
A collection of rose tick line elements.
buildRoseMarkings()
buildRoseMarkings():
SVGTextElement
[]
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CompassRose.tsx:55
Builds the compass rose letter markings.
Returns
SVGTextElement
[]
A collection of letter marking text elements.
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(
node
):void
Defined in: sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
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-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CompassRose.tsx:85
Renders the component.
Returns
VNode
The rendered VNode.
Overrides
DisplayComponent.render
setCircleVisible()
setCircleVisible(
isVisible
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/HSI/CompassRose.tsx:77
Sets whether or not the bearing pointer circle is visible.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether or not the bearing pointer circle is visible. |
Returns
void