IDashboardEngine

Dashboard Engine encapsulates a particular build of the Dashboard() component and provides factory methods to create the Dashboard component’s customization-related props using one or more plugins.

export interface IDashboardEngine

Properties

Property	Modifiers	Type	Description
version	`readonly`	string	Version of the dashboard engine.

Methods

Method	Description
getDashboardComponent()	Returns Dashboard component provided by this dashboard engine.
initializePlugins(ctx, plugins)	Drives initialization of loaded dashboard plugins and their registration logic.

Property details

`IDashboardEngine.version`property

Version of the dashboard engine.

readonly version: string;

Method details

`IDashboardEngine.getDashboardComponent()`method

Returns Dashboard component provided by this dashboard engine.

getDashboardComponent(): ComponentType<IDashboardProps>;

Returns

ComponentType<IDashboardProps>

`IDashboardEngine.initializePlugins()`method

Drives initialization of loaded dashboard plugins and their registration logic.

initializePlugins(ctx: DashboardContext, plugins: IDashboardPluginContract_V1[]): IDashboardExtensionProps;

Parameters

Parameter	Type	Description
ctx	DashboardContext	dashboard context in which the plugins operate
plugins	IDashboardPluginContract_V1[]	plugins to initialize

Returns

IDashboardExtensionProps

Remarks

During registration, the plugins register their customizations, contributions and event handlers.

The plugin’ contributions will be used to construct the dashboard extension props which can then be used as input to the dashboard component itself and thus achieve the integration of the plugins into the dashboard.