modifyDrillDownForInsightWidget()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the ModifyDrillDownForInsightWidget command. Dispatching the created command will update insight widget’s drill definition for the provided measure.
export declare function modifyDrillDownForInsightWidget(ref: ObjRef, attributeIdentifier: ObjRef, attributeHierarchyRef: ObjRef, blacklistHierarchies: IDrillDownReference[], intersectionIgnoredAttributes?: string[], correlationId?: string): IModifyDrillDownForInsightWidget;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of insight widget whose drill should be modified | |
attributeIdentifier | drill localIdentifier and its hierarchy should be modified. | |
attributeHierarchyRef | drill attribute hierarchy ref to be modified. | |
blacklistHierarchies | 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