Skip to main content

Abstract Class: AvionicsPlugin<T>

Defined in: src/sdk/components/FSComponent.ts:2065

A plugin that is created and managed by the plugin system.

Extended by​

Type Parameters​

Type Parameter
T

Constructors​

Constructor​

new AvionicsPlugin<T>(binder): AvionicsPlugin<T>

Defined in: src/sdk/components/FSComponent.ts:2070

Creates an instance of a Plugin.

Parameters​

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

Returns​

AvionicsPlugin<T>

Properties​

binder​

protected readonly binder: T

Defined in: src/sdk/components/FSComponent.ts:2070

The avionics specific plugin binder to accept from the system.


onComponentCreated()?​

optional onComponentCreated: (component) => void

Defined in: src/sdk/components/FSComponent.ts:2090

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


onComponentCreating()?​

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

Defined in: src/sdk/components/FSComponent.ts:2083

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​

DisplayComponent<any, []> | undefined


onComponentRendered()?​

optional onComponentRendered: (node) => void

Defined in: src/sdk/components/FSComponent.ts:2097

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

Methods​

loadCss()​

protected loadCss(uri): Promise<void>

Defined in: src/sdk/components/FSComponent.ts:2103

Loads a CSS file into the instrument.

Parameters​

ParameterTypeDescription
uristringThe URI to the CSS file.

Returns​

Promise<void>


onInstalled()​

abstract onInstalled(): void

Defined in: src/sdk/components/FSComponent.ts:2075

A callback run when the plugin has been installed.

Returns​

void