Skip to main content

Abstract Class: Epic2PfdAvionicsPlugin

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/PFD/Epic2PfdAvionicsPlugin.ts:11

A Epic2 PFD plugin.

Extends​

Constructors​

Constructor​

new Epic2PfdAvionicsPlugin(binder): Epic2PfdAvionicsPlugin

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

Creates an instance of a Plugin.

Parameters​

ParameterTypeDescription
binderEpic2PluginBinderThe avionics specific plugin binder to accept from the system.

Returns​

Epic2PfdAvionicsPlugin

Inherited from​

Epic2AvionicsPlugin.constructor

Properties​

binder​

protected readonly binder: Epic2PluginBinder

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

The avionics specific plugin binder to accept from the system.

Inherited from​

Epic2AvionicsPlugin.binder


onComponentCreated()?​

optional onComponentCreated: (component) => void

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

Epic2AvionicsPlugin.onComponentCreated


onComponentCreating()?​

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

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

Epic2AvionicsPlugin.onComponentCreating


onComponentRendered()?​

optional onComponentRendered: (node) => void

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

Epic2AvionicsPlugin.onComponentRendered

Methods​

loadCss()​

protected loadCss(uri): Promise<void>

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

Epic2AvionicsPlugin.loadCss


onInstalled()​

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns​

void

Inherited from​

Epic2AvionicsPlugin.onInstalled


renderEIS()?​

optional renderEIS(): VNode | null

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/PFD/Epic2PfdAvionicsPlugin.ts:16

Allows rendering components to the EIS container.

Returns​

VNode | null

The rendered EIS vnode.