Skip to main content

Interface: G3000Plugin<Binder>

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

A G3000 plugin.

Extends​

Extended by​

Type Parameters​

Type ParameterDefault type
Binder extends G3000PluginBinderG3000PluginBinder

Properties​

binder​

protected readonly binder: Binder

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

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:2090

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​

ParameterType
componentDisplayComponent<any>

Returns​

void

Inherited from​

AvionicsPlugin.onComponentCreated


onComponentCreating()?​

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

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

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​

ParameterType
constructorDisplayComponentFactory<any>
propsany

Returns​

DisplayComponent<any, []> | undefined

Inherited from​

AvionicsPlugin.onComponentCreating


onComponentRendered()?​

optional onComponentRendered: (node) => void

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

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​

ParameterType
nodeVNode

Returns​

void

Inherited from​

AvionicsPlugin.onComponentRendered

Methods​

getChartsSources()?​

optional getChartsSources(): Iterable<G3000ChartsSourceFactory, any, any> | undefined

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

Gets factories for additional electronic charts sources.

Returns​

Iterable<G3000ChartsSourceFactory, any, any> | undefined

Factories for additional electronic charts sources, or undefined if there are no additional sources.


getChecklistDef()?​

optional getChecklistDef(): G3000ChecklistSetDef | undefined

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

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

Returns​

G3000ChecklistSetDef | undefined

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


loadCss()​

protected loadCss(uri): Promise<void>

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

Loads a CSS file into the instrument.

Parameters​

ParameterTypeDescription
uristringThe URI to the CSS file.

Returns​

Promise<void>

Inherited from​

AvionicsPlugin.loadCss


onChecklistInit()?​

optional onChecklistInit(checklistDef, checklistStateProvider?): void

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

Lifecycle method called when the electronic checklist system is initialized.

Parameters​

ParameterTypeDescription
checklistDefG3000ChecklistSetDef | undefinedThe checklist definition used by the checklist system, or undefined if checklists are not supported.
checklistStateProvider?G3000ChecklistStateProviderA provider of checklist state, or undefined if checklists are not supported.

Returns​

void


onInit()​

onInit(): void

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

Lifecycle method called during instrument initialization.

Returns​

void


onInstalled()​

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns​

void

Inherited from​

AvionicsPlugin.onInstalled


renderToDisplayOverlay()?​

optional renderToDisplayOverlay(): VNode | null

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

Renders components to the display overlay.

Returns​

VNode | null

A VNode to render to the display overlay, or null to render nothing.