dashboardDateFilterToAutomationDateFilterByWidget()
Home > @gooddata/sdk-ui-dashboard > dashboardDateFilterToAutomationDateFilterByWidget
dashboardDateFilterToAutomationDateFilterByWidget() function
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.
Converts to IDateFilter instance. The convertor also considers all time date filter and its granularity. This is specifically useful for filters in automation context as the filters need to reflect correct granularity even for all time filters.
Signature:
export declare function dashboardDateFilterToAutomationDateFilterByWidget(filter: IDashboardDateFilter, widget?: Partial<IFilterableWidget>): IDateFilter;
Parameters
| Parameter | Type | Description |
|---|---|---|
| filter | IDashboardDateFilter | filter context attribute filter to convert |
| widget | Partial<IFilterableWidget> | (Optional) widget to use to get dateDataSet for date filters |
Returns: