Skip to main content

Abstract Class: AbstractG3XTouchPlugin

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/G3XTouchPlugin.ts:138

An abstract implementation of G3XTouchPlugin that by default does nothing. Subclasses should override the appropriate methods to provide desired functionality.

Extends​

Implements​

Constructors​

Constructor​

new AbstractG3XTouchPlugin(binder): AbstractG3XTouchPlugin

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

Creates an instance of a Plugin.

Parameters​

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

Returns​

AbstractG3XTouchPlugin

Inherited from​

AvionicsPlugin<G3XTouchPluginBinder>.constructor

Properties​

binder​

protected readonly binder: G3XTouchPluginBinder

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

The avionics specific plugin binder to accept from the system.

Implementation of​

G3XTouchPlugin.binder

Inherited from​

AvionicsPlugin.binder


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​

ParameterType
componentDisplayComponent<any>

Returns​

void

Implementation of​

G3XTouchPlugin.onComponentCreated

Inherited from​

AvionicsPlugin.onComponentCreated


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​

ParameterType
constructorDisplayComponentFactory<any>
propsany

Returns​

undefined | DisplayComponent<any, []>

Implementation of​

G3XTouchPlugin.onComponentCreating

Inherited from​

AvionicsPlugin.onComponentCreating


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​

ParameterType
nodeVNode

Returns​

void

Implementation of​

G3XTouchPlugin.onComponentRendered

Inherited from​

AvionicsPlugin.onComponentRendered

Methods​

loadCss()​

protected loadCss(uri): Promise<void>

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

Loads a CSS file into the instrument.

Parameters​

ParameterTypeDescription
uristringThe URI to the CSS file.

Returns​

Promise<void>

Implementation of​

G3XTouchPlugin.loadCss

Inherited from​

AvionicsPlugin.loadCss


onInit()​

onInit(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/G3XTouchPlugin.ts:145

Lifecycle method called during instrument initialization, after all plugins have been loaded.

Returns​

void

Implementation of​

G3XTouchPlugin.onInit


onInstalled()​

onInstalled(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/G3XTouchPlugin.ts:140

A callback run when the plugin has been installed.

Returns​

void

Implementation of​

G3XTouchPlugin.onInstalled

Overrides​

AvionicsPlugin.onInstalled