IDashboardPluginContract\_V1
Home > @gooddata/sdk-ui-dashboard > IDashboardPluginContract_V1
IDashboardPluginContract_V1 interface
Raw, low-level interface that the dashboard plugins need to implement.
Signature:
export interface IDashboardPluginContract_V1 extends DashboardPluginDescriptor
Extends: DashboardPluginDescriptor
Remarks
Through this interface the plugin communicates its metadata and provides functions that will be used by dashboard loader to obtain plugins customizations and contributions to apply on top of the Component.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _pluginVersion | readonly | "1.0" | Version of the SPI that is realized by the plugin. |
Methods
| Method | Description |
|---|---|
| onPluginLoaded(ctx, parameters)? | (Optional) This function will be called right after the plugin's asset are loaded. |
| onPluginUnload(ctx)? | (Optional) This function will be called when user navigates away from the dashboard that uses an instance of this plugin. |
| register(ctx, customize, eventing) | This function will be called before the dashboard initialization and rendering starts. |