Class ilib.Cal.Persian
Construct a new Persian astronomical (Hijjri) calendar object. This class encodes information about a Persian calendar. This class differs from the Persian calendar in that the leap years are calculated based on the astronomical observations of the sun in Teheran, instead of calculating the leap years based on a regular cyclical rhythm algorithm.
Depends directive: !depends persianastro.js
Defined in: ilib-dyn-full.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
|
getMonLength(month, year)
Return the number of days in a particular month in a particular year.
|
|
|
getNumMonths(year)
Return the number of months in the given year.
|
|
|
getType()
Return the type of this calendar.
|
|
|
isLeapYear(year)
Return true if the given year is a leap year in the Persian astronomical calendar.
|
|
|
newDateInstance(options)
Return a date instance for this calendar type using the given
options.
|
Method Detail
{number}
getMonLength(month, year)
Return the number of days in a particular month in a particular year. This function
can return a different number for a month depending on the year because of things
like leap years.
- Parameters:
- {number} month
- the month for which the length is sought
- {number} year
- the year within which that month can be found
- Returns:
- {number} the number of days within the given month in the given year
{number}
getNumMonths(year)
Return the number of months in the given year. The number of months in a year varies
for some luni-solar calendars because in some years, an extra month is needed to extend the
days in a year to an entire solar year. The month is represented as a 1-based number
where 1=first month, 2=second month, etc.
- Parameters:
- {number} year
- a year for which the number of months is sought
- Returns:
- {number} The number of months in the given year
{string}
getType()
Return the type of this calendar.
- Returns:
- {string} the name of the type of this calendar
{boolean}
isLeapYear(year)
Return true if the given year is a leap year in the Persian astronomical calendar.
- Parameters:
- {number} year
- the year for which the leap year information is being sought
- Returns:
- {boolean} true if the given year is a leap year
{ilib.Date}
newDateInstance(options)
Return a date instance for this calendar type using the given
options.
- Parameters:
- {Object} options
- options controlling the construction of the date instance
- Returns:
- {ilib.Date} a date appropriate for this calendar type