addDrillDownForInsightWidget()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates the AddDrillDownForInsightWidget command. Dispatching the created command will create insight widget’s drill definition for the provided measure.
export declare function addDrillDownForInsightWidget(ref: ObjRef, attributeIdentifier: ObjRef, drillDownIdentifier: string, drillDownAttributeHierarchyRef: ObjRef, intersectionIgnoredAttributes?: string[], correlationId?: string): IAddDrillDownForInsightWidget;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of insight widget whose drill should be created | |
attributeIdentifier | drill localIdentifier that should be added. | |
drillDownIdentifier | string | drill down hierarchy localIdentifier that should be added. |
drillDownAttributeHierarchyRef | drill down hierarchy reference that should be added. | |
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