Interface: G3000MfdPlugin

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

A G3000 MFD plugin.

Extends

• G3000Plugin<G3000MfdPluginBinder>

Properties

binder

protected readonly binder: G3000MfdPluginBinder

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

getAutopilotOptions()?

optional getAutopilotOptions(): G3000AutopilotPluginOptions | undefined

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

Gets options to pass to the autopilot.

Returns

G3000AutopilotPluginOptions | undefined

Options to pass to the autopilot.

---

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

---

getDisplayPanePowerOnOptions()?

optional getDisplayPanePowerOnOptions(): Readonly<DisplayPanePowerOnOptions> | undefined

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

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

Returns

Readonly<DisplayPanePowerOnOptions> | undefined

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(): G3000EspDefinition | undefined

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

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

Returns

G3000EspDefinition | undefined

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(): InitializationProcess | null | undefined

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

Gets the initialization process to be used by the G3000.

Returns

InitializationProcess | null | undefined

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

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(): readonly (StartupScreenRowFactory | StartupScreenPrebuiltRow)[] | undefined

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

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

readonly (StartupScreenRowFactory | StartupScreenPrebuiltRow)[] | undefined

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(): ToldModule | undefined

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

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

ToldModule | undefined

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

---

getWeightBalancePaneViewModule()?

optional getWeightBalancePaneViewModule(): WeightBalancePaneViewModule | undefined

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

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

---

onEspCreated()?

optional onEspCreated(esp, dataProvider): void

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

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

Registers display pane views.

Parameters

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

Returns

void

---

renderEis()

renderEis(): VNode | null

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

Renders the EIS.

Returns

VNode | null

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

---

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