IGranularityDescriptor

Home > @gooddata/sdk-model > IGranularityDescriptor

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

Canonical, calendar-independent metadata for a single date granularity.

Signature:

export interface IGranularityDescriptor 

Remarks

This is the single source of truth for classification, ordering and standard/fiscal relations. It intentionally does NOT carry i18n labels — those stay in the consuming apps, keyed off this descriptor.

Properties

Property	Modifiers	Type	Description
affinity		CalendarAffinity	(ALPHA) Which calendar the granularity belongs to.
chronologicalOrigin?		DateAttributeGranularity	(ALPHA) (Optional) For cyclical granularities, the chronological granularity they are derived from (e.g. month_in_year → month).
counterpart?		DateAttributeGranularity	(ALPHA) (Optional) Standard↔fiscal equivalent of the same period length (year↔fiscal_year, …), when one exists.
family		GranularityFamily	(ALPHA) Structural family.
granularity		DateAttributeGranularity	(ALPHA) The canonical SDK granularity token.
offeredByDefault		boolean	(ALPHA) Whether the granularity is offered to users by default. false for tokens that exist in the type/backend but are not surfaced in any picker today (the GDC.time.week alias and the EU-week cyclical variants). Descriptors still exist for them so classification/lookup works; they are just excluded from getGranularities() output unless explicitly requested.
order		number	(ALPHA) Canonical coarse→fine display/drill-down order. Fiscal granularities are ranked immediately after their standard sibling, so filtering to a single calendar reproduces each consumer's historical order.
timeScale		boolean	(ALPHA) Whether the granularity is at the time-of-day scale (hour/minute and their cyclical forms).