Interface: G3000GtcPlugin

Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:42

A G3000 GTC plugin.

Extends

• G3000Plugin<G3000GtcPluginBinder>.GtcInteractionHandler

Properties

binder

protected readonly binder: G3000GtcPluginBinder

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

The avionics specific plugin binder to accept from the system.

Inherited from

G3000Plugin.binder

---

onComponentCreated()?

optional onComponentCreated: (component) => void

Defined in: 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

G3000Plugin.onComponentCreated

---

onComponentCreating()?

optional onComponentCreating: (constructor, props) => undefined | DisplayComponent<any, []>

Defined in: 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

G3000Plugin.onComponentCreating

---

onComponentRendered()?

optional onComponentRendered: (node) => void

Defined in: 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

G3000Plugin.onComponentRendered

Methods

getChecklistDef()?

optional getChecklistDef(): undefined | G3000ChecklistSetDef

Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:62

Gets a checklist definition to be used by the electronic checklist system.

Returns

undefined | G3000ChecklistSetDef

A checklist definition, or undefined if checklists are not to be supported.

Inherited from

G3000Plugin.getChecklistDef

---

getKnobStateOverrides()

getKnobStateOverrides(gtcService): null | Readonly<GtcKnobStatePluginOverrides>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:57

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

Parameter	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.

---

getLabelBarHandlers()

getLabelBarHandlers(): null | Readonly<LabelBarPluginHandlers>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:64

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.

---

loadCss()

protected loadCss(uri): Promise<void>

Defined in: 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

G3000Plugin.loadCss

---

onChecklistInit()?

optional onChecklistInit(checklistDef, checklistStateProvider?): void

Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:70

Lifecycle method called when the electronic checklist system is initialized.

Parameters

Parameter	Type	Description
checklistDef	undefined | G3000ChecklistSetDef	The checklist definition used by the checklist system, or undefined if checklists are not supported.
checklistStateProvider?	G3000ChecklistStateProvider	A provider of checklist state, or undefined if checklists are not supported.

Returns

void

Inherited from

G3000Plugin.onChecklistInit

---

onGtcInteractionEvent()

onGtcInteractionEvent(event): boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcInteractionEvent.ts:51

Handles a GtcInteractionEvent.

Parameters

Parameter	Type	Description
event	GtcInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Inherited from

GtcInteractionHandler.onGtcInteractionEvent

---

onInit()

onInit(): void

Defined in: workingtitle-instruments-g3000/html_ui/Shared/G3000Plugin.ts:56

Lifecycle method called during instrument initialization.

Returns

void

Inherited from

G3000Plugin.onInit

---

onInstalled()

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns

void

Inherited from

G3000Plugin.onInstalled

---

registerGtcViews()

registerGtcViews(gtcService, context): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:48

Registers GTC views.

Parameters

Parameter	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