Interface: G3XTouchPlugin

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

A G3X Touch plugin.

Extends

• AvionicsPlugin<G3XTouchPluginBinder>

Properties

binder

protected readonly binder: G3XTouchPluginBinder

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

The avionics specific plugin binder to accept from the system.

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

Parameter	Type
component	DisplayComponent<any>

Returns

void

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

Parameter	Type
constructor	DisplayComponentFactory<any>
props	any

Returns

undefined | DisplayComponent<any, []>

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

Parameter	Type
node	VNode

Returns

void

Inherited from

AvionicsPlugin.onComponentRendered

Methods

getPersistentGlobalSettings()?

optional getPersistentGlobalSettings(): Iterable<UserSetting<any>>

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

Gets global user settings whose values should be saved across flight sessions. Global settings are those with (un-aliased) names that are unique across the entire airplane.

Returns

Iterable<UserSetting<any>>

An iterable of global user settings whose values should be saved across flight sessions.

---

getPersistentLocalSettings()?

optional getPersistentLocalSettings(): Iterable<UserSetting<any>>

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

Gets instrument-local user settings whose values should be saved across flight sessions. Instrument-local user settings are those with (un-aliased) names that are only unique to their local JS instrument.

Returns

Iterable<UserSetting<any>>

An iterable of instrument-local user settings whose values should be saved across flight sessions.

---

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>

Inherited from

AvionicsPlugin.loadCss

---

onInit()

onInit(): void

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

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

Returns

void

---

onInstalled()

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns

void

Inherited from

AvionicsPlugin.onInstalled

---

registerMfdMainPages()?

optional registerMfdMainPages(registrar, context): void

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

Registers MFD main pages.

Parameters

Parameter	Type	Description
registrar	MfdMainPageRegistrar	The registrar with which to register pages.
context	Readonly<G3XTouchUiComponentContext>	References to items used to create the base G3X Touch's MFD main pages.

Returns

void

---

registerPfdInsets()?

optional registerPfdInsets(registrar, context): void

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

Registers PFD insets.

Parameters

Parameter	Type	Description
registrar	PfdInsetRegistrar	The registrar with which to register insets.
context	Readonly<G3XTouchUiComponentContext>	References to items used to create the base G3X Touch's PFD insets.

Returns

void

---

registerPfdPages()?

optional registerPfdPages(registrar, context): void

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

Registers PFD pages.

Parameters

Parameter	Type	Description
registrar	PfdPageRegistrar	The registrar with which to register pages.
context	Readonly<G3XTouchUiComponentContext>	References to items used to create the base G3X Touch's PFD pages.

Returns

void

---

registerUiViews()?

optional registerUiViews(uiService, context): void

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

Registers UI views.

Parameters

Parameter	Type	Description
uiService	UiService	The UI service with which to register views.
context	Readonly<G3XTouchUiComponentContext>	A context containing references to items used to create the base G3X Touch's UI views.

Returns

void

---

renderEis()?

optional renderEis(): null | VNode

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

Renders the contents of the EIS.

Returns

null | VNode

The contents of the EIS, as a VNode, or null if nothing is to be rendered.

---

renderToPfdInstruments()?

optional renderToPfdInstruments(declutter): null | VNode

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

Renders components to the PFD instruments view. Any top-level component (not a child of another DisplayComponent) that implements the PfdInstrumentsPluginComponent interface will have its callback methods called in response to the corresponding triggers.

Parameters

Parameter	Type	Description
declutter	Subscribable<boolean>	Whether the PFD is decluttered.

Returns

null | VNode

Components to render to the PFD instruments view, as a VNode, or null if nothing is to be rendered.