Abstract Class: AvionicsPlugin<T>

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

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

Type Parameters

Type Parameter
T

Constructors

Constructor

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

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

Creates an instance of a Plugin.

Parameters

Parameter	Type	Description
binder	T	The 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:1461

The avionics specific plugin binder to accept from the system.

---

onComponentCreated()?

optional onComponentCreated: (component) => void

Defined in: src/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

Parameter	Type
component	DisplayComponent<any>

Returns

void

---

onComponentCreating()?

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

Defined in: src/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

Parameter	Type
constructor	DisplayComponentFactory<any>
props	any

Returns

undefined | DisplayComponent<any, []>

---

onComponentRendered()?

optional onComponentRendered: (node) => void

Defined in: src/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

Parameter	Type
node	VNode

Returns

void

Methods

loadCss()

protected loadCss(uri): Promise<void>

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

Loads a CSS file into the instrument.

Parameters

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

Returns

Promise<void>

---

onInstalled()

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns

void