Skip to main content

Class: AbstractG3XTouchPlugin

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

Hierarchy

Implements

Constructors

constructor

new AbstractG3XTouchPlugin(binder): AbstractG3XTouchPlugin

Creates an instance of a Plugin.

Parameters

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

Returns

AbstractG3XTouchPlugin

Inherited from

AvionicsPlugin<G3XTouchPluginBinder>.constructor

Defined in

src/sdk/components/FSComponent.ts:1424

Properties

binder

Protected Readonly binder: G3XTouchPluginBinder

The avionics specific plugin binder to accept from the system.

Implementation of

G3XTouchPlugin.binder

Inherited from

AvionicsPlugin.binder

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
NameType
componentDisplayComponent<any, []>
Returns

void

Implementation of

G3XTouchPlugin.onComponentCreated

Inherited from

AvionicsPlugin.onComponentCreated

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
NameType
constructorDisplayComponentFactory<any, []>
propsany
Returns

undefined | DisplayComponent<any, []>

Implementation of

G3XTouchPlugin.onComponentCreating

Inherited from

AvionicsPlugin.onComponentCreating

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
NameType
nodeVNode
Returns

void

Implementation of

G3XTouchPlugin.onComponentRendered

Inherited from

AvionicsPlugin.onComponentRendered

Defined in

src/sdk/components/FSComponent.ts:1451

Methods

loadCss

loadCss(uri): Promise<void>

Loads a CSS file into the instrument.

Parameters

NameTypeDescription
uristringThe URI to the CSS file.

Returns

Promise<void>

Implementation of

G3XTouchPlugin.loadCss

Inherited from

AvionicsPlugin.loadCss

Defined in

src/sdk/components/FSComponent.ts:1457


onInit

onInit(): void

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

Returns

void

Implementation of

G3XTouchPlugin.onInit

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:145


onInstalled

onInstalled(): void

A callback run when the plugin has been installed.

Returns

void

Implementation of

G3XTouchPlugin.onInstalled

Overrides

AvionicsPlugin.onInstalled

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:140