Interface: G3000PfdPlugin
Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:34
A G3000 PFD plugin.
Extends
G3000Plugin
<G3000PfdPluginBinder
>
Properties
binder
protected
readonly
binder:G3000PfdPluginBinder
Defined in: sdk/components/FSComponent.ts:1461
The avionics specific plugin binder to accept from the system.
Inherited from
G3000Plugin.binder
onComponentCreated()?
optional
onComponentCreated: (component
) =>void
Defined in: sdk/components/FSComponent.ts:1481
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
Parameter | Type |
---|---|
component | DisplayComponent <any > |
Returns
void
Inherited from
G3000Plugin.onComponentCreated
onComponentCreating()?
optional
onComponentCreating: (constructor
,props
) =>undefined
|DisplayComponent
<any
, []>
Defined in: sdk/components/FSComponent.ts:1474
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
Parameter | Type |
---|---|
constructor | DisplayComponentFactory <any > |
props | any |
Returns
undefined
| DisplayComponent
<any
, []>
Inherited from
G3000Plugin.onComponentCreating
onComponentRendered()?
optional
onComponentRendered: (node
) =>void
Defined in: sdk/components/FSComponent.ts:1488
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
Parameter | Type |
---|---|
node | VNode |
Returns
void
Inherited from
G3000Plugin.onComponentRendered
Methods
getChecklistDef()?
optional
getChecklistDef():undefined
|G3000ChecklistSetDef
Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:62
Gets a checklist definition to be used by the electronic checklist system.
Returns
undefined
| G3000ChecklistSetDef
A checklist definition, or undefined
if checklists are not to be supported.
Inherited from
G3000Plugin.getChecklistDef
getWeightBalancePaneViewModule()?
optional
getWeightBalancePaneViewModule():undefined
|WeightBalancePaneViewModule
Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:67
Gets a module to be used for customizing the weight and balance display pane. This method is only called if weight
and balance is configured via panel.xml
.
Returns
undefined
| WeightBalancePaneViewModule
A weight and balance display pane module, or undefined
to omit a module.
loadCss()
protected
loadCss(uri
):Promise
<void
>
Defined in: sdk/components/FSComponent.ts:1494
Loads a CSS file into the instrument.
Parameters
Parameter | Type | Description |
---|---|---|
uri | string | The URI to the CSS file. |
Returns
Promise
<void
>
Inherited from
G3000Plugin.loadCss
onChecklistInit()?
optional
onChecklistInit(checklistDef
,checklistStateProvider?
):void
Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:70
Lifecycle method called when the electronic checklist system is initialized.
Parameters
Parameter | Type | Description |
---|---|---|
checklistDef | undefined | G3000ChecklistSetDef | The checklist definition used by the checklist system, or undefined if checklists are not supported. |
checklistStateProvider? | G3000ChecklistStateProvider | A provider of checklist state, or undefined if checklists are not supported. |
Returns
void
Inherited from
G3000Plugin.onChecklistInit
onInit()
onInit():
void
Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:56
Lifecycle method called during instrument initialization.
Returns
void
Inherited from
G3000Plugin.onInit
onInstalled()
abstract
onInstalled():void
Defined in: sdk/components/FSComponent.ts:1466
A callback run when the plugin has been installed.
Returns
void
Inherited from
G3000Plugin.onInstalled
registerDisplayPaneViews()
registerDisplayPaneViews(
viewFactory
):void
Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:39
Registers display pane views.
Parameters
Parameter | Type | Description |
---|---|---|
viewFactory | DisplayPaneViewFactory | The factory with which to register views. |
Returns
void
registerSoftkeyMenus()
registerSoftkeyMenus(
menuSystem
,pfdIndex
):void
Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:46
Registers softkey menus.
Parameters
Parameter | 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
renderToPfdInstruments()
renderToPfdInstruments(
pfdIndex
,displayPaneIndex
,isInSplitMode
,declutter
):null
|VNode
Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:55
Renders components to the PFD instrument container.
Parameters
Parameter | 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