Skip to main content

Interface: FmcScreenPluginContext<P, E>

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:68

Interface for plugins to attach to an FMC screen

Type Parameters

Type Parameter
P extends AbstractFmcPage
E

Methods

addPluginPageRoute()

Call Signature

addPluginPageRoute<T>(route, page, routeEvent?): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:69

Type Parameters
Type Parameter
T extends null
Parameters
ParameterType
routestring
pagePageConstructor<P & AbstractFmcPage<T>>
routeEvent?keyof E & string
Returns

void

Call Signature

addPluginPageRoute<U>(route, page, routeEvent, defaultProps): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:82

Adds a page route to the FMC screen. Routes added by the avionics will have priority.

Type Parameters
Type Parameter
U extends PageConstructor<P, null>
Parameters
ParameterTypeDescription
routestringthe route
pageUthe page constructor
routeEventundefined | keyof E & stringthe FMC event, optionally, to bind the route to
defaultPropsU extends PageConstructor<AbstractFmcPage<V>, V> ? V : neverdefault props to pass in to the page
Returns

void


attachPageExtension()

attachPageExtension(pageClass, extension): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:104

Attaches a FmcPageExtension to a specific page class

Parameters

ParameterTypeDescription
pageClassPageConstructor<P>the page constructor (class) to attach the extension to
extension(...args) => FmcPageExtension<P>the extension class (will be instantiated whenever the page is created)

Returns

void


replacePageRoute()

replacePageRoute(route, page, routeEvent?): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:96

Adds a page route to the FMC screen. Has priority over routes added by the avionics.

Parameters

ParameterTypeDescription
routestringthe route
pagePageConstructor<P>the page constructor
routeEvent?keyof E & stringthe FMC event, optionally, to bind the route to

Returns

void