Skip to main content

Abstract Class: AbstractG3000MfdPlugin

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

An abstract implementation of G3000MfdPlugin that by default does nothing. Subclasses should override the appropriate methods to provide desired functionality.

Extends​

Implements​

Constructors​

Constructor​

new AbstractG3000MfdPlugin(binder): AbstractG3000MfdPlugin

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

Creates an instance of a Plugin.

Parameters​

ParameterTypeDescription
binderG3000MfdPluginBinderThe avionics specific plugin binder to accept from the system.

Returns​

AbstractG3000MfdPlugin

Inherited from​

AvionicsPlugin.constructor

Properties​

binder​

protected readonly binder: G3000MfdPluginBinder

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

The avionics specific plugin binder to accept from the system.

Implementation of​

G3000MfdPlugin.binder

Inherited from​

AvionicsPlugin.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​

ParameterType
componentDisplayComponent<any>

Returns​

void

Implementation of​

G3000MfdPlugin.onComponentCreated

Inherited from​

AvionicsPlugin.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​

ParameterType
constructorDisplayComponentFactory<any>
propsany

Returns​

DisplayComponent<any, []> | undefined

Implementation of​

G3000MfdPlugin.onComponentCreating

Inherited from​

AvionicsPlugin.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​

ParameterType
nodeVNode

Returns​

void

Implementation of​

G3000MfdPlugin.onComponentRendered

Inherited from​

AvionicsPlugin.onComponentRendered

Methods​

getDisplayPanePowerOnOptions()​

getDisplayPanePowerOnOptions(): Readonly<DisplayPanePowerOnOptions> | undefined

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

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.

Implementation of​

G3000MfdPlugin.getDisplayPanePowerOnOptions


getEspDefinition()​

getEspDefinition(): G3000EspDefinition | undefined

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

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.

Implementation of​

G3000MfdPlugin.getEspDefinition


getInitializationProcess()​

getInitializationProcess(): InitializationProcess | undefined

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

Gets the initialization process to be used by the G3000.

Returns​

InitializationProcess | 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.

Implementation of​

G3000MfdPlugin.getInitializationProcess


getPersistentSettings()​

getPersistentSettings(): Iterable<UserSetting<any>>

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

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.

Implementation of​

G3000MfdPlugin.getPersistentSettings


getStartupScreenRows()​

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

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

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.

Implementation of​

G3000MfdPlugin.getStartupScreenRows


getToldModule()​

getToldModule(): ToldModule | undefined

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

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.

Implementation of​

G3000MfdPlugin.getToldModule


getWeightBalancePaneViewModule()​

getWeightBalancePaneViewModule(): WeightBalancePaneViewModule | undefined

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

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.

Implementation of​

G3000MfdPlugin.getWeightBalancePaneViewModule


loadCss()​

protected loadCss(uri): Promise<void>

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

Loads a CSS file into the instrument.

Parameters​

ParameterTypeDescription
uristringThe URI to the CSS file.

Returns​

Promise<void>

Implementation of​

G3000MfdPlugin.loadCss

Inherited from​

AvionicsPlugin.loadCss


onEspCreated()​

onEspCreated(esp, dataProvider): void

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

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

Parameters​

ParameterTypeDescription
espG3000EspInterfaceThe ESP system.
dataProviderEspDataProviderThe data provider for the ESP system.

Returns​

void

Implementation of​

G3000MfdPlugin.onEspCreated


onInit()​

onInit(): void

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

Lifecycle method called during instrument initialization.

Returns​

void

Implementation of​

G3000MfdPlugin.onInit


onInstalled()​

onInstalled(): void

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

A callback run when the plugin has been installed.

Returns​

void

Implementation of​

G3000MfdPlugin.onInstalled

Overrides​

AvionicsPlugin.onInstalled


registerDisplayPaneViews()​

registerDisplayPaneViews(viewFactory): void

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

Registers display pane views.

Parameters​

ParameterTypeDescription
viewFactoryDisplayPaneViewFactoryThe factory with which to register views.

Returns​

void

Implementation of​

G3000MfdPlugin.registerDisplayPaneViews


renderEis()​

renderEis(): VNode | null

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

Renders the EIS.

Returns​

VNode | null

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

Implementation of​

G3000MfdPlugin.renderEis