Interface: G3000MfdPlugin
A G3000 MFD plugin.
Hierarchy
G3000Plugin
<G3000MfdPluginBinder
>↳
G3000MfdPlugin
Implemented by
Properties
binder
• Protected
Readonly
binder: G3000MfdPluginBinder
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
getPersistentSettings
▸ getPersistentSettings(): Iterable
<UserSetting
<any
>>
Gets settings whose values should be saved across flight sessions.
Returns
Iterable
<UserSetting
<any
>>
An iterable of settings whose values should be saved across flight sessions.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/MFD/G3000MFDPlugin.ts:50
getStartupScreenRows
▸ getStartupScreenRows(): undefined
| readonly (StartupScreenRowFactory
| StartupScreenPrebuiltRow
)[]
Gets the data rows to render on the right side of the MFD startup screen. Each row is defined by either a function which returns an object describing the row to render, or a pre-built row key. Up to eleven rows can be rendered. This method is ignored if the system is not configured to support the startup screen.
Returns
undefined
| readonly (StartupScreenRowFactory
| StartupScreenPrebuiltRow
)[]
An array of rows to render on the right side of the MFD startup screen. The rows will be rendered from top to bottom in the order in which they appear in the array. If not defined, a default set of rows will be rendered.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/MFD/G3000MFDPlugin.ts:60
getToldModule
▸ getToldModule(): undefined
| ToldModule
Gets a module to be used for calculating takeoff and landing performance values. This method is only called if TOLD calculations are configured via panel.xml. If TOLD calculations are configured but a module is not provided by this method, then TOLD calculations will be disabled.
Returns
undefined
| ToldModule
A TOLD module, or undefined
if no TOLD module is to be used.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/MFD/G3000MFDPlugin.ts:44
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
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
registerDisplayPaneViews
▸ registerDisplayPaneViews(viewFactory
): void
Registers display pane views.
Parameters
Name | Type | Description |
---|---|---|
viewFactory | DisplayPaneViewFactory | The factory with which to register views. |
Returns
void
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/MFD/G3000MFDPlugin.ts:36
renderEis
▸ renderEis(): null
| VNode
Renders the EIS.
Returns
null
| VNode
The EIS, as a VNode, or null
if no EIS is to be rendered.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/MFD/G3000MFDPlugin.ts:30