newRelativeDashboardDateFilter()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates a new relative dashboard date filter.
export declare function newRelativeDashboardDateFilter(granularity: DateFilterGranularity, from: number, to: number, dataSet?: ObjRef, localIdentifier?: string, boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter, emptyValueHandling?: EmptyValues): IDashboardDateFilter;
Parameters
Parameter | Type | Description |
|---|---|---|
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 |
dataSet | (Optional) | |
localIdentifier | string | (Optional) |
boundedFilter | (Optional) | |
emptyValueHandling | (Optional) |
Returns