IFilterOpReplaceAll
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
This filter operation completely replaces widget’s filter settings. Both date data set (and thus date filter) setting and the attribute filter ignore list will be replaced using the parameters in the operation body.
export interface IFilterOpReplaceAll extends IFilterOp
Extends: IFilterOp
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) (Optional) Date data set that will be used when constructing date filter for a widget. If the widget does not specify any dateDataSet, then no date filtering is applied to it. | ||
| ObjRef[] | (BETA) (Optional) Dashboard filters to ignore for particular widget. Specify ObjRefs of display forms that are used by dashboard’s attribute filters which you wish to disable. | |
| ObjRef[] | (BETA) (Optional) Dashboard date filters to ignore for particular widget. Specify ObjRefs of date data sets that are used by dashboard’s date filters which you wish to disable. | |
| ObjRef[] | (BETA) (Optional) Dashboard measure value filters to ignore for particular widget. Specify ObjRefs of measures that are used by dashboard’s measure value filters which you wish to disable. | |
“replace” | (BETA) |
Property details
IFilterOpReplaceAll.dateDatasetForFilteringpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Date data set that will be used when constructing date filter for a widget.
If the widget does not specify any dateDataSet, then no date filtering is applied to it.
readonly dateDatasetForFiltering?: ObjRef;
IFilterOpReplaceAll.ignoreAttributeFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Dashboard filters to ignore for particular widget.
Specify ObjRefs of display forms that are used by dashboard’s attribute filters which you wish to disable.
readonly ignoreAttributeFilters?: ObjRef[];
IFilterOpReplaceAll.ignoreDateFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Dashboard date filters to ignore for particular widget.
Specify ObjRefs of date data sets that are used by dashboard’s date filters which you wish to disable.
readonly ignoreDateFilters?: ObjRef[];
IFilterOpReplaceAll.ignoreMeasureValueFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Dashboard measure value filters to ignore for particular widget.
Specify ObjRefs of measures that are used by dashboard’s measure value filters which you wish to disable.
readonly ignoreMeasureValueFilters?: ObjRef[];
IFilterOpReplaceAll.typepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
type: "replace";