Abstract Class: WT21MfdAvionicsPlugin

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21v2/MFD/WT21MfdAvionicsPlugin.ts:29

A WT21 MFD plugin

TODO separate out into interface and abstract class

Extends

• WT21AvionicsPlugin<WT21MfdPluginBinder>

Constructors

Constructor

new WT21MfdAvionicsPlugin(binder): WT21MfdAvionicsPlugin

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

Creates an instance of a Plugin.

Parameters

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

Returns

WT21MfdAvionicsPlugin

Inherited from

WT21AvionicsPlugin.constructor

Properties

binder

protected readonly binder: WT21MfdPluginBinder

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

The avionics specific plugin binder to accept from the system.

Inherited from

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

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

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

WT21AvionicsPlugin.onComponentRendered

Methods

getChecklistDef()?

optional getChecklistDef(): undefined | WT21ChecklistSetDef

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21v2/MFD/WT21MfdAvionicsPlugin.ts:58

Gets a checklist definition to be used by the electronic checklist system.

Returns

undefined | WT21ChecklistSetDef

A checklist definition, or undefined if checklists are not to be supported.

---

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

WT21AvionicsPlugin.loadCss

---

onChecklistInit()?

optional onChecklistInit(checklistDef, checklistStateProvider?): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21v2/MFD/WT21MfdAvionicsPlugin.ts:66

Lifecycle method called when the electronic checklist system is initialized.

Parameters

Parameter	Type	Description
checklistDef	undefined | WT21ChecklistSetDef	The checklist definition used by the checklist system, or undefined if checklists are not supported.
checklistStateProvider?	WT21ChecklistStateProvider	A provider of checklist state, or undefined if checklists are not supported.

Returns

void

---

onInstalled()

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns

void

Inherited from

WT21AvionicsPlugin.onInstalled

---

registerExtraMfdTextPages()?

optional registerExtraMfdTextPages(context): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21v2/MFD/WT21MfdAvionicsPlugin.ts:52

Method that is called with a MfdTextPagesContext, letting the plugin register MFD text pages

Parameters

Parameter	Type	Description
context	MfdTextPagesContext	the MFD text page context

Returns

void

---

renderEis()?

optional renderEis(): VNode

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21v2/MFD/WT21MfdAvionicsPlugin.ts:35

Method called to render the Engine Indication System (EIS) on the MFD

Returns

VNode

a VNode representing the EIS

---

renderSystemPages()?

optional renderSystemPages(onRefCreated?): WT21MfdPluginSystemsPageDefinition[]

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21v2/MFD/WT21MfdAvionicsPlugin.ts:45

Method called to render system pages on the MFD

Parameters

Parameter	Type	Description
onRefCreated?	(pageIndex, ref) => void	a callback fired whenever a systems page is instantiated, with its index and a ref to it passed as the first argument

Returns

WT21MfdPluginSystemsPageDefinition[]

an array of VNodes representing systems pages