IRelativeDateFilter

Home > @gooddata/sdk-model > IRelativeDateFilter

IRelativeDateFilter type

Filters results to a relative date range.

Signature:

export type IRelativeDateFilter = {
    relativeDateFilter: {
        dataSet: ObjRef;
        granularity: DateAttributeGranularity;
        from: number;
        to: number;
    };
} | {
    relativeDateFilter: {
        dataSet: ObjRef;
        granularity: AllTimeGranularity;
        from: 0;
        to: 0;
    };
};

References: ObjRef, DateAttributeGranularity, AllTimeGranularity

Remarks

The relative filtering is always done on some granularity - this specifies the units in the 'from' and 'to' fields.

See DateAttributeGranularity, AllTimeGranularity and DateGranularity for further detail.