Skip to main content

Abstract Class: AbstractG3000PfdPlugin

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

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

Extends​

Implements​

Constructors​

Constructor​

new AbstractG3000PfdPlugin(binder): AbstractG3000PfdPlugin

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

Creates an instance of a Plugin.

Parameters​

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

Returns​

AbstractG3000PfdPlugin

Inherited from​

AvionicsPlugin.constructor

Properties​

binder​

protected readonly binder: G3000PfdPluginBinder

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

The avionics specific plugin binder to accept from the system.

Implementation of​

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

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

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

G3000PfdPlugin.onComponentRendered

Inherited from​

AvionicsPlugin.onComponentRendered

Methods​

getWeightBalancePaneViewModule()​

getWeightBalancePaneViewModule(): WeightBalancePaneViewModule | undefined

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

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​

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

G3000PfdPlugin.loadCss

Inherited from​

AvionicsPlugin.loadCss


onInit()​

onInit(): void

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

Lifecycle method called during instrument initialization.

Returns​

void

Implementation of​

G3000PfdPlugin.onInit


onInstalled()​

onInstalled(): void

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

A callback run when the plugin has been installed.

Returns​

void

Implementation of​

G3000PfdPlugin.onInstalled

Overrides​

AvionicsPlugin.onInstalled


registerDisplayPaneViews()​

registerDisplayPaneViews(viewFactory): void

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

Registers display pane views.

Parameters​

ParameterTypeDescription
viewFactoryDisplayPaneViewFactoryThe factory with which to register views.

Returns​

void

Implementation of​

G3000PfdPlugin.registerDisplayPaneViews


registerSoftkeyMenus()​

registerSoftkeyMenus(menuSystem, pfdIndex): void

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

Registers softkey menus.

Parameters​

ParameterTypeDescription
menuSystemSoftKeyMenuSystemThe softkey menu system with which to register menus.
pfdIndexPfdIndexThe index of the softkey menu system's parent PFD.

Returns​

void

Implementation of​

G3000PfdPlugin.registerSoftkeyMenus


renderToPfdInstruments()​

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

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

Renders components to the PFD instrument container.

Parameters​

ParameterTypeDescription
pfdIndexPfdIndexThe index of the instrument container's parent PFD.
displayPaneIndexLeftPfdInstrument | RightPfdInstrumentThe index of the instrument container's display pane.
isInSplitModeSubscribable<boolean>Whether the PFD is in split mode.
declutterSubscribable<boolean>Whether the PFD is decluttered.

Returns​

VNode | null

Implementation of​

G3000PfdPlugin.renderToPfdInstruments