IDashboardPluginContract\_V1

Home > @gooddata/sdk-ui-dashboard > IDashboardPluginContract_V1

IDashboardPluginContract_V1 type

Raw, low-level interface that the dashboard plugins need to implement.

Signature:

export type IDashboardPluginContract_V1 = DashboardPluginDescriptor & {
    readonly _pluginVersion: "1.0";
    onPluginLoaded?(ctx: DashboardContext, parameters?: string): Promise<void> | void;
    register(ctx: DashboardContext, customize: IDashboardCustomizer, eventing: IDashboardEventHandling): void;
    onPluginUnload?(ctx: DashboardContext): Promise<void> | void;
};

References: DashboardPluginDescriptor, DashboardContext, IDashboardCustomizer, IDashboardEventHandling

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 Dashboard() Component.

See DashboardPluginV1

← IDashboardMetaStateIDashboardProps →