function
Source: factory.ts ↗
newRelativeDateFilter()
Creates a new relative date filter.
export declare function newRelativeDateFilter(dateDataSet: ObjRef | Identifier, granularity: DateAttributeGranularity, from: number, to: number, localIdentifier?: string, boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter, emptyValueHandling?: EmptyValues): IRelativeDateFilter;
Parameters
Parameter | Type | Description |
|---|---|---|
dateDataSet | ref or identifier of the date data set to filter on | |
granularity | granularity of the filters (month, year, etc.) | |
from | number | start of the interval – negative numbers mean the past, zero means today, positive numbers mean the future |
to | number | end of the interval – negative numbers mean the past, zero means today, positive numbers mean the future |
localIdentifier | string | (Optional) filter local identifier See also DateAttributeGranularity and DateGranularity |
boundedFilter | (Optional) optional bounded filter to use in the filter | |
emptyValueHandling | (Optional) |
Returns