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