Interface: G3000PfdPlugin
A G3000 PFD plugin.
Hierarchy
G3000Plugin<G3000PfdPluginBinder>↳
G3000PfdPlugin
Implemented by
Properties
binder
• Protected Readonly binder: G3000PfdPluginBinder
The avionics specific plugin binder to accept from the system.
Inherited from
G3000Plugin.binder
Defined in
src/sdk/components/FSComponent.ts:1424
onComponentCreated
• Optional onComponentCreated: (component: DisplayComponent<any, []>) => void
An optional hook called when a component is created. If this hook is present, it will be called for EVERY component instantiation, so be sure to ensure that this code is well optimized.
Type declaration
▸ (component): void
An optional hook called when a component is created. If this hook is present, it will be called for EVERY component instantiation, so be sure to ensure that this code is well optimized.
Parameters
| Name | Type |
|---|---|
component | DisplayComponent<any, []> |
Returns
void
Inherited from
G3000Plugin.onComponentCreated
Defined in
src/sdk/components/FSComponent.ts:1444
onComponentCreating
• Optional onComponentCreating: (constructor: DisplayComponentFactory<any, []>, props: any) => undefined | DisplayComponent<any, []>
An optional hook called when a component is about to be created. Returning a component causes that component to be used instead of the one that was to be created, and returning undefined will cause the original component to be created. If this hook is present, it will be called for EVERY component instantiation, so be sure to ensure that this code is well optimized.
Type declaration
▸ (constructor, props): undefined | DisplayComponent<any, []>
An optional hook called when a component is about to be created. Returning a component causes that component to be used instead of the one that was to be created, and returning undefined will cause the original component to be created. If this hook is present, it will be called for EVERY component instantiation, so be sure to ensure that this code is well optimized.
Parameters
| Name | Type |
|---|---|
constructor | DisplayComponentFactory<any, []> |
props | any |
Returns
undefined | DisplayComponent<any, []>
Inherited from
G3000Plugin.onComponentCreating
Defined in
src/sdk/components/FSComponent.ts:1437
onComponentRendered
• Optional onComponentRendered: (node: VNode) => void
An optional hook called when a component has completed rendering. If this hook is present, it will be called for EVERY component render completion, so be sure to ensure that this code is well optimized.
Type declaration
▸ (node): void
An optional hook called when a component has completed rendering. If this hook is present, it will be called for EVERY component render completion, so be sure to ensure that this code is well optimized.
Parameters
| Name | Type |
|---|---|
node | VNode |
Returns
void
Inherited from
G3000Plugin.onComponentRendered
Defined in
src/sdk/components/FSComponent.ts:1451
Methods
loadCss
▸ loadCss(uri): Promise<void>
Loads a CSS file into the instrument.
Parameters
| Name | Type | Description |
|---|---|---|
uri | string | The URI to the CSS file. |
Returns
Promise<void>
Inherited from
G3000Plugin.loadCss
Defined in
src/sdk/components/FSComponent.ts:1457
onInit
▸ onInit(): void
Lifecycle method called during instrument initialization.
Returns
void
Inherited from
G3000Plugin.onInit
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/G3000Plugin.ts:50
onInstalled
▸ onInstalled(): void
A callback run when the plugin has been installed.
Returns
void
Inherited from
G3000Plugin.onInstalled
Defined in
src/sdk/components/FSComponent.ts:1429
registerDisplayPaneViews
▸ registerDisplayPaneViews(viewFactory): void
Registers display pane views.
Parameters
| Name | Type | Description |
|---|---|---|
viewFactory | DisplayPaneViewFactory | The factory with which to register views. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:35
registerSoftkeyMenus
▸ registerSoftkeyMenus(menuSystem, pfdIndex): void
Registers softkey menus.
Parameters
| Name | Type | Description |
|---|---|---|
menuSystem | SoftKeyMenuSystem | The softkey menu system with which to register menus. |
pfdIndex | PfdIndex | The index of the softkey menu system's parent PFD. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:42
renderToPfdInstruments
▸ renderToPfdInstruments(pfdIndex, displayPaneIndex, isInSplitMode, declutter): null | VNode
Renders components to the PFD instrument container.
Parameters
| Name | Type | Description |
|---|---|---|
pfdIndex | PfdIndex | The index of the instrument container's parent PFD. |
displayPaneIndex | LeftPfdInstrument | RightPfdInstrument | The index of the instrument container's display pane. |
isInSplitMode | Subscribable<boolean> | Whether the PFD is in split mode. |
declutter | Subscribable<boolean> | Whether the PFD is decluttered. |
Returns
null | VNode
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:51