Interface: FmcScreenPluginContext<P, E>
Interface for plugins to attach to an FMC screen
Type parameters
Name | Type |
---|---|
P | extends AbstractFmcPage |
E | E |
Implemented by
Methods
addPluginPageRoute
▸ addPluginPageRoute<T
>(route
, page
, routeEvent?
): void
Type parameters
Name | Type |
---|---|
T | extends null |
Parameters
Name | Type |
---|---|
route | string |
page | PageConstructor <P & AbstractFmcPage <T >, null > |
routeEvent? | keyof E & string |
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:69
▸ addPluginPageRoute<U
>(route
, page
, routeEvent
, defaultProps
): void
Adds a page route to the FMC screen. Routes added by the avionics will have priority.
Type parameters
Name | Type |
---|---|
U | extends PageConstructor <P , null > |
Parameters
Name | Type | Description |
---|---|---|
route | string | the route |
page | U | the page constructor |
routeEvent | undefined | keyof E & string | the FMC event, optionally, to bind the route to |
defaultProps | U extends PageConstructor <AbstractFmcPage <V >, V > ? V : never | default props to pass in to the page |
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:82
attachPageExtension
▸ attachPageExtension(pageClass
, extension
): void
Attaches a FmcPageExtension to a specific page class
Parameters
Name | Type | Description |
---|---|---|
pageClass | PageConstructor <P , null > | the page constructor (class) to attach the extension to |
extension | (...args : any []) => FmcPageExtension <P > | the extension class (will be instantiated whenever the page is created) |
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:104
replacePageRoute
▸ replacePageRoute(route
, page
, routeEvent?
): void
Adds a page route to the FMC screen. Has priority over routes added by the avionics.
Parameters
Name | Type | Description |
---|---|---|
route | string | the route |
page | PageConstructor <P , null > | the page constructor |
routeEvent? | keyof E & string | the FMC event, optionally, to bind the route to |
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:96