QScript DateTimeAggregationSettings

From Q
Jump to navigation Jump to search

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

minimum

When periodType='Date Range': Minimum date/time ("yyyy-MM-dd" or ISO 8601 string).

periodAnchor

Period anchor date/time ("yyyy-MM-dd" or ISO 8601 string). Leave this as null unless you want a non - standard period start.

periodType

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

type

Returns 'DateTimeAggregationSettings'.