DateFilterSelection

Home > @gooddata/sdk-ui-dashboard > DateFilterSelection

DateFilterSelection interface

Payload type for ChangeDateFilterSelection command.

Signature:

export interface DateFilterSelection 

Properties

Property	Modifiers	Type	Description
boundedFilter?	readonly	IUpperBoundedFilter | ILowerBoundedFilter	(ALPHA) (Optional) Additional bound for the relative date filter
dataSet?	readonly	ObjRef	(Optional) The reference to date data set to which date filter belongs. If not defined it refers to so. called common date filter which data set is defined per widget
dateFilterOptionLocalId?	readonly	string	(Optional) The localId of the DateFilterOption selected.
from?	readonly	DateString | number	(Optional) The start date. If absolute date filter, then from is the formatted start date.
granularity	readonly	DateFilterGranularity	Date filter granularity. For absolute dates this indicates what is the expected input format.
isWorkingSelectionChange?	readonly	boolean	(Optional) Determines if this command should change working (staged for application) filters or applied filters (used to compute data).
localIdentifier?	readonly	string	(Optional) Specify the local identifier of date filter
to?	readonly	DateString | number	(Optional) The end date. If absolute date filter, then to is formatted end date.
type	readonly	DateFilterType	Indicates whether the filter should select absolute or relative values.