newRelativeDashboardDateFilter()

Home > @gooddata/sdk-model > newRelativeDashboardDateFilter

newRelativeDashboardDateFilter() 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.

Creates a new relative dashboard date filter.

Signature:

export declare function newRelativeDashboardDateFilter(granularity: DateFilterGranularity, from: number, to: number, dataSet?: ObjRef, localIdentifier?: string, boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter): IDashboardDateFilter;

Parameters

Parameter	Type	Description
granularity	DateFilterGranularity	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	ObjRef	(Optional)
localIdentifier	string	(Optional)
boundedFilter	IUpperBoundedFilter | ILowerBoundedFilter	(Optional)

Returns:

IDashboardDateFilter