belongsToCalendar()

Home > @gooddata/sdk-model > belongsToCalendar

belongsToCalendar() function

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.

Whether a granularity is usable under the given calendar — its own (standard/fiscal) granularities plus the shared ones (week/date/time/cyclical).

Signature:

belongsToCalendar: (g: string | undefined, calendar: "fiscal" | "standard") => boolean

Parameters

Parameter	Type	Description
g	string | undefined
calendar	"fiscal" | "standard"

Returns:

boolean

Remarks

Mirrors what a single calendar "tab" offers, so a merged result (e.g. standard + fiscal) can be split into standard-usable and fiscal-usable in one pass. shared granularities satisfy both calendars.