Class: AbstractG3000PfdPlugin
An abstract implementation of G3000PfdPlugin that by default does nothing. Subclasses should override the appropriate methods to provide desired functionality.
Hierarchy
AvionicsPlugin
<G3000PfdPluginBinder
>↳
AbstractG3000PfdPlugin
Implements
Constructors
constructor
• new AbstractG3000PfdPlugin(binder
): AbstractG3000PfdPlugin
Creates an instance of a Plugin.
Parameters
Name | Type | Description |
---|---|---|
binder | G3000PfdPluginBinder | The avionics specific plugin binder to accept from the system. |
Returns
Inherited from
AvionicsPlugin<G3000PfdPluginBinder>.constructor
Defined in
src/sdk/components/FSComponent.ts:1424
Properties
binder
• Protected
Readonly
binder: G3000PfdPluginBinder
The avionics specific plugin binder to accept from the system.
Implementation of
Inherited from
AvionicsPlugin.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
Implementation of
G3000PfdPlugin.onComponentCreated
Inherited from
AvionicsPlugin.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
, []>
Implementation of
G3000PfdPlugin.onComponentCreating
Inherited from
AvionicsPlugin.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
Implementation of
G3000PfdPlugin.onComponentRendered
Inherited from
AvionicsPlugin.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
>
Implementation of
Inherited from
AvionicsPlugin.loadCss
Defined in
src/sdk/components/FSComponent.ts:1457
onInit
▸ onInit(): void
Lifecycle method called during instrument initialization.
Returns
void
Implementation of
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:70
onInstalled
▸ onInstalled(): void
A callback run when the plugin has been installed.
Returns
void
Implementation of
Overrides
AvionicsPlugin.onInstalled
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:65
registerDisplayPaneViews
▸ registerDisplayPaneViews(viewFactory
): void
Registers display pane views.
Parameters
Name | Type | Description |
---|---|---|
viewFactory | DisplayPaneViewFactory | The factory with which to register views. |
Returns
void
Implementation of
G3000PfdPlugin.registerDisplayPaneViews
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:75
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
Implementation of
G3000PfdPlugin.registerSoftkeyMenus
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:80
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
Implementation of
G3000PfdPlugin.renderToPfdInstruments
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/G3000PFDPlugin.ts:85