Interface: G3000MfdPlugin

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:35

A G3000 MFD plugin.

Extends

• G3000Plugin<G3000MfdPluginBinder>

Properties

binder

protected readonly binder: G3000MfdPluginBinder

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

---

getDisplayPanePowerOnOptions()?

optional getDisplayPanePowerOnOptions(): undefined | Readonly<DisplayPanePowerOnOptions>

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:59

Gets options with which to configure display pane logic on initial system power-on.

Returns

undefined | Readonly<DisplayPanePowerOnOptions>

Configuration options for display pane logic on initial system power-on, or undefined to use default options if no other plugin specifies its own set of options.

---

getEspDefinition()?

optional getEspDefinition(): undefined | G3000EspDefinition

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:76

Gets a definition to be used for creating an electronic stability and protection (ESP) system.

Returns

undefined | G3000EspDefinition

A definition to be used for creating an electronic stability and protection (ESP) system, or undefined to omit a definition but still allow an ESP system to be created if a definition is specified by another plugin.

---

getInitializationProcess()?

optional getInitializationProcess(): undefined | null | InitializationProcess

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:91

Gets the initialization process to be used by the G3000.

Returns

undefined | null | InitializationProcess

A initialization process to be used by the G3000, null to specify that no initialization process should be used, or undefined to omit a specification but still allow an initialization process to be used if one was specified by another plugin.

---

getPersistentSettings()

getPersistentSettings(): Iterable<UserSetting<any>>

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:52

Gets settings whose values should be saved across flight sessions.

Returns

Iterable<UserSetting<any>>

An iterable of settings whose values should be saved across flight sessions.

---

getStartupScreenRows()

getStartupScreenRows(): undefined | readonly (StartupScreenRowFactory | StartupScreenPrebuiltRow)[]

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:69

Gets the data rows to render on the right side of the MFD startup screen. Each row is defined by either a function which returns an object describing the row to render, or a pre-built row key. Up to eleven rows can be rendered. This method is ignored if the system is not configured to support the startup screen.

Returns

undefined | readonly (StartupScreenRowFactory | StartupScreenPrebuiltRow)[]

An array of rows to render on the right side of the MFD startup screen. The rows will be rendered from top to bottom in the order in which they appear in the array. If not defined, a default set of rows will be rendered.

---

getToldModule()

getToldModule(): undefined | ToldModule

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:106

Gets a module to be used for calculating takeoff and landing performance values. This method is only called if TOLD calculations are configured via panel.xml. If TOLD calculations are configured but a module is not provided by this method, then TOLD calculations will be disabled.

Returns

undefined | ToldModule

A TOLD module, or undefined if no TOLD module is to be used.

---

getWeightBalancePaneViewModule()?

optional getWeightBalancePaneViewModule(): undefined | WeightBalancePaneViewModule

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:98

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

---

onEspCreated()?

optional onEspCreated(esp, dataProvider): void

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:83

A method that is called when an electronic stability and protection (ESP) system is created.

Parameters

Parameter	Type	Description
esp	G3000EspInterface	The ESP system.
dataProvider	EspDataProvider	The data provider for the ESP system.

Returns

void

---

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/MFD/G3000MFDPlugin.ts:46

Registers display pane views.

Parameters

Parameter	Type	Description
viewFactory	DisplayPaneViewFactory	The factory with which to register views.

Returns

void

---

renderEis()

renderEis(): null | VNode

Defined in: workingtitle-instruments-g3000/html_ui/MFD/G3000MFDPlugin.ts:40

Renders the EIS.

Returns

null | VNode

The EIS, as a VNode, or null if no EIS is to be rendered.