IDashboardAttributeFilterByDate
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Dependent date filter of an attribute filter of the filter context
export interface IDashboardAttributeFilterByDate
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) Target date dimension (date dataset) the dependency applies through. | |||
string | (BETA) Local identifier of the date filter | ||
boolean | (BETA) To distinguish between different types of date filters (common, specific) |
Property details
IDashboardAttributeFilterByDate.dataSetpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Target date dimension (date dataset) the dependency applies through.
dataSet?: ObjRef;
Remarks
Only meaningful when IDashboardAttributeFilterByDate.isCommonDate is true: the common date filter has no dimension of its own, so this carries the dimension the common date range should be applied through, while IDashboardAttributeFilterByDate.filterLocalIdentifier references the common date filter by its own localIdentifier. For specific (non-common) date filters the dimension is derived from the referenced filter, so this is redundant and left unset. Absent on legacy records, where the dataset identifier was stored in filterLocalIdentifier instead.
IDashboardAttributeFilterByDate.filterLocalIdentifierpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Local identifier of the date filter
filterLocalIdentifier: string;
Remarks
Historically, this can also be filled by a date dataset identifier (legacy format), so when matching, both forms should be considered.
IDashboardAttributeFilterByDate.isCommonDatepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
To distinguish between different types of date filters (common, specific)
isCommonDate: boolean;