Class: WT21MfdAvionicsPlugin

A WT21 MFD plugin

TODO separate out into interface and abstract class

Hierarchy

• WT21AvionicsPlugin<WT21MfdPluginBinder>

  ↳ WT21MfdAvionicsPlugin

Constructors

constructor

• new WT21MfdAvionicsPlugin(binder): WT21MfdAvionicsPlugin

Creates an instance of a Plugin.

Parameters

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

Returns

WT21MfdAvionicsPlugin

Inherited from

WT21AvionicsPlugin<WT21MfdPluginBinder>.constructor

Defined in

sdk/components/FSComponent.ts:1424

Properties

binder

• Protected Readonly binder: WT21MfdPluginBinder

The avionics specific plugin binder to accept from the system.

Inherited from

WT21AvionicsPlugin.binder

Defined in

sdk/components/FSComponent.ts:1424

---

onComponentCreated

• Optional onComponentCreated: (component: DisplayComponent<any, []>) => void

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.

Type declaration

▸ (component): void

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

Name	Type
component	DisplayComponent<any, []>

Returns

void

Inherited from

WT21AvionicsPlugin.onComponentCreated

Defined in

sdk/components/FSComponent.ts:1444

---

onComponentCreating

• Optional onComponentCreating: (constructor: DisplayComponentFactory<any, []>, props: any) => undefined | DisplayComponent<any, []>

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.

Type declaration

▸ (constructor, props): undefined | DisplayComponent<any, []>

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

Name	Type
constructor	DisplayComponentFactory<any, []>
props	any

Returns

undefined | DisplayComponent<any, []>

Inherited from

WT21AvionicsPlugin.onComponentCreating

Defined in

sdk/components/FSComponent.ts:1437

---

onComponentRendered

• Optional onComponentRendered: (node: VNode) => void

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.

Type declaration

▸ (node): void

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

Name	Type
node	VNode

Returns

void

Inherited from

WT21AvionicsPlugin.onComponentRendered

Defined in

sdk/components/FSComponent.ts:1451

Methods

loadCss

▸ loadCss(uri): Promise<void>

Loads a CSS file into the instrument.

Parameters

Name	Type	Description
uri	string	The URI to the CSS file.

Returns

Promise<void>

Inherited from

WT21AvionicsPlugin.loadCss

Defined in

sdk/components/FSComponent.ts:1457

---

onInstalled

▸ onInstalled(): void

A callback run when the plugin has been installed.

Returns

void

Inherited from

WT21AvionicsPlugin.onInstalled

Defined in

sdk/components/FSComponent.ts:1429

---

registerExtraMfdTextPages

▸ registerExtraMfdTextPages(context): void

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

Parameters

Name	Type	Description
context	MfdTextPagesContext	the MFD text page context

Returns

void

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/WT21MfdAvionicsPlugin.ts:52

---

renderEis

▸ renderEis(): VNode

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

Returns

VNode

a VNode representing the EIS

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/WT21MfdAvionicsPlugin.ts:35

---

renderSystemPages

▸ renderSystemPages(onRefCreated?): WT21MfdPluginSystemsPageDefinition[]

Method called to render system pages on the MFD

Parameters

Name	Type	Description
onRefCreated?	(pageIndex: number, ref: NodeReference<DisplayComponent<any, []> & SystemsPageComponent>) => 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

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/WT21MfdAvionicsPlugin.ts:45