FilterOpReplaceAll

Home > @gooddata/sdk-ui-dashboard > FilterOpReplaceAll

FilterOpReplaceAll interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.

Signature:

export interface FilterOpReplaceAll extends FilterOp

Extends: FilterOp

Properties

PropertyModifiersTypeDescription
dateDatasetForFiltering?readonlyObjRef

(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.

ignoreAttributeFilters?readonlyObjRef[]

(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.

ignoreDateFilters?readonlyObjRef[]

(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.

type"replace"(BETA)
← FilterOpIgnoreDateFilterFilterOpReplaceAttributeIgnores →