modifyDrillDownForInsightWidget()

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

modifyDrillDownForInsightWidget() function

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.

Creates the ModifyDrillDownForInsightWidget command. Dispatching the created command will update insight widget's drill definition for the provided measure.

Signature:

export declare function modifyDrillDownForInsightWidget(ref: ObjRef, attributeIdentifier: ObjRef, attributeHierarchyRef: ObjRef, blacklistHierarchies: IDrillDownReference[], intersectionIgnoredAttributes?: string[], correlationId?: string): IModifyDrillDownForInsightWidget;

Parameters

Parameter

Type

Description

ref

ObjRef

reference of insight widget whose drill should be modified

attributeIdentifier

ObjRef

drill localIdentifier and its hierarchy should be modified.

attributeHierarchyRef

ObjRef

drill attribute hierarchy ref to be modified.

blacklistHierarchies

IDrillDownReference[]

drill localIdentifiers and its hierarchy should be modified

intersectionIgnoredAttributes

string[]

(Optional) specify local identifiers of attributes that should be ignored in drill intersection during drill down.

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:

IModifyDrillDownForInsightWidget

← MetaExportDataAttributesmodifyDrillsForInsightWidget() →