• Gets the details for all the months of the specified calendar.

    Returns

    Array of all months in the calendar.

    Example

    SimpleCalendar.api.getAllMonths();
    // Returns an array like this, assuming the Gregorian Calendar
    // [
    // {
    // "id": "13390ed",
    // "name": "January",
    // "description" : "",
    // "abbreviation": "Jan",
    // "numericRepresentation": 1,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 31,
    // "numberOfLeapYearDays": 31,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "effafeee",
    // "name": "February",
    // "description" : "",
    // "abbreviation": "Feb",
    // "numericRepresentation": 2,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 28,
    // "numberOfLeapYearDays": 29,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "25b48251",
    // "name": "March",
    // "description" : "",
    // "abbreviation": "Mar",
    // "numericRepresentation": 3,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 31,
    // "numberOfLeapYearDays": 31,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "e5e9782f",
    // "name": "April",
    // "description" : "",
    // "abbreviation": "Apr",
    // "numericRepresentation": 4,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 30,
    // "numberOfLeapYearDays": 30,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "93f626f6",
    // "name": "May",
    // "description" : "",
    // "abbreviation": "May",
    // "numericRepresentation": 5,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 31,
    // "numberOfLeapYearDays": 31,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "22b4b204",
    // "name": "June",
    // "description" : "",
    // "abbreviation": "Jun",
    // "numericRepresentation": 6,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 30,
    // "numberOfLeapYearDays": 30,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "adc0a7ca",
    // "name": "July",
    // "description" : "",
    // "abbreviation": "Jul",
    // "numericRepresentation": 7,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 31,
    // "numberOfLeapYearDays": 31,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "58197d71",
    // "name": "August",
    // "description" : "",
    // "abbreviation": "Aug",
    // "numericRepresentation": 8,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 31,
    // "numberOfLeapYearDays": 31,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "eca76bbd",
    // "name": "September",
    // "description" : "",
    // "abbreviation": "Sep",
    // "numericRepresentation": 9,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 30,
    // "numberOfLeapYearDays": 30,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "6b0da33e",
    // "name": "October",
    // "description" : "",
    // "abbreviation": "Oct",
    // "numericRepresentation": 10,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 31,
    // "numberOfLeapYearDays": 31,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "150f5519",
    // "name": "November",
    // "description" : "",
    // "abbreviation": "Nov",
    // "numericRepresentation": 11,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 30,
    // "numberOfLeapYearDays": 30,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // },
    // {
    // "id": "b67bc3ee",
    // "name": "December",
    // "description" : "",
    // "abbreviation": "Dec",
    // "numericRepresentation": 12,
    // "numericRepresentationOffset": 0,
    // "numberOfDays": 31,
    // "numberOfLeapYearDays": 31,
    // "intercalary": false,
    // "intercalaryInclude": false,
    // "startingWeekday": null
    // }
    // ]

    Parameters

    • calendarId: string = 'active'

      Optional parameter to specify the ID of the calendar to get the list of months from. If not provided the current active calendar will be used.

    Returns MonthData[]