Skip to main content
Version: 2.3.x

Interface: YearData

SimpleCalendar.YearData

Interface for all information about a year

Hierarchy​

  • IDataItemBase

    ↳ YearData

Properties​

abbreviation​

• Optional abbreviation: string

The abbreviated name of the data item.

Inherited from​

IDataItemBase.abbreviation

description​

• Optional description: string

The optional description of the data item

Inherited from​

IDataItemBase.description

firstWeekday​

• firstWeekday: number

The day of the week the first day of the first month of year zero starts on.

id​

• id: string

The unique ID of the data item

Inherited from​

IDataItemBase.id

name​

• Optional name: string

The optional name of the data item

Inherited from​

IDataItemBase.name

numericRepresentation​

• numericRepresentation: number

The number representing the year.

Overrides​

IDataItemBase.numericRepresentation

postfix​

• postfix: string

A string to append to the end of a year's number.

prefix​

• prefix: string

A string to append to the beginning of a year's number.

showAdvanced​

• Optional showAdvanced: boolean

If to show the advanced options, this is not saved

Inherited from​

IDataItemBase.showAdvanced

showWeekdayHeadings​

• showWeekdayHeadings: boolean

If to show weekday headings on the calendar.

yearNames​

• yearNames: string[]

A list of names to use for years.

yearNamesStart​

• yearNamesStart: number

The year to start applying the year names.

yearNamingRule​

• yearNamingRule: YearNamingRules

How to calculate what year name to give to a year.

yearZero​

• yearZero: number

What is considered to be the first year when calculating timestamps.