createDashboardPlugin()
Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > createDashboardPlugin
IWorkspaceDashboardsService.createDashboardPlugin() method
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates a record about a dashboard plugin. Creating a new dashboard plugin does not impact any existing dashboards in the workspace.
In order to use a plugin on a dashboard, you need to create a link between the dashboard and the plugin. Multiple dashboards may link to a single plugin; each dashboard may link to the plugin with different plugin-specific parameters.
Signature:
createDashboardPlugin(plugin: IDashboardPluginDefinition): Promise<IDashboardPlugin>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| plugin | IDashboardPluginDefinition | definition of plugin to create |
Returns:
Promise<IDashboardPlugin>
Remarks
Analytical Backend only allows creating new dashboard plugins or deleting existing plugins. The goal behind this decision is to encourage safe, phased rollout of new plugin versions. You must first create a new dashboard plugin and then explicitly start using this new version on dashboards in order for changes to take effect.