Skip to main content

Class: WT21FmcAvionicsPlugin

A WT21 FMC plugin.

Hierarchy

Constructors

constructor

new WT21FmcAvionicsPlugin(binder): WT21FmcAvionicsPlugin

Creates an instance of a Plugin.

Parameters

NameTypeDescription
binderWT21FmcPluginBinderThe avionics specific plugin binder to accept from the system.

Returns

WT21FmcAvionicsPlugin

Inherited from

WT21AvionicsPlugin<WT21FmcPluginBinder>.constructor

Defined in

sdk/components/FSComponent.ts:1424

Properties

binder

Protected Readonly binder: WT21FmcPluginBinder

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
NameType
componentDisplayComponent<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
NameType
constructorDisplayComponentFactory<any, []>
propsany
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
NameType
nodeVNode
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

NameTypeDescription
uristringThe 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


registerFmcExtensions

registerFmcExtensions(context): void

Method that is called with a FmcScreenPluginContext, letting the plugin register extensions to the FMC screen

Parameters

NameTypeDescription
contextFmcScreenPluginContext<WT21FmcPage<null>, WT21FmcEvents>the FMC screen plugin context

Returns

void

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcAvionicsPlugin.ts:24