Class Index | File Index

Classes


Class IslamicCal


Extends Calendar.
Construct a new Islamic calendar object. This class encodes information about the civil Islamic calendar. The civil Islamic calendar is a tabular islamic calendar where the dates are calculated by arithmetic rules. This differs from the religious Islamic calendar which is used to mark the beginning of particular holidays. The religious calendar depends on the first sighting of the new crescent moon to determine the first day of the new month. Because humans and weather are both involved, the actual time of sighting varies, so it is not really possible to precalculate the religious calendar. Certain groups, such as the Islamic Society of North America, decreed in in 2007 that they will use a calendar based on calculations rather than observations to determine the beginning of lunar months, and therefore the dates of holidays.


Defined in: ilib-full-dyn.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
getMonLength(month, year)
Return the number of days in a particular month in a particular year.
 
Return the number of months in the given year.
 
Return the type of this calendar.
 
isLeapYear(year)
Return true if the given year is a leap year in the Islamic calendar.
<deprecated>  
newDateInstance(options)
Return a date instance for this calendar type using the given options.
Class Detail
IslamicCal()
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

getNumMonths(year)
Return the number of months in the given year. The number of months in a year varies for 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

{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 Islamic calendar. The year parameter may be given as a number, or as a IslamicDate object.
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

<deprecated> {IslamicDate} 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
Deprecated:
Since 11.0.5. Use DateFactory({calendar: cal.getType(), ...}) instead
Returns:
{IslamicDate} a date appropriate for this calendar type

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 02 2016 15:53:55 GMT-0800 (PST)