new JulianDate
Constructs a JulianDate instance from a Julian day number, the number of seconds elapsed into that day, and the time standard which the parameters are in. Passing no parameters will construct a JulianDate that represents the current system time. An astronomical Julian date is the number of days since noon on January 1, -4712 (4713 BC). For increased precision, this class stores the whole number part of the date and the seconds part of the date in separate components. In order to be safe for arithmetic and represent leap seconds, the date is always stored in the International Atomic Time standard TimeStandard.TAI.
Parameters:
Name | Type | Argument | Default | Description |
---|---|---|---|---|
julianDayNumber |
Number | The Julian Day Number representing the number of whole days. Fractional days will also be handled correctly. | ||
julianSecondsOfDay |
Number | The number of seconds into the current Julian Day Number. Fractional seconds, negative seconds and seconds greater than a day will be handled correctly. | ||
timeStandard |
TimeStandard |
<optional> |
TimeStandard.UTC | The time standard in which the first two parameters are defined. |
Throws:
Example
// Example 1. Construct a JulianDate representing the current system time. var julianDate = new Cesium.JulianDate(); // Example 2. Construct a JulianDate from a Julian day number and seconds of the day. var julianDayNumber = 2448257; // January 1, 1991 var secondsOfDay = 21600; // 06:00:00 var julianDate = new Cesium.JulianDate(julianDayNumber, secondsOfDay, Cesium.TimeStandard.UTC);
Methods
-
addDays
-
Returns a new JulianDate representing a time
duration
days later (or earlier in the case of a negative amount).Parameters:
Name Type Description duration
Number An integer number of days to add or subtract. Returns:
JulianDate A new JulianDate objectExample
var date = new Date(); date.setUTCFullYear(2011, 6, 4); // July 4, 2011 @ 12:00 UTC date.setUTCHours(12, 0, 0, 0); var start = Cesium.JulianDate.fromDate(date); var end = start.addDays(5); // July 9, 2011 @ 12:00 UTC
-
addHours
-
Returns a new JulianDate representing a time
duration
hours later (or earlier in the case of a negative amount).Parameters:
Name Type Description duration
Number An integer number of hours to add or subtract. Returns:
JulianDate A new JulianDate objectExample
var date = new Date(); date.setUTCFullYear(2011, 6, 4); // July 4, 2011 @ 12:00 UTC date.setUTCHours(12, 0, 0, 0); var start = Cesium.JulianDate.fromDate(date); var end = start.addHours(6); // July 4, 2011 @ 18:00 UTC
-
addMinutes
-
Returns a new JulianDate representing a time
duration
minutes later (or earlier in the case of a negative amount).Parameters:
Name Type Description duration
Number An integer number of minutes to add or subtract. Returns:
JulianDate A new JulianDate objectExample
var date = new Date(); date.setUTCFullYear(2011, 6, 4); // July 4, 2011 @ 12:00 UTC date.setUTCHours(12, 0, 0, 0); var start = Cesium.JulianDate.fromDate(date); var end = start.addMinutes(65); // July 4, 2011 @ 13:05 UTC
-
addSeconds
-
Returns a new JulianDate representing a time
duration
seconds later (or earlier in the case of a negative amount).Parameters:
Name Type Argument Description seconds
Number The number of seconds to add or subtract. result
JulianDate <optional>
The JulianDate to store the result into. Returns:
JulianDate The modified result parameter or a new JulianDate instance if it was not provided.Example
var date = new Date(); date.setUTCFullYear(2011, 6, 4); // July 4, 2011 @ 12:00:00 UTC date.setUTCHours(12, 0, 00, 0); var start = Cesium.JulianDate.fromDate(date); var end = start.addSeconds(95); // July 4, 2011 @ 12:01:35 UTC
-
clone
-
Duplicates this JulianDate.
Parameters:
Name Type Argument Description result
Cartesian3 <optional>
The object onto which to store the JulianDate. Returns:
Cartesian3 The modified result parameter or a new Cartesian3 instance if one was not provided. -
compareTo
-
Compares this date to another date.
Parameters:
Name Type Description other
JulianDate The other JulianDate to compare to. Returns:
Number A negative value if this instance is less than the other, a positive value if this instance is greater than the other, or zero if this instance and the other are equal. -
equals
-
Returns
true
if this date is equivalent to the specified date.Parameters:
Name Type Description other
JulianDate The JulianDate to be compared. Returns:
Booleantrue
if the two JulianDates are equal; otherwisefalse
.Example
var original = Cesium.JulianDate.fromDate(new Date('July 4, 2011 12:00:00')); var clone = Cesium.JulianDate.fromDate(new Date('July 4, 2011 12:00:00')); original.equals(clone); // true
-
equalsEpsilon
-
Returns
true
if this date is withinepsilon
seconds of the specified date. That is, in order for the dates to be considered equal (and for this function to returntrue
), the absolute value of the difference between them, in seconds, must be less thanepsilon
.Parameters:
Name Type Description other
JulianDate The JulianDate to be compared. epsilon
Number The number of seconds that should separate the two JulianDates Returns:
Booleantrue
if the two JulianDates are withinepsilon
seconds of each other; otherwisefalse
.Example
var original = Cesium.JulianDate.fromDate(new Date('July 4, 2011 12:00:00')); var clone = Cesium.JulianDate.fromDate(new Date('July 4, 2011 12:00:01')); original.equalsEpsilon(clone, 2); // true
See:
-
getDaysDifference
-
Computes the number of days that have elapsed from this JulianDate to the
other
JulianDate. A day is always exactly 86400.0 seconds.Parameters:
Name Type Description other
JulianDate The other JulianDate, which is the end of the interval. Returns:
Number The number of days that have elpased from this JulianDate to the other JulianDate.Example
var start = Cesium.JulianDate.fromDate(new Date('July 4, 2011 12:00:00')); var end = Cesium.JulianDate.fromDate(new Date('July 5, 2011 14:24:00')); var difference = start.getDaysDifference(end); // 1.1 days
-
getJulianDayNumber
-
Returns the whole number component of the Julian date.
Returns:
Number A whole number representing the Julian day number. -
getJulianTimeFraction
-
Returns the floating point component of the Julian date representing the time of day.
Returns:
Number The floating point component of the Julian date representing the time of day. -
getMinutesDifference
-
Computes the number of minutes that have elapsed from this JulianDate to the
other
JulianDate.Parameters:
Name Type Description other
JulianDate The other JulianDate, which is the end of the interval. Returns:
Number The number of seconds that have elpased from this JulianDate to the other JulianDate.Example
var start = Cesium.JulianDate.fromDate(new Date('July 4, 2011 12:00:00')); var end = Cesium.JulianDate.fromDate(new Date('July 5, 2011 12:01:00')); var difference = start.getMinutesDifference(end); // 1441.0 minutes
-
getSecondsDifference
-
Computes the number of seconds that have elapsed from this JulianDate to the
other
JulianDate.Parameters:
Name Type Description other
JulianDate The other JulianDate, which is the end of the interval. Returns:
Number The number of seconds that have elpased from this JulianDate to the other JulianDate.Example
var start = Cesium.JulianDate.fromDate(new Date('July 4, 2011 12:00:00')); var end = Cesium.JulianDate.fromDate(new Date('July 5, 2011 12:01:00')); var difference = start.getSecondsDifference(end); // 86460.0 seconds
-
getSecondsOfDay
-
Return the number of seconds elapsed into the current Julian day (starting at noon).
Returns:
Number The number of seconds elapsed into the current day. -
getTaiMinusUtc
-
Returns the number of seconds this TAI date is ahead of UTC.
Returns:
Number The number of seconds this TAI date is ahead of UTCExample
var date = new Date('August 1, 2012 12:00:00 UTC'); var julianDate = Cesium.JulianDate.fromDate(date); var difference = julianDate.getTaiMinusUtc(); //35
See:
-
getTotalDays
-
Returns the total number of whole and fractional days represented by this astronomical Julian date.
Returns:
Number The Julian date as single floating point number. -
greaterThan
-
Returns true if
other
occurs before this JulianDate.Parameters:
Name Type Description other
JulianDate The JulianDate to be compared. Returns:
Booleantrue
if this JulianDate is chronologically later thanother
; otherwise,false
.Example
var start = Cesium.JulianDate.fromDate(new Date('July 6, 1991 12:00:00')); var end = Cesium.JulianDate.fromDate(new Date('July 6, 2011 12:01:00')); end.greaterThan(start); // true
-
greaterThanOrEquals
-
Returns true if
other
occurs at or before this JulianDate.Parameters:
Name Type Description other
JulianDate The JulianDate to be compared. Returns:
Booleantrue
if this JulianDate is chronologically later than or equal toother
; otherwise,false
.Example
var start = Cesium.JulianDate.fromDate(new Date('July 6, 1991 12:00:00')); var end = Cesium.JulianDate.fromDate(new Date('July 6, 2011 12:00:00')); end.greaterThanOrEquals(start); // true
-
lessThan
-
Returns true if
other
occurs after this JulianDate.Parameters:
Name Type Description other
JulianDate The JulianDate to be compared. Returns:
Booleantrue
if this JulianDate is chronologically earlier thanother
; otherwise,false
.Example
var start = Cesium.JulianDate.fromDate(new Date('July 6, 1991 12:00:00')); var end = Cesium.JulianDate.fromDate(new Date('July 6, 2011 12:01:00')); start.lessThan(end); // true
-
lessThanOrEquals
-
Returns true if
other
occurs at or after this JulianDate.Parameters:
Name Type Description other
JulianDate The JulianDate to be compared. Returns:
Booleantrue
if this JulianDate is chronologically less than or equal toother
; otherwise,false
.Example
var start = Cesium.JulianDate.fromDate(new Date('July 6, 1991 12:00:00')); var end = Cesium.JulianDate.fromDate(new Date('July 6, 2011 12:00:00')); start.lessThanOrEquals(end); // true
-
toDate
-
Creates a JavaScript Date representation of this date in UTC. Javascript dates are only accurate to the nearest millisecond.
Returns:
Date A new JavaScript Date equivalent to this JulianDate. -
toGregorianDate
-
Creates a GregorianDate representation of this date in UTC.
Returns:
GregorianDate A gregorian date. -
toIso8601
-
Creates an ISO8601 string represenation of this JulianDate in UTC.
Parameters:
Name Type Argument Description precision
Number <optional>
The number of fractional digits used to represent the seconds component. By default, the most precise representation is used. Returns:
String An ISO8601 string represenation of this JulianDate. -
<static> clone
-
Duplicates a JulianDate instance.
Parameters:
Name Type Argument Description date
Cartesian3 The JulianDate to duplicate. result
Cartesian3 <optional>
The object onto which to store the JulianDate. Returns:
Cartesian3 The modified result parameter or a new Cartesian3 instance if one was not provided. (Returns undefined if date is undefined) -
<static> compare
-
Compares two JulianDate instances.
Parameters:
Name Type Description a
JulianDate The first instance. b
JulianDate The second instance. Returns:
Number A negative value if a is less than b, a positive value if a is greater than b, or zero if a and b are equal. -
<static> equals
-
Returns true if the first JulianDate equals the second JulianDate.
Parameters:
Name Type Description left
JulianDate The first JulianDate to compare for equality. right
JulianDate The second JulianDate to compare for equality. Returns:
Booleantrue
if the JulianDates are equal; otherwise,false
. -
<static> equalsEpsilon
-
Returns
true
if the provided dates are withinepsilon
seconds of each other. That is, in order for the dates to be considered equal (and for this function to returntrue
), the absolute value of the difference between them, in seconds, must be less thanepsilon
.Parameters:
Name Type Description left
JulianDate The first JulianDate to be compared. right
JulianDate The second JulianDate to be compared. epsilon
Number The number of seconds that should separate the two JulianDates Returns:
Booleantrue
if the two JulianDates are withinepsilon
seconds of each other; otherwisefalse
.See:
-
<static> fromDate
-
Creates a JulianDate instance from a JavaScript Date object. While the JavaScript Date object defaults to the system's local time zone, the JulianDate is computed using the UTC values.
Parameters:
Name Type Argument Default Description date
Date The JavaScript Date object representing the time to be converted to a JulianDate. timeStandard
TimeStandard <optional>
TimeStandard.UTC Indicates the time standard in which this JulianDate is represented. Throws:
DeveloperError : date must be a valid JavaScript Date.Returns:
JulianDate The new JulianDate instance.Example
// Construct a JulianDate specifying the UTC time standard var date = new Date('January 1, 2011 12:00:00 EST'); var julianDate = Cesium.JulianDate.fromDate(date, Cesium.TimeStandard.UTC);
-
<static> fromIso8601
-
Creates a JulianDate instance from an ISO 8601 date string. Unlike Date.parse, this method properly accounts for all valid formats defined by the ISO 8601 specification. It also properly handles leap seconds and sub-millisecond times.
Parameters:
Name Type Description iso8601String
String The ISO 8601 date string representing the time to be converted to a JulianDate. Throws:
DeveloperError : Valid ISO 8601 date string required.Returns:
JulianDate The new JulianDate instance.Example
// Example 1. Construct a JulianDate in UTC at April 24th, 2012 6:08PM UTC var julianDate = Cesium.JulianDate.fromIso8601('2012-04-24T18:08Z'); // Example 2. Construct a JulianDate in local time April 24th, 2012 12:00 AM var localDay = Cesium.JulianDate.fromIso8601('2012-04-24'); // Example 3. Construct a JulianDate 5 hours behind UTC April 24th, 2012 5:00 pm UTC var localDay = Cesium.JulianDate.fromIso8601('2012-04-24T12:00-05:00');
-
<static> fromTotalDays
-
Creates a JulianDate instance from a single number representing the Julian day and fractional day.
Parameters:
Name Type Argument Default Description totalDays
Number The combined Julian Day Number and fractional day. timeStandard
TimeStandard <optional>
TimeStandard.UTC Indicates the time standard in which the first parameter is defined. Returns:
JulianDate The new JulianDate instance.Example
// Construct a date which corresponds to January 1, 1991 06:00:00 UTC. var julianDate = Cesium.JulianDate.fromTotalDays(2448257.75, Cesium.TimeStandard.UTC);