IModifyDrillDownForInsightWidgetPayload
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Payload of the IModifyDrillDownForInsightWidget command.
export interface IModifyDrillDownForInsightWidgetPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (ALPHA) Specify drill attribute hierarchy ref to be modified. | ||
| (ALPHA) Specify drill localIdentifier and its hierarchy should be modified. | ||
| (ALPHA) Specify hierarchies that should be added to the ignored hierarchies of the widget. If no blacklistHierarchies are provided, ignored hierarchies keep unchanged. | ||
| string[] | (ALPHA) (Optional) Specify local identifiers of attributes that should be ignored in drill intersection during drill down. If no intersectionIgnoredAttributes are provided, ignored attributes keep unchanged. | |
| (ALPHA) Reference to Insight Widget whose drill items should be modified. |
Property details
IModifyDrillDownForInsightWidgetPayload.attributeHierarchyRefpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Specify drill attribute hierarchy ref to be modified.
readonly attributeHierarchyRef: ObjRef;
IModifyDrillDownForInsightWidgetPayload.attributeIdentifierpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Specify drill localIdentifier and its hierarchy should be modified.
readonly attributeIdentifier: ObjRef;
IModifyDrillDownForInsightWidgetPayload.blacklistHierarchiespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Specify hierarchies that should be added to the ignored hierarchies of the widget. If no blacklistHierarchies are provided, ignored hierarchies keep unchanged.
readonly blacklistHierarchies: IDrillDownReference[];
IModifyDrillDownForInsightWidgetPayload.intersectionIgnoredAttributespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Specify local identifiers of attributes that should be ignored in drill intersection during drill down. If no intersectionIgnoredAttributes are provided, ignored attributes keep unchanged.
readonly intersectionIgnoredAttributes?: string[];
IModifyDrillDownForInsightWidgetPayload.refpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Reference to Insight Widget whose drill items should be modified.
readonly ref: ObjRef;