withEmbeddedPlugins()
Home > @gooddata/sdk-ui-loaders > IDashboardLoader > withEmbeddedPlugins
IDashboardLoader.withEmbeddedPlugins() method
Specify embedded plugins to use on top of any plugins that the dashboard is already configured to use.
Signature:
withEmbeddedPlugins(...plugins: IEmbeddedPlugin[]): IDashboardLoader;
Parameters
| Parameter | Type | Description |
|---|---|---|
| plugins | IEmbeddedPlugin[] | extra plugins to use |
Returns:
Remarks
The embedded plugins are implemented, built and linked into the application that loads the dashboard. There is no specific runtime loading and linkage required for these plugins.
The lifecycle of the embedded plugins follows the lifecycle of normal plugins that may be linked with the dashboard; instead of loading the plugin assets, the loader will call embedded plugin's factory function to obtain an instance of the actual dashboard plugin to use. From this point on, the lifecycle is the same as for normal plugins:
- The loader will call the onPluginLoaded, pass any parameters that may be specified for the embedded plugin 2. Plugin registration is done same as for normal plugins 3. The loader will call onPluginUnload when the dashboard containing the plugins gets unmounted