Class: HsiMap
An HSI component with a moving map.
Hierarchy
DisplayComponent<HsiMapProps>↳
HsiMap
Constructors
constructor
• new HsiMap(props): HsiMap
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | HsiMapProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<HsiMapProps>.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: HsiMapProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/Components/HSI/HsiMap.tsx:668
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(): void
A callback called when the component finishes rendering.
Returns
void
Overrides
DisplayComponent.onAfterRender
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/Components/HSI/HsiMap.tsx:272
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
onEvent
▸ onEvent(event): void
Responds to display pane view events.
Parameters
| Name | Type | Description |
|---|---|---|
event | DisplayPaneViewEvent<DisplayPaneViewEventTypes, "display_pane_map_range_inc" | "display_pane_map_range_dec" | "display_pane_map_pointer_active_set" | "display_pane_map_pointer_active_toggle" | "display_pane_map_pointer_move"> | A display pane view event. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/Components/HSI/HsiMap.tsx:524
render
▸ render(): VNode
Renders the HSIMap component.
Returns
VNode
The rendered component VNode.
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/Components/HSI/HsiMap.tsx:539
update
▸ update(time): void
Updates this map.
Parameters
| Name | Type | Description |
|---|---|---|
time | number | The current real time, as a UNIX timestamp in milliseconds. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/Components/HSI/HsiMap.tsx:508