Skip to main content
Version: Next

Interface: CalendarData

Interface for all information about a calendar

Extends​

  • IDataItemBase

Properties​

abbreviation?​

optional abbreviation: string

The abbreviated name of the data item.

Inherited from​

IDataItemBase.abbreviation


currentDate?​

optional currentDate: CurrentDateData

The current date of the calendar.


description?​

optional description: string

The optional description of the data item

Inherited from​

IDataItemBase.description


general?​

optional general: GeneralSettingsData

The general settings for the calendar.


generalSettings?​

optional generalSettings: GeneralSettingsData

Deprecated​

Please use CalendarData.general instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


id​

id: string

The unique ID of the data item

Inherited from​

IDataItemBase.id


leapYear?​

optional leapYear: LeapYearData

The leap year settings for the calendar.


leapYearSettings?​

optional leapYearSettings: LeapYearData

Deprecated​

Please use CalendarData.leapYear instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


monthSettings?​

optional monthSettings: MonthData[]

Deprecated​

Please use CalendarData.months instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


months?​

optional months: MonthData[]

An array of month settings for each month of the calendar.


moonSettings?​

optional moonSettings: MoonData[]

Deprecated​

Please use CalendarData.moons instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


moons?​

optional moons: MoonData[]

An array of moon settings for each moon of the calendar.


name?​

optional name: string

The optional name of the data item

Inherited from​

IDataItemBase.name


noteCategories?​

optional noteCategories: NoteCategory[]

An array of note categories for the calendar.


numericRepresentation?​

optional numericRepresentation: number

The optional numeric representation of the data item

Inherited from​

IDataItemBase.numericRepresentation


seasonSettings?​

optional seasonSettings: SeasonData[]

Deprecated​

Please use CalendarData.seasons instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


seasons?​

optional seasons: SeasonData[]

An array of season settings for each season of the calendar.


showAdvanced?​

optional showAdvanced: boolean

If to show the advanced options, this is not saved

Inherited from​

IDataItemBase.showAdvanced


time?​

optional time: TimeData

The time settings for the calendar.


timeSettings?​

optional timeSettings: TimeData

Deprecated​

Please use CalendarData.time instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


weekdaySettings?​

optional weekdaySettings: WeekdayData[]

Deprecated​

Please use CalendarData.weekdays instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


weekdays?​

optional weekdays: WeekdayData[]

An array of weekday settings for each weekday of the calendar.


year?​

optional year: YearData

The year settings for the calendar.


yearSettings?​

optional yearSettings: YearData

Deprecated​

Please use CalendarData.year instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.