Interface: G3000GtcPlugin
A G3000 GTC plugin.
Hierarchy
G3000Plugin<G3000GtcPluginBinder>↳
G3000GtcPlugin
Implemented by
Properties
binder
• Protected Readonly binder: G3000GtcPluginBinder
The avionics specific plugin binder to accept from the system.
Inherited from
G3000Plugin.binder
Defined in
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
G3000Plugin.onComponentCreated
Defined in
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
G3000Plugin.onComponentCreating
Defined in
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
G3000Plugin.onComponentRendered
Defined in
sdk/components/FSComponent.ts:1451
Methods
getKnobStateOverrides
▸ getKnobStateOverrides(gtcService): null | Readonly<GtcKnobStatePluginOverrides>
Gets a set of GTC knob control state overrides. The knob control state overrides (if they are not null) will be
applied in place of the states defined by the base G3000 system and any plugins that were loaded before this
one.
Parameters
| Name | Type | Description |
|---|---|---|
gtcService | GtcService | The GTC service. |
Returns
null | Readonly<GtcKnobStatePluginOverrides>
A set of GTC knob state overrides, or null if this plugin does not define any overrides.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/G3000GTCPlugin.ts:51
getLabelBarHandlers
▸ getLabelBarHandlers(): null | Readonly<LabelBarPluginHandlers>
Gets a set of GTC label bar handlers. The labels returned by the handlers (if they are not null) will be applied
in place of the labels defined by the base G3000 system and any plugins that were loaded before this one.
Returns
null | Readonly<LabelBarPluginHandlers>
A set of GTC label bar handlers, or null if this plugin does not define any handlers.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/G3000GTCPlugin.ts:58
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
G3000Plugin.loadCss
Defined in
sdk/components/FSComponent.ts:1457
onGtcInteractionEvent
▸ onGtcInteractionEvent(event): boolean
Handles a GtcInteractionEvent.
Parameters
| Name | Type | Description |
|---|---|---|
event | GtcInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Inherited from
GtcInteractionHandler.onGtcInteractionEvent
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcInteractionEvent.ts:51
onInit
▸ onInit(): void
Lifecycle method called during instrument initialization.
Returns
void
Inherited from
G3000Plugin.onInit
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/G3000Plugin.ts:50
onInstalled
▸ onInstalled(): void
A callback run when the plugin has been installed.
Returns
void
Inherited from
G3000Plugin.onInstalled
Defined in
sdk/components/FSComponent.ts:1429
registerGtcViews
▸ registerGtcViews(gtcService, context): void
Registers GTC views.
Parameters
| Name | Type | Description |
|---|---|---|
gtcService | GtcService | The GTC service with which to register views. |
context | Readonly<G3000GtcViewContext> | A context containing references to items used to create the base G3000's GTC views. |
Returns
void
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/G3000GTCPlugin.ts:42