IAbsoluteDateFilterBody
Object defining the IAbsoluteDateFilter object body.
export interface IAbsoluteDateFilterBody extends IIdentifiableFilter
Extends: IIdentifiableFilter
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Date data set for filtering | |||
(Optional) How to treat empty date values. | |||
string | Start date (including): this is in format ‘YYYY-MM-DD’ | ||
(Optional) Granularity of the selected periods. When not set, the range is a plain range of days. ‘from’ and ’to’ stay day-level even when this is set: they are the first day of the first selected period and the last day of the last selected period. | |||
string | End date (including): this is in format ‘YYYY-MM-DD’ |
Property details
IAbsoluteDateFilterBody.dataSetproperty
Date data set for filtering
dataSet: ObjRef;
IAbsoluteDateFilterBody.emptyValueHandlingproperty
How to treat empty date values.
emptyValueHandling?: EmptyValues;
IAbsoluteDateFilterBody.fromproperty
Start date (including): this is in format ‘YYYY-MM-DD’
from: string;
IAbsoluteDateFilterBody.granularityproperty
Granularity of the selected periods. When not set, the range is a plain range of days.
‘from’ and ’to’ stay day-level even when this is set: they are the first day of the first selected period and the last day of the last selected period.
granularity?: DateAttributeGranularity;
Remarks
On the Tiger backend, GDC.time.month, GDC.time.quarter and GDC.time.year select whole periods when ‘from’ and ’to’ are days in the ‘YYYY-MM-DD’ format covering whole periods; any other range, and every other granularity, selects the days of the range as given.
IAbsoluteDateFilterBody.toproperty
End date (including): this is in format ‘YYYY-MM-DD’
to: string;