Class: HsiCompass
A compass display for a next-generation (NXi, G3000, etc) HSI.
The compass display depicts a circular compass rose with minor tick marks every 5 degrees and major tick marks every 10 degrees. The cardinal directions are labeled N/E/S/W, with numeric labels (3, 6, 12, ...) at every hour position that does not represent a cardinal direction.
The compass also optionally displays a single continuous circular line of arbitrary radius within the rose.
Hierarchy
DisplayComponent
<HsiCompassProps
>↳
HsiCompass
Constructors
constructor
• new HsiCompass(props
): HsiCompass
Creates an instance of a DisplayComponent.
Parameters
Name | Type | Description |
---|---|---|
props | HsiCompassProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<HsiCompassProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
src/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
src/sdk/components/FSComponent.ts:67
props
• props: HsiCompassProps
& ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
Defined in
src/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
src/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
src/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
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/garminsdk/components/nextgenpfd/hsi/HsiCompass.tsx:32