Class GregorianDate
Extends
IDate.
Construct a new Gregorian date object. The constructor parameters can
contain any of the following properties:
- unixtime - sets the time of this instance according to the given
unix time. Unix time is the number of milliseconds since midnight on Jan 1, 1970.
- julianday - sets the time of this instance according to the given Julian Day instance or the Julian Day given as a float
- year - any integer, including 0
- month - 1 to 12, where 1 means January, 2 means February, etc.
- day - 1 to 31
- hour - 0 to 23. A formatter is used to display 12 hour clocks, but this representation is always done with an unambiguous 24 hour representation
- minute - 0 to 59
- second - 0 to 59
- millisecond - 0 to 999
- dst - boolean used to specify whether the given time components are intended to be in daylight time or not. This is only used in the overlap time when transitioning from DST to standard time, and the time components are ambiguous. Otherwise at all other times of the year, this flag is ignored. If you specify the date using unix time (UTC) or a julian day, then the time is already unambiguous and this flag does not need to be specified.
For example, in the US, the transition out of daylight savings time in 2014 happens at Nov 2, 2014 2:00am Daylight Time, when the time falls back to Nov 2, 2014 1:00am Standard Time. If you give a date/time components as "Nov 2, 2014 1:30am", then there are two 1:30am times in that day, and you would have to give the standard flag to indicate which of those two you mean. (dst=true means daylight time, dst=false means standard time).
- timezone - the TimeZone instance or time zone name as a string of this gregorian date. The date/time is kept in the local time. The time zone is used later if this date is formatted according to a different time zone and the difference has to be calculated, or when the date format has a time zone component in it.
- locale - locale for this gregorian date. If the time zone is not given, it can be inferred from this locale. For locales that span multiple time zones, the one with the largest population is chosen as the one that represents the locale.
- date - use the given intrinsic Javascript date to initialize this one.
If the constructor is called with no arguments at all or if none of the properties listed above from unixtime through millisecond are present, then the date components are filled in with the current date at the time of instantiation. Note that if you do not give the time zone when defaulting to the current time and the time zone for all of ilib was not set with ilib.setTimeZone(), then the time zone will default to UTC ("Universal Time, Coordinated" or "Greenwich Mean Time").
If any of the properties from year through millisecond are not specified in the params, it is assumed that they have the smallest possible value in the range for the property (zero or one).
Defined in: ilib-full-dyn.js.
Constructor Attributes | Constructor Name and Description |
---|---|
GregorianDate(params)
|
Field Attributes | Field Name and Description |
---|---|
The day of the month.
|
|
The hour of the day.
|
|
The millisecond of the second.
|
|
The minute of the hours.
|
|
The month number, ranging from 1 (January) to 12 (December).
|
|
The second of the minute.
|
|
Year in the Gregorian calendar.
|
Method Attributes | Method Name and Description |
---|---|
Return the name of the calendar that governs this date.
|
|
Return the day of the week of this date.
|
|
Return the ordinal day of the year.
|
|
getEra()
Return the era for this date as a number.
|
- Parameters:
- {Object=} params
- parameters that govern the settings and behaviour of this Gregorian date
- Returns:
- {string} a string giving the name of the calendar
- Returns:
- {number} the day of the week
- Returns:
- {number} the ordinal day of the year
- Returns:
- {number} 1 if this date is in the common era, -1 if it is before the common era