IGranularitiesQuery

Home > @gooddata/sdk-model > IGranularitiesQuery

IGranularitiesQuery interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Query describing which granularities to return.

Signature:

export interface IGranularitiesQuery 

Properties

Property	Modifiers	Type	Description
calendars		CalendarContext[]	(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. standard + fiscal for a "supported/available" superset. A single custom calendar preserves its own enabledGranularities order; a merge always uses the canonical registry order.
families?		GranularityFamily[]	(ALPHA) (Optional) Structural families to include. Defaults to ["chronological"]; pass ["cyclical"] for generic-only.
includeNonDefault?		boolean	(ALPHA) (Optional) Include granularities that are not offered by default (GDC.time.week, EU-week variants). Defaults to false.
includeShared?		boolean	(ALPHA) (Optional) For a fiscal/custom calendar, also include shared granularities (week/date/time/…). Defaults to true.
includeTime?		boolean	(ALPHA) (Optional) Include time-scale granularities (hour/minute and their cyclical forms). Defaults to true.