Interface: G3XTouchPlugin
A G3X Touch plugin.
Hierarchy
AvionicsPlugin<G3XTouchPluginBinder>↳
G3XTouchPlugin
Implemented by
Properties
binder
• Protected Readonly binder: G3XTouchPluginBinder
The avionics specific plugin binder to accept from the system.
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
| Name | Type |
|---|---|
component | DisplayComponent<any, []> |
Returns
void
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
| Name | Type |
|---|---|
constructor | DisplayComponentFactory<any, []> |
props | any |
Returns
undefined | DisplayComponent<any, []>
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
| Name | Type |
|---|---|
node | VNode |
Returns
void
Inherited from
AvionicsPlugin.onComponentRendered
Defined in
src/sdk/components/FSComponent.ts:1451
Methods
getPersistentGlobalSettings
▸ getPersistentGlobalSettings(): Iterable<UserSetting<any>>
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.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:124
getPersistentLocalSettings
▸ getPersistentLocalSettings(): Iterable<UserSetting<any>>
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.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:131
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>
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:74
onInstalled
▸ onInstalled(): void
A callback run when the plugin has been installed.
Returns
void
Inherited from
AvionicsPlugin.onInstalled
Defined in
src/sdk/components/FSComponent.ts:1429
registerMfdMainPages
▸ registerMfdMainPages(registrar, context): void
Registers MFD main pages.
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:88
registerPfdInsets
▸ registerPfdInsets(registrar, context): void
Registers PFD insets.
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:102
registerPfdPages
▸ registerPfdPages(registrar, context): void
Registers PFD pages.
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:95
registerUiViews
▸ registerUiViews(uiService, context): void
Registers UI views.
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:81
renderEis
▸ renderEis(): null | VNode
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.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:108
renderToPfdInstruments
▸ renderToPfdInstruments(declutter): null | VNode
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
| Name | 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.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/G3XTouchPlugin.ts:117