Interface: G3000PfdPlugin

Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:35

A G3000 PFD plugin.

Extends

• G3000Plugin<G3000PfdPluginBinder>

Properties

binder

protected readonly binder: G3000PfdPluginBinder

Defined in: sdk/components/FSComponent.ts:2070

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:2090

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) => DisplayComponent<any, []> | undefined

Defined in: sdk/components/FSComponent.ts:2083

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

DisplayComponent<any, []> | undefined

Inherited from

G3000Plugin.onComponentCreating

---

onComponentRendered()?

optional onComponentRendered: (node) => void

Defined in: sdk/components/FSComponent.ts:2097

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

getAfcsStatusBoxOptions()?

optional getAfcsStatusBoxOptions(): AfcsStatusBoxPluginOptions | undefined

Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:67

Gets options to pass to the PFD AFCS status box.

Returns

AfcsStatusBoxPluginOptions | undefined

Options to pass to the PFD AFCS status box.

---

getChartsSources()?

optional getChartsSources(): Iterable<G3000ChartsSourceFactory, any, any> | undefined

Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:73

Gets factories for additional electronic charts sources.

Returns

Iterable<G3000ChartsSourceFactory, any, any> | undefined

Factories for additional electronic charts sources, or undefined if there are no additional sources.

Inherited from

G3000Plugin.getChartsSources

---

getChecklistDef()?

optional getChecklistDef(): G3000ChecklistSetDef | undefined

Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:79

Gets a checklist definition to be used by the electronic checklist system.

Returns

G3000ChecklistSetDef | undefined

A checklist definition, or undefined if checklists are not to be supported.

Inherited from

G3000Plugin.getChecklistDef

---

getWeightBalancePaneViewModule()?

optional getWeightBalancePaneViewModule(): WeightBalancePaneViewModule | undefined

Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:74

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

WeightBalancePaneViewModule | undefined

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:2103

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:87

Lifecycle method called when the electronic checklist system is initialized.

Parameters

Parameter	Type	Description
checklistDef	G3000ChecklistSetDef | undefined	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:61

Lifecycle method called during instrument initialization.

Returns

void

Inherited from

G3000Plugin.onInit

---

onInstalled()

abstract onInstalled(): void

Defined in: sdk/components/FSComponent.ts:2075

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:40

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:47

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

---

renderToDisplayOverlay()?

optional renderToDisplayOverlay(): VNode | null

Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:67

Renders components to the display overlay.

Returns

VNode | null

A VNode to render to the display overlay, or null to render nothing.

Inherited from

G3000Plugin.renderToDisplayOverlay

---

renderToPfdInstruments()

renderToPfdInstruments(pfdIndex, displayPaneIndex, isInSplitMode, declutter): VNode | null

Defined in: workingtitle-instruments-g3000/html_ui/PFD/G3000PFDPlugin.ts:56

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

VNode | null