changeKpiWidgetConfiguration()

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

changeKpiWidgetConfiguration() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the ChangeKpiWidgetConfiguration command. Dispatching this command will result is modification of the configuration that are effective for the particular kpi widget.

Through configuration, you can modify how is particular kpi rendered

If you want to clear any widget-level configuration, set config to undefined.

Signature:

export declare function changeKpiWidgetConfiguration(ref: ObjRef, config: IKpiWidgetConfiguration | undefined, correlationId?: string): IChangeKpiWidgetConfiguration;

Parameters

Parameter	Type	Description
ref	ObjRef	reference of the insight widget to modify
config	IKpiWidgetConfiguration | undefined	new configuration to set, undefined to clear any widget level config
correlationId	string	(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing

Returns:

IChangeKpiWidgetConfiguration