IModifyDrillsForInsightWidgetPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IModifyDrillsForInsightWidget command.
export interface IModifyDrillsForInsightWidgetPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) (Optional) Specify which drill down localIdentifier and its hierarchy should be removed. | ||
| (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. | ||
| (BETA) Reference to Insight Widget whose drill items should be modified. |
Property details
IModifyDrillsForInsightWidgetPayload.blacklistHierarchiesToUpdatepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Specify which drill down localIdentifier and its hierarchy should be removed.
readonly blacklistHierarchiesToUpdate?: IDrillDownReference[];
IModifyDrillsForInsightWidgetPayload.drillspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
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.
readonly drills: InsightDrillDefinition[];
IModifyDrillsForInsightWidgetPayload.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Reference to Insight Widget whose drill items should be modified.
readonly ref: ObjRef;