Skip to main content

Abstract Class: WT21AvionicsPlugin<B>

Defined in: workingtitle-instruments-wt21/shared/WT21AvionicsPlugin.ts:21

An avionics plugin for the WT21.

Extends

  • AvionicsPlugin<B>

Type Parameters

Type ParameterDefault type
B extends WT21PluginBinderWT21PluginBinder

Constructors

Constructor

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

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

Creates an instance of a Plugin.

Parameters

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

Returns

WT21AvionicsPlugin<B>

Inherited from

AvionicsPlugin<B>.constructor

Properties

binder

protected readonly binder: B

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

The avionics specific plugin binder to accept from the system.

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

ParameterType
componentDisplayComponent<any>

Returns

void

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

ParameterType
constructorDisplayComponentFactory<any>
propsany

Returns

undefined | DisplayComponent<any, []>

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

ParameterType
nodeVNode

Returns

void

Inherited from

AvionicsPlugin.onComponentRendered

Methods

loadCss()

protected loadCss(uri): Promise<void>

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

Loads a CSS file into the instrument.

Parameters

ParameterTypeDescription
uristringThe URI to the CSS file.

Returns

Promise<void>

Inherited from

AvionicsPlugin.loadCss


onInstalled()

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns

void

Inherited from

AvionicsPlugin.onInstalled