Skip to main content
Sets a default calendar for the model. A timestamp dimension that does not set its own custom_calendar uses this calendar automatically.

Syntax

Properties

string
The name of a calendar defined in the model’s custom_calendars parameter, or in a model it extends. The calendar must not be set to ignored: true or the model will show a no_such_default_custom_calendar validation error.The default applies only to timestamp dimensions (including their timeframe copies, such as a month or quarter grouping of a timestamp field). It does not apply to a dimension defined on the calendar’s own view.

Overriding the default

A dimension’s own custom_calendar parameter always takes priority over default_custom_calendar:
  • Setting custom_calendar: <calendar_name> on a dimension assigns it to that calendar, regardless of the default.
  • Setting custom_calendar: none on a dimension opts it out of the default, so it uses the Gregorian calendar.
Setting both default_custom_calendar and fiscal_month_offset produces a validation warning. A calendar suppresses the fiscal timeframes on every dimension it covers, including dimensions that only pick up the calendar through the default.

Examples

Set a default calendar for all timestamp dimensions
Opt a dimension out of the default