Skip to main content
Version: 2.1.x

Interface: CalendarData

SimpleCalendar.CalendarData

Interface for all information about a calendar

Hierarchy

  • IDataItemBase

    CalendarData

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 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 leapYear instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


monthSettings

Optional monthSettings: MonthData[]

Deprecated

Please use 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 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 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 time instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.


weekdaySettings

Optional weekdaySettings: WeekdayData[]

Deprecated

Please use 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 year instead. This is to support importing loading of configurations created before version 2 of Simple Calendar.