IDataFiltersService

Home > @gooddata/sdk-backend-spi > IDataFiltersService

IDataFiltersService interface

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

The service that returns information about data filters.

Currently, it supports only Workspace Data Filters but in future in can be extended with User Data Filters support.

Signature:

export interface IDataFiltersService

Methods

Method

Description

createDataFilter(newDataFilter)

(ALPHA) Create a new data filter (without setting).

deleteDataFilter(ref)

(ALPHA) Delete an existing data filter.

getDataFilters()

(ALPHA) Get data filters for the current workspace with their settings.

getWorkspaceDataFilters()

(ALPHA) Get data filters for the current workspace with their settings.

updateDataFilter(updatedDataFilter)

(ALPHA) Update an existing data filter. The setting is not updated, only the data filter.

updateDataFilterValue(dataFilter, values)

(ALPHA) Update value of existing data filter.

← IDashboardWithReferencesIDataSourcesService →