ModifyDrillsForInsightWidgetPayload · GoodData.UI API reference

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

ModifyDrillsForInsightWidgetPayload interface

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.

Payload of the ModifyDrillsForInsightWidget command.

Signature:

export interface ModifyDrillsForInsightWidgetPayload

Properties

Property Modifiers Type Description

blacklistHierarchiesToUpdate? readonly IDrillDownReference[] (BETA) (Optional) Specify which drill down localIdentifier and its hierarchy should be removed.

Property	Modifiers	Type	Description
blacklistHierarchiesToUpdate?	`readonly`	IDrillDownReference[]	*(BETA)* (Optional) Specify which drill down localIdentifier and its hierarchy should be removed.
drills	`readonly`	InsightDrillDefinition[]	*(BETA)* New drill definitions. The drills are defined per measure in insight and there can be exactly one drill definition for insight measure. The newly provided items will be matches to existing items by the measure they are linked to. The definition of drill for that measure will be modified. Note: this can do upsert. if you specify drill for a measure and there is no existing drill for it, then the new definition will be used.
ref	`readonly`	ObjRef	*(BETA)* Reference to Insight Widget whose drill items should be modified.

drills

readonly

InsightDrillDefinition[]

(BETA) New drill definitions. The drills are defined per measure in insight and there can be exactly one drill definition for insight measure.

The newly provided items will be matches to existing items by the measure they are linked to. The definition of drill for that measure will be modified.

Note: this can do upsert. if you specify drill for a measure and there is no existing drill for it, then the new definition will be used.

ref readonly ObjRef (BETA) Reference to Insight Widget whose drill items should be modified.