modifyDrillsForInsightWidget()

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

modifyDrillsForInsightWidget() 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 ModifyDrillsForInsightWidget command. Dispatching the created command will add or modify a new drill for the insight widget.

Drill can be setup for particular measure - meaning elements in the insight will be clickable. Exactly one drill can be specified for a measure.

What happens on click depends on the context in which the dashboard lives:

• When in KPI Dashboard (embedded or not) the defined action is actually triggered and done - it may open a new tab, open overlay with insight, navigate to a new dashboard and carry over the filters. - When the dashboard is embedded using Dashboard component, an event will be emitted describing the defined drill action.

Signature:

export declare function modifyDrillsForInsightWidget(ref: ObjRef, drills: InsightDrillDefinition[], blacklistHierarchiesToUpdate?: IDrillDownReference[], correlationId?: string): IModifyDrillsForInsightWidget;

Parameters

Parameter	Type	Description
ref	ObjRef	reference to insight widget whose drills should be modified
drills	InsightDrillDefinition[]	drills to add or modify.
blacklistHierarchiesToUpdate	IDrillDownReference[]	(Optional)
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:

IModifyDrillsForInsightWidget