QScript DateTimeAggregationSettings

DateTimeAggregationSettings

Represents date/time aggregation settings for a variable, as used by setDateTimeAggregationSettings().

aggregation

Aggregation settings: { numPeriods: number, periodUnit: string }

duration

When periodType='Duration': Duration settings: { numPeriods: int, periodUnit: string }. Used for things like "last 6 months".

maximum

When periodType='Date Range': Maximum date/time ("yyyy-MM-dd" or ISO 8601 string). Null means "not set": on get() (with include_default_values = false) it is tracking its computed default. On set(), omitting the field leaves it exactly as it is, while passing null explicitly clears any stored value so it goes back to tracking its default.

minimum

When periodType='Date Range': Minimum date/time ("yyyy-MM-dd" or ISO 8601 string). Null means "not set": on get() (with include_default_values = false) it is tracking its computed default. On set(), omitting the field leaves it exactly as it is, while passing null explicitly clears any stored value so it goes back to tracking its default.

periodAnchor

Period anchor date/time ("yyyy-MM-dd" or ISO 8601 string). Null means "not set": on get() (with include_default_values = false) the anchor is tracking its computed default. On set(), omitting the field leaves the anchor exactly as it is, while passing null explicitly clears any stored anchor so it goes back to tracking its default.

periodType

Period type: "All Data", "Date Range", or "Duration".

type

Returns 'DateTimeAggregationSettings'.