onPluginLoaded()

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

IDashboardPluginContract_V1.onPluginLoaded() method

This function will be called right after the plugin's asset are loaded.

Signature:

onPluginLoaded?(ctx: DashboardContext, parameters?: string): Promise<void> | void;

Parameters

Parameter	Type	Description
ctx	DashboardContext	dashboard context into which this plugin was loaded
parameters	string	(Optional) parameters that the dashboard specifies on its link to this plugin; these parameters are

Returns:

Promise<void> | void

Remarks

The plugin may do some early initialization and parameter parsing at this point.

Note that the parameterization that can be specified for the dashboard-plugin link can be edited freely by the dashboard creator - and may thus be incorrect.

If this function is not specified, then any parameters specified on the dashboard-plugin link will be ignored. If this function throws any exception, then your plugin will not be used on the dashboard.