IGranularitiesQuery
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Query describing which granularities to return.
export interface IGranularitiesQuery
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) The calendar(s) to resolve granularities for. Pass a single-element array for one calendar, or several to get their merged, de-duplicated union in canonical order — e.g. | |||
(ALPHA) (Optional) Structural families to include. Defaults to | |||
boolean | (ALPHA) (Optional) Include granularities that are not offered by default ( | ||
boolean | (ALPHA) (Optional) For a fiscal/custom calendar, also include shared granularities (week/date/time/…). Defaults to | ||
boolean | (ALPHA) (Optional) Include time-scale granularities (hour/minute/second and their generic forms). Defaults to |
Property details
IGranularitiesQuery.calendarspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The calendar(s) to resolve granularities for. Pass a single-element array for one calendar, or several to get their merged, de-duplicated union in canonical order — e.g. standard + fiscal for a “supported/available” superset. A single custom calendar preserves its own enabledGranularities order; a merge always uses the canonical registry order.
calendars: CalendarContext[];
IGranularitiesQuery.familiespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Structural families to include. Defaults to ["chronological"]; pass ["generic"] for generic-only.
families?: GranularityFamily[];
IGranularitiesQuery.includeNonDefaultpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Include granularities that are not offered by default (GDC.time.week, EU-week variants). Defaults to false.
includeNonDefault?: boolean;
IGranularitiesQuery.includeSharedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
For a fiscal/custom calendar, also include shared granularities (week/date/time/…). Defaults to true.
includeShared?: boolean;
IGranularitiesQuery.includeTimepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Include time-scale granularities (hour/minute/second and their generic forms). Defaults to true.
includeTime?: boolean;