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.

Supports both Workspace Data Filters and User Data Filters.

Signature:

export interface IDataFiltersService 

Methods

Method	Description
createDataFilter(newDataFilter)	(ALPHA) Create a new data filter (without setting).
createUserDataFilter(newUserDataFilter)	(ALPHA) Create a new user data filter.
deleteDataFilter(ref)	(ALPHA) Delete an existing data filter.
deleteUserDataFilter(ref)	(ALPHA) Delete an existing user data filter.
getDataFilters()	(ALPHA) Get data filters for the current workspace with their settings.
getUserDataFilters()	(ALPHA) Get all user data filters for the current workspace.
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.
updateUserDataFilter(updatedUserDataFilter)	(ALPHA) Update an existing user data filter.