IDataFiltersService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The service that returns information about data filters.
Supports both Workspace Data Filters and User Data Filters.
export interface IDataFiltersService
Methods
Method | Description |
|---|---|
(ALPHA) Create a new data filter (without setting). | |
(ALPHA) Create a new setting of a data filter. Unlike , this does not remove the existing settings of the data filter. | |
(ALPHA) Create a new user data filter. | |
(ALPHA) Delete an existing data filter. | |
(ALPHA) Delete an existing user data filter. | |
(ALPHA) Get data filters for the current workspace with their settings. | |
(ALPHA) Get all user data filters for the current workspace. | |
(ALPHA) Get data filters for the current workspace with their settings. | |
(ALPHA) Update an existing data filter. The setting is not updated, only the data filter. | |
(ALPHA) Update value of existing data filter. | |
(ALPHA) Update an existing user data filter. |
Method details
IDataFiltersService.createDataFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Create a new data filter (without setting).
createDataFilter(newDataFilter: IWorkspaceDataFilterDefinition): Promise<IWorkspaceDataFilter>;
Parameters
Parameter | Type | Description |
|---|---|---|
newDataFilter |
Returns
Promise<IWorkspaceDataFilter>
IDataFiltersService.createDataFilterSetting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Create a new setting of a data filter. Unlike , this does not remove the existing settings of the data filter.
createDataFilterSetting(definition: IWorkspaceDataFilterSettingDefinition): Promise<IWorkspaceDataFilterSetting>;
Parameters
Parameter | Type | Description |
|---|---|---|
definition | data filter, values and optional id, title and description of the setting |
Returns
Promise<IWorkspaceDataFilterSetting>
IDataFiltersService.createUserDataFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Create a new user data filter.
createUserDataFilter(newUserDataFilter: UserDataFilterDefinition): Promise<UserDataFilter>;
Parameters
Parameter | Type | Description |
|---|---|---|
newUserDataFilter |
Returns
Promise<UserDataFilter>
IDataFiltersService.deleteDataFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Delete an existing data filter.
deleteDataFilter(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IDataFiltersService.deleteUserDataFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Delete an existing user data filter.
deleteUserDataFilter(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IDataFiltersService.getDataFilters()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get data filters for the current workspace with their settings.
getDataFilters(): Promise<IWorkspaceDataFilter[]>;
Returns
Promise<IWorkspaceDataFilter[]>
IDataFiltersService.getUserDataFilters()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get all user data filters for the current workspace.
getUserDataFilters(): Promise<UserDataFilter[]>;
Returns
Promise<UserDataFilter[]>
IDataFiltersService.getWorkspaceDataFilters()methodAlphaDeprecated
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Warning: This API is now obsolete.
- the function has been renamed, use instead
Get data filters for the current workspace with their settings.
getWorkspaceDataFilters(): Promise<IWorkspaceDataFilter[]>;
Returns
Promise<IWorkspaceDataFilter[]>
IDataFiltersService.updateDataFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Update an existing data filter. The setting is not updated, only the data filter.
updateDataFilter(updatedDataFilter: IWorkspaceDataFilter): Promise<IWorkspaceDataFilter>;
Parameters
Parameter | Type | Description |
|---|---|---|
updatedDataFilter |
Returns
Promise<IWorkspaceDataFilter>
IDataFiltersService.updateDataFilterValue()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Update value of existing data filter.
updateDataFilterValue(dataFilter: ObjRef, values: string[]): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
dataFilter | ||
values | string[] |
Returns
Promise<void>
IDataFiltersService.updateUserDataFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Update an existing user data filter.
updateUserDataFilter(updatedUserDataFilter: UserDataFilter): Promise<UserDataFilter>;
Parameters
Parameter | Type | Description |
|---|---|---|
updatedUserDataFilter |
Returns
Promise<UserDataFilter>