getDashboardPlugin()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > getDashboardPlugin

IWorkspaceDashboardsService.getDashboardPlugin() 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.

Load dashboard plugin by it's reference.

Signature:

getDashboardPlugin(ref: ObjRef, options?: IGetDashboardPluginOptions): Promise<IDashboardPlugin>;

Parameters

Parameter

Type

Description

ref

ObjRef

plugin reference

options

IGetDashboardPluginOptions

(Optional) options that specify how the plugin should be loaded

Returns:

Promise<IDashboardPlugin>