Abstract Class: AbstractG3000GtcPlugin
Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:71
An abstract implementation of G3000GtcPlugin that by default does nothing. Subclasses should override the appropriate methods to provide desired functionality.
Extends
AvionicsPlugin
<G3000GtcPluginBinder
>
Implements
Constructors
Constructor
new AbstractG3000GtcPlugin(
binder
):AbstractG3000GtcPlugin
Defined in: sdk/components/FSComponent.ts:1461
Creates an instance of a Plugin.
Parameters
Parameter | Type | Description |
---|---|---|
binder | G3000GtcPluginBinder | The avionics specific plugin binder to accept from the system. |
Returns
AbstractG3000GtcPlugin
Inherited from
AvionicsPlugin<G3000GtcPluginBinder>.constructor
Properties
binder
protected
readonly
binder:G3000GtcPluginBinder
Defined in: sdk/components/FSComponent.ts:1461
The avionics specific plugin binder to accept from the system.
Implementation of
Inherited from
AvionicsPlugin.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
Implementation of
G3000GtcPlugin
.onComponentCreated
Inherited from
AvionicsPlugin.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
, []>
Implementation of
G3000GtcPlugin
.onComponentCreating
Inherited from
AvionicsPlugin.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
Implementation of
G3000GtcPlugin
.onComponentRendered
Inherited from
AvionicsPlugin.onComponentRendered
Methods
getKnobStateOverrides()
getKnobStateOverrides(
gtcService
):null
|Readonly
<GtcKnobStatePluginOverrides
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:90
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.
Implementation of
G3000GtcPlugin
.getKnobStateOverrides
getLabelBarHandlers()
getLabelBarHandlers():
null
|Readonly
<LabelBarPluginHandlers
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:96
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.
Implementation of
G3000GtcPlugin
.getLabelBarHandlers
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
>
Implementation of
Inherited from
AvionicsPlugin.loadCss
onGtcInteractionEvent()
onGtcInteractionEvent(
event
):boolean
Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:102
Handles a GtcInteractionEvent.
Parameters
Parameter | Type | Description |
---|---|---|
event | GtcInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Implementation of
G3000GtcPlugin
.onGtcInteractionEvent
onInit()
onInit():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:78
Lifecycle method called during instrument initialization.
Returns
void
Implementation of
onInstalled()
onInstalled():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:73
A callback run when the plugin has been installed.
Returns
void
Implementation of
Overrides
AvionicsPlugin.onInstalled
registerGtcViews()
registerGtcViews(
gtcService
,context
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/G3000GTCPlugin.ts:84
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