getResolvedFiltersForWidget()

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

IWorkspaceDashboardsService.getResolvedFiltersForWidget() 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 and a list of filters and returns filters that can be used for the widget. - for attribute filters, these are filters that should NOT be ignored according to the ignoreDashboardFilters property. - for date filters it is the last filter with the same date dimension as specified in dateDataSet property. DOES NOT SUPPORT MULTIPLE DATE FILTERS. If you want to provide multiple date filters, pls refer to getResolvedFiltersForWidgetWithMultipleDateFilters

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:

getResolvedFiltersForWidget(widget: IWidget, filters: IFilter[], attributeFilterConfigs: IDashboardAttributeFilterConfig[]): Promise<IFilter[]>;

Parameters

ParameterTypeDescription
widgetIWidgetwidget to get filters for
filtersIFilter[]filters to apply on the widget
attributeFilterConfigsIDashboardAttributeFilterConfig[]filter configs

Returns:

Promise<IFilter[]>

promise with the filters with the ignored filters removed