wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/JulianDate.html

4908 lines
110 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>JulianDate - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
JulianDate
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="JulianDate">
<a href="#JulianDate" class="doc-link"></a>
new Cesium.JulianDate<span class="signature">(<span class="optional">julianDayNumber</span>, <span class="optional">secondsOfDay</span>, <span class="optional">timeStandard</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L206">Core/JulianDate.js 206</a>
</div>
</h4>
</div>
<div class="description">
Represents an astronomical Julian date, which 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
<a href="global.html#TimeStandard#.TAI"><code>TimeStandard.TAI</code></a>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDayNumber</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The Julian Day Number representing the number of whole days. Fractional days will also be handled correctly.</td>
</tr>
<tr>
<td class="name"><code>secondsOfDay</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The number of seconds into the current Julian Day Number. Fractional seconds, negative seconds and seconds greater than a day will be handled correctly.</td>
</tr>
<tr>
<td class="name"><code>timeStandard</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TimeStandard">TimeStandard</a></span>
</td>
<td class="default">
<code class="language-javascript">TimeStandard.UTC</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The time standard in which the first two parameters are defined.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".leapSeconds">
<a href="#.leapSeconds" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.leapSeconds<span class="type-signature"> : Array.&lt;<a href="LeapSecond.html">LeapSecond</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1203">Core/JulianDate.js 1203</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the list of leap seconds used throughout Cesium.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="dayNumber">
<a href="#dayNumber" class="doc-link"></a>
dayNumber<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L211">Core/JulianDate.js 211</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the number of whole days.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="secondsOfDay">
<a href="#secondsOfDay" class="doc-link"></a>
secondsOfDay<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L217">Core/JulianDate.js 217</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the number of seconds into the current day.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".addDays">
<a href="#.addDays" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.addDays<span class="signature">(julianDate, days, result)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1094">Core/JulianDate.js 1094</a>
</div>
</h4>
</div>
<div class="description">
Adds the provided number of days to the provided date instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date.</td>
</tr>
<tr>
<td class="name"><code>days</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The number of days to add or subtract.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".addHours">
<a href="#.addHours" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.addHours<span class="signature">(julianDate, hours, result)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1068">Core/JulianDate.js 1068</a>
</div>
</h4>
</div>
<div class="description">
Adds the provided number of hours to the provided date instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date.</td>
</tr>
<tr>
<td class="name"><code>hours</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The number of hours to add or subtract.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".addMinutes">
<a href="#.addMinutes" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.addMinutes<span class="signature">(julianDate, minutes, result)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1042">Core/JulianDate.js 1042</a>
</div>
</h4>
</div>
<div class="description">
Adds the provided number of minutes to the provided date instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date.</td>
</tr>
<tr>
<td class="name"><code>minutes</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The number of minutes to add or subtract.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".addSeconds">
<a href="#.addSeconds" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.addSeconds<span class="signature">(julianDate, seconds, result)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1014">Core/JulianDate.js 1014</a>
</div>
</h4>
</div>
<div class="description">
Adds the provided number of seconds to the provided date instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date.</td>
</tr>
<tr>
<td class="name"><code>seconds</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The number of seconds to add or subtract.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".clone">
<a href="#.clone" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.clone<span class="signature">(julianDate, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L840">Core/JulianDate.js 840</a>
</div>
</h4>
</div>
<div class="description">
Duplicates a JulianDate instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date to duplicate.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if none was provided. Returns undefined if julianDate is undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".compare">
<a href="#.compare" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.compare<span class="signature">(left, right)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L863">Core/JulianDate.js 863</a>
</div>
</h4>
</div>
<div class="description">
Compares two instances.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A negative value if left is less than right, a positive value if left is greater than right, or zero if left and right are equal.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".computeTaiMinusUtc">
<a href="#.computeTaiMinusUtc" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.computeTaiMinusUtc<span class="signature">(julianDate)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L988">Core/JulianDate.js 988</a>
</div>
</h4>
</div>
<div class="description">
Computes the number of seconds the provided instance is ahead of UTC.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The number of seconds the provided instance is ahead of UTC
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".daysDifference">
<a href="#.daysDifference" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.daysDifference<span class="signature">(left, right)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L966">Core/JulianDate.js 966</a>
</div>
</h4>
</div>
<div class="description">
Computes the difference in days between the provided instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The difference, in days, when subtracting <code>right</code> from <code>left</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".equals">
<a href="#.equals" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.equals<span class="signature">(<span class="optional">left</span>, <span class="optional">right</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L887">Core/JulianDate.js 887</a>
</div>
</h4>
</div>
<div class="description">
Compares two instances and returns <code>true</code> if they are equal, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the dates are equal; otherwise, <code>false</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".equalsEpsilon">
<a href="#.equalsEpsilon" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.equalsEpsilon<span class="signature">(<span class="optional">left</span>, <span class="optional">right</span>, <span class="optional">epsilon</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L908">Core/JulianDate.js 908</a>
</div>
</h4>
</div>
<div class="description">
Compares two instances and returns <code>true</code> if they are within <code>epsilon</code> seconds of
each other. That is, in order for the dates to be considered equal (and for
this function to return <code>true</code>), the absolute value of the difference between them, in
seconds, must be less than <code>epsilon</code>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The second instance.</td>
</tr>
<tr>
<td class="name"><code>epsilon</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum number of seconds that should separate the two instances.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".fromDate">
<a href="#.fromDate" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.fromDate<span class="signature">(date, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L278">Core/JulianDate.js 278</a>
</div>
</h4>
</div>
<div class="description">
Creates a new instance from a JavaScript Date.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last">
A JavaScript Date.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if none was provided.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: date must be a valid JavaScript Date.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".fromGregorianDate">
<a href="#.fromGregorianDate" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.fromGregorianDate<span class="signature">(date, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L245">Core/JulianDate.js 245</a>
</div>
</h4>
</div>
<div class="description">
Creates a new instance from a GregorianDate.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type"><a href="GregorianDate.html">GregorianDate</a></span>
</td>
<td class="description last">
A GregorianDate.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if none was provided.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: date must be a valid GregorianDate.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".fromIso8601">
<a href="#.fromIso8601" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.fromIso8601<span class="signature">(iso8601String, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L313">Core/JulianDate.js 313</a>
</div>
</h4>
</div>
<div class="description">
Creates a new instance from a from an <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> date.
This method is superior to <code>Date.parse</code> because it will handle all valid formats defined by the ISO 8601
specification, including leap seconds and sub-millisecond times, which discarded by most JavaScript implementations.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>iso8601String</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
An ISO 8601 date.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if none was provided.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: Invalid ISO 8601 date.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".greaterThan">
<a href="#.greaterThan" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.greaterThan<span class="signature">(left, right)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1140">Core/JulianDate.js 1140</a>
</div>
</h4>
</div>
<div class="description">
Compares the provided instances and returns <code>true</code> if <code>left</code> is later than <code>right</code>, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if <code>left</code> is later than <code>right</code>, <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".greaterThanOrEquals">
<a href="#.greaterThanOrEquals" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.greaterThanOrEquals<span class="signature">(left, right)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1151">Core/JulianDate.js 1151</a>
</div>
</h4>
</div>
<div class="description">
Compares the provided instances and returns <code>true</code> if <code>left</code> is later than or equal to <code>right</code>, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if <code>left</code> is later than or equal to <code>right</code>, <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".lessThan">
<a href="#.lessThan" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.lessThan<span class="signature">(left, right)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1118">Core/JulianDate.js 1118</a>
</div>
</h4>
</div>
<div class="description">
Compares the provided instances and returns <code>true</code> if <code>left</code> is earlier than <code>right</code>, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if <code>left</code> is earlier than <code>right</code>, <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".lessThanOrEquals">
<a href="#.lessThanOrEquals" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.lessThanOrEquals<span class="signature">(left, right)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1129">Core/JulianDate.js 1129</a>
</div>
</h4>
</div>
<div class="description">
Compares the provided instances and returns <code>true</code> if <code>left</code> is earlier than or equal to <code>right</code>, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if <code>left</code> is earlier than or equal to <code>right</code>, <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".now">
<a href="#.now" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.now<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L615">Core/JulianDate.js 615</a>
</div>
</h4>
</div>
<div class="description">
Creates a new instance that represents the current system time.
This is equivalent to calling <code>JulianDate.fromDate(new Date());</code>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if none was provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".secondsDifference">
<a href="#.secondsDifference" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.secondsDifference<span class="signature">(left, right)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L944">Core/JulianDate.js 944</a>
</div>
</h4>
</div>
<div class="description">
Computes the difference in seconds between the provided instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The first instance.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The difference, in seconds, when subtracting <code>right</code> from <code>left</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".toDate">
<a href="#.toDate" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.toDate<span class="signature">(julianDate)</span> &rarr; <span class="type-signature returnType">Date</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L719">Core/JulianDate.js 719</a>
</div>
</h4>
</div>
<div class="description">
Creates a JavaScript Date from the provided instance.
Since JavaScript dates are only accurate to the nearest millisecond and
cannot represent a leap second, consider using <a href="JulianDate.html#.toGregorianDate"><code>JulianDate.toGregorianDate</code></a> instead.
If the provided JulianDate is during a leap second, the previous second is used.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date to be converted.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A new instance representing the provided date.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".toGregorianDate">
<a href="#.toGregorianDate" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.toGregorianDate<span class="signature">(julianDate, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="GregorianDate.html">GregorianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L628">Core/JulianDate.js 628</a>
</div>
</h4>
</div>
<div class="description">
Creates a <a href="GregorianDate.html"><code>GregorianDate</code></a> from the provided instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date to be converted.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="GregorianDate.html">GregorianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if none was provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".toIso8601">
<a href="#.toIso8601" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.toIso8601<span class="signature">(julianDate, <span class="optional">precision</span>)</span> &rarr; <span class="type-signature returnType">String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L751">Core/JulianDate.js 751</a>
</div>
</h4>
</div>
<div class="description">
Creates an ISO8601 representation of the provided date.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date to be converted.</td>
</tr>
<tr>
<td class="name"><code>precision</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The number of fractional digits used to represent the seconds component. By default, the most precise representation is used.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The ISO8601 representation of the provided date.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".totalDays">
<a href="#.totalDays" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.JulianDate.totalDays<span class="signature">(julianDate)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L925">Core/JulianDate.js 925</a>
</div>
</h4>
</div>
<div class="description">
Computes the total number of whole and fractional days represented by the provided instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>julianDate</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The date.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The Julian date as single floating point number.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clone">
<a href="#clone" class="doc-link"></a>
clone<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1161">Core/JulianDate.js 1161</a>
</div>
</h4>
</div>
<div class="description">
Duplicates this instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if none was provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="equals">
<a href="#equals" class="doc-link"></a>
equals<span class="signature">(<span class="optional">right</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1171">Core/JulianDate.js 1171</a>
</div>
</h4>
</div>
<div class="description">
Compares this and the provided instance and returns <code>true</code> if they are equal, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The second instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the dates are equal; otherwise, <code>false</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="equalsEpsilon">
<a href="#equalsEpsilon" class="doc-link"></a>
equalsEpsilon<span class="signature">(<span class="optional">right</span>, <span class="optional">epsilon</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1185">Core/JulianDate.js 1185</a>
</div>
</h4>
</div>
<div class="description">
Compares this and the provided instance and returns <code>true</code> if they are within <code>epsilon</code> seconds of
each other. That is, in order for the dates to be considered equal (and for
this function to return <code>true</code>), the absolute value of the difference between them, in
seconds, must be less than <code>epsilon</code>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The second instance.</td>
</tr>
<tr>
<td class="name"><code>epsilon</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum number of seconds that should separate the two instances.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="toString">
<a href="#toString" class="doc-link"></a>
toString<span class="signature">()</span> &rarr; <span class="type-signature returnType">String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/JulianDate.js#L1194">Core/JulianDate.js 1194</a>
</div>
</h4>
</div>
<div class="description">
Creates a string representing this date in ISO8601 format.
</div>
<h5>Returns:</h5>
<div class="param-desc">
A string representing this date in ISO8601 format.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>