Class: AvionicsPlugin<T>
A plugin that is created and managed by the plugin system.
Type parameters
| Name |
|---|
T |
Constructors
constructor
• new AvionicsPlugin<T>(binder): AvionicsPlugin<T>
Creates an instance of a Plugin.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
binder | T | The avionics specific plugin binder to accept from the system. |
Returns
Defined in
src/sdk/components/FSComponent.ts:1424
Properties
binder
• Protected Readonly binder: T
The avionics specific plugin binder to accept from the system.
Defined in
src/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
| Name | Type |
|---|---|
component | DisplayComponent<any, []> |
Returns
void
Defined in
src/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
| Name | Type |
|---|---|
constructor | DisplayComponentFactory<any, []> |
props | any |
Returns
undefined | DisplayComponent<any, []>
Defined in
src/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
| Name | Type |
|---|---|
node | VNode |
Returns
void
Defined in
src/sdk/components/FSComponent.ts:1451
Methods
loadCss
▸ loadCss(uri): Promise<void>
Loads a CSS file into the instrument.
Parameters
| Name | Type | Description |
|---|---|---|
uri | string | The URI to the CSS file. |
Returns
Promise<void>
Defined in
src/sdk/components/FSComponent.ts:1457
onInstalled
▸ onInstalled(): void
A callback run when the plugin has been installed.
Returns
void
Defined in
src/sdk/components/FSComponent.ts:1429