getResolvedFiltersForWidgetWithMultipleDateFilters()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > getResolvedFiltersForWidgetWithMultipleDateFilters

IWorkspaceDashboardsService.getResolvedFiltersForWidgetWithMultipleDateFilters() method

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.

Takes a widget, commonDateFilters and a list of other filters and returns filters that can be used for the widget. - common date filters are used only when match widget's date data set. If multiple of them match the last one is used - other date filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property. May have date data sets different from one in widget's definition - for attribute filters - these are filters that should NOT be ignored according to the ignoreDashboardFilters property.

The implementation MUST take different ObjRef types into account, for example if an incoming filter uses idRef and an ignoreDashboardFilters item uses uriRef but they point to the same metadata object, the filter MUST NOT be included in the result.

Signature:

getResolvedFiltersForWidgetWithMultipleDateFilters(widget: IWidget, commonDateFilters: IDateFilter[], otherFilters: IFilter[], attributeFilterConfigs: IDashboardAttributeFilterConfig[]): Promise<IFilter[]>;

Parameters

Parameter	Type	Description
widget	IWidget	widget to get filters for
commonDateFilters	IDateFilter[]	date filters to apply on the widget only when matching its date dataSet
otherFilters	IFilter[]	filters to apply on the widget
attributeFilterConfigs	IDashboardAttributeFilterConfig[]	filter configs

Returns:

Promise<IFilter[]>

promise with the filters with the ignored filters removed