Abstract Class: AbstractG3000PfdPlugin

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

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

Extends

• AvionicsPlugin<G3000PfdPluginBinder>

Implements

• G3000PfdPlugin

Constructors

Constructor

new AbstractG3000PfdPlugin(binder): AbstractG3000PfdPlugin

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

Creates an instance of a Plugin.

Parameters

Parameter	Type	Description
binder	G3000PfdPluginBinder	The avionics specific plugin binder to accept from the system.

Returns

AbstractG3000PfdPlugin

Inherited from

AvionicsPlugin<G3000PfdPluginBinder>.constructor

Properties

binder

protected readonly binder: G3000PfdPluginBinder

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

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

Implementation of

G3000PfdPlugin.onComponentCreated

Inherited from

AvionicsPlugin.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, []>

Implementation of

G3000PfdPlugin.onComponentCreating

Inherited from

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

Implementation of

G3000PfdPlugin.onComponentRendered

Inherited from

AvionicsPlugin.onComponentRendered

Methods

getWeightBalancePaneViewModule()

getWeightBalancePaneViewModule(): undefined | WeightBalancePaneViewModule

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

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.

Implementation of

G3000PfdPlugin.getWeightBalancePaneViewModule

---

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>

Implementation of

G3000PfdPlugin.loadCss

Inherited from

AvionicsPlugin.loadCss

---

onInit()

onInit(): void

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

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

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

Registers display pane views.

Parameters

Parameter	Type	Description
viewFactory	DisplayPaneViewFactory	The 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:91

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

Implementation of

G3000PfdPlugin.registerSoftkeyMenus

---

renderToPfdInstruments()

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

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

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

null | VNode

Implementation of

G3000PfdPlugin.renderToPfdInstruments