Skip to main content

Class: WT21AvionicsPlugin<B>

An avionics plugin for the WT21.

Type parameters

NameType
Bextends WT21PluginBinder = WT21PluginBinder

Hierarchy

  • AvionicsPlugin<B>

    WT21AvionicsPlugin

Constructors

constructor

new WT21AvionicsPlugin<B>(binder): WT21AvionicsPlugin<B>

Creates an instance of a Plugin.

Type parameters

NameType
Bextends WT21PluginBinder = WT21PluginBinder

Parameters

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

Returns

WT21AvionicsPlugin<B>

Inherited from

AvionicsPlugin<B>.constructor

Defined in

sdk/components/FSComponent.ts:1424

Properties

binder

Protected Readonly binder: B

The avionics specific plugin binder to accept from the system.

Inherited from

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

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

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

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

AvionicsPlugin.loadCss

Defined in

sdk/components/FSComponent.ts:1457


onInstalled

onInstalled(): void

A callback run when the plugin has been installed.

Returns

void

Inherited from

AvionicsPlugin.onInstalled

Defined in

sdk/components/FSComponent.ts:1429