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

3390 lines
94 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>TimeInterval - 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>
TimeInterval
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="TimeInterval">
<a href="#TimeInterval" class="doc-link"></a>
new Cesium.TimeInterval<span class="signature">(<span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L60">Core/TimeInterval.js 60</a>
</div>
</h4>
</div>
<div class="description">
An interval defined by a start and a stop time; optionally including those times as part of the interval.
Arbitrary data can optionally be associated with each instance for used with <a href="TimeIntervalCollection.html"><code>TimeIntervalCollection</code></a>.
</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object with the following properties:
<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>start</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="default">
<code class="language-javascript">new JulianDate()</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The start time of the interval.</td>
</tr>
<tr>
<td class="name"><code>stop</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="default">
<code class="language-javascript">new JulianDate()</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The stop time of the interval.</td>
</tr>
<tr>
<td class="name"><code>isStartIncluded</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
<code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.</td>
</tr>
<tr>
<td class="name"><code>isStopIncluded</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
<code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Arbitrary data associated with this interval.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">// Create an instance that spans August 1st, 1980 and is associated
// with a Cartesian position.
const timeInterval = new Cesium.TimeInterval({
start : Cesium.JulianDate.fromIso8601('1980-08-01T00:00:00Z'),
stop : Cesium.JulianDate.fromIso8601('1980-08-02T00:00:00Z'),
isStartIncluded : true,
isStopIncluded : false,
data : Cesium.Cartesian3.fromDegrees(39.921037, -75.170082)
});</code></pre>
<pre><code class="language-javascript">// Create two instances from ISO 8601 intervals with associated numeric data
// then compute their intersection, summing the data they contain.
const left = Cesium.TimeInterval.fromIso8601({
iso8601 : '2000/2010',
data : 2
});
const right = Cesium.TimeInterval.fromIso8601({
iso8601 : '1995/2005',
data : 3
});
//The result of the below intersection will be an interval equivalent to
//const intersection = Cesium.TimeInterval.fromIso8601({
// iso8601 : '2000/2005',
// data : 5
//});
const intersection = new Cesium.TimeInterval();
Cesium.TimeInterval.intersect(left, right, intersection, function(leftData, rightData) {
return leftData + rightData;
});</code></pre>
<pre><code class="language-javascript">// Check if an interval contains a specific time.
const dateToCheck = Cesium.JulianDate.fromIso8601('1982-09-08T11:30:00Z');
const containsDate = Cesium.TimeInterval.contains(timeInterval, dateToCheck);</code></pre>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".EMPTY">
<a href="#.EMPTY" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.TimeInterval.EMPTY<span class="type-signature"> : <a href="TimeInterval.html">TimeInterval</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L413">Core/TimeInterval.js 413</a>
</div>
</h4>
</div>
<div class="description">
An immutable empty interval.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="data">
<a href="#data" class="doc-link"></a>
data<span class="type-signature"> : *</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L82">Core/TimeInterval.js 82</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the data associated with this interval.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isEmpty">
<a href="#isEmpty" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> isEmpty<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L106">Core/TimeInterval.js 106</a>
</div>
</h4>
</div>
<div class="description">
Gets whether or not this interval is empty.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isStartIncluded">
<a href="#isStartIncluded" class="doc-link"></a>
isStartIncluded<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L89">Core/TimeInterval.js 89</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether or not the start time is included in this interval.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="isStopIncluded">
<a href="#isStopIncluded" class="doc-link"></a>
isStopIncluded<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L96">Core/TimeInterval.js 96</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether or not the stop time is included in this interval.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="start">
<a href="#start" class="doc-link"></a>
start<span class="type-signature"> : <a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L66">Core/TimeInterval.js 66</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the start time of this interval.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="stop">
<a href="#stop" class="doc-link"></a>
stop<span class="type-signature"> : <a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L74">Core/TimeInterval.js 74</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the stop time of this interval.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".clone">
<a href="#.clone" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.TimeInterval.clone<span class="signature">(<span class="optional">timeInterval</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="TimeInterval.html">TimeInterval</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L199">Core/TimeInterval.js 199</a>
</div>
</h4>
</div>
<div class="description">
Duplicates 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>timeInterval</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The instance to clone.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</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=".contains">
<a href="#.contains" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.TimeInterval.contains<span class="signature">(timeInterval, julianDate)</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/TimeInterval.js#L336">Core/TimeInterval.js 336</a>
</div>
</h4>
</div>
<div class="description">
Checks if the specified date is inside the provided interval.
</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>timeInterval</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
The interval.</td>
</tr>
<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 check.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the interval contains the specified date, <code>false</code> otherwise.
</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.TimeInterval.equals<span class="signature">(<span class="optional">left</span>, <span class="optional">right</span>, <span class="optional">dataComparer</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/TimeInterval.js#L222">Core/TimeInterval.js 222</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="TimeInterval.html">TimeInterval</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="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The second instance.</td>
</tr>
<tr>
<td class="name"><code>dataComparer</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html#.DataComparer">TimeInterval.DataComparer</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
A function which compares the data of the two intervals. If omitted, reference equality is used.</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.TimeInterval.equalsEpsilon<span class="signature">(<span class="optional">left</span>, <span class="optional">right</span>, <span class="optional">epsilon</span>, <span class="optional">dataComparer</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/TimeInterval.js#L249">Core/TimeInterval.js 249</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="TimeInterval.html">TimeInterval</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="TimeInterval.html">TimeInterval</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>
<tr>
<td class="name"><code>dataComparer</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html#.DataComparer">TimeInterval.DataComparer</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A function which compares the data of the two intervals. If omitted, reference equality is used.</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=".fromIso8601">
<a href="#.fromIso8601" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.TimeInterval.fromIso8601<span class="signature">(options, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="TimeInterval.html">TimeInterval</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L139">Core/TimeInterval.js 139</a>
</div>
</h4>
</div>
<div class="description">
Creates a new instance from a <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> interval.
</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Object with the following properties:
<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>iso8601</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
An ISO 8601 interval.</td>
</tr>
<tr>
<td class="name"><code>isStartIncluded</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
<code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.</td>
</tr>
<tr>
<td class="name"><code>isStopIncluded</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
<code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Arbitrary data associated with this interval.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</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">
DeveloperError if options.iso8601 does not match proper formatting.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".intersect">
<a href="#.intersect" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.TimeInterval.intersect<span class="signature">(left, <span class="optional">right</span>, <span class="optional">result</span>, <span class="optional">mergeCallback</span>)</span> &rarr; <span class="type-signature returnType"><a href="TimeInterval.html">TimeInterval</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L275">Core/TimeInterval.js 275</a>
</div>
</h4>
</div>
<div class="description">
Computes the intersection of two intervals, optionally merging their data.
</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="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
The first interval.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The second interval.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An existing instance to use for the result.</td>
</tr>
<tr>
<td class="name"><code>mergeCallback</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html#.MergeCallback">TimeInterval.MergeCallback</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
A function which merges the data of the two intervals. If omitted, the data from the left interval will be used.</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=".toIso8601">
<a href="#.toIso8601" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.TimeInterval.toIso8601<span class="signature">(timeInterval, <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/TimeInterval.js#L181">Core/TimeInterval.js 181</a>
</div>
</h4>
</div>
<div class="description">
Creates an ISO8601 representation of the provided interval.
</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>timeInterval</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
The interval 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 interval.
</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="TimeInterval.html">TimeInterval</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L368">Core/TimeInterval.js 368</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="TimeInterval.html">TimeInterval</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 class="optional">dataComparer</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/TimeInterval.js#L380">Core/TimeInterval.js 380</a>
</div>
</h4>
</div>
<div class="description">
Compares this instance against the provided instance componentwise 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="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The right hand side interval.</td>
</tr>
<tr>
<td class="name"><code>dataComparer</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html#.DataComparer">TimeInterval.DataComparer</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
A function which compares the data of the two intervals. If omitted, reference equality is used.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if they are equal, <code>false</code> otherwise.
</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 class="optional">dataComparer</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/TimeInterval.js#L394">Core/TimeInterval.js 394</a>
</div>
</h4>
</div>
<div class="description">
Compares this instance against the provided instance componentwise and returns
<code>true</code> if they are within the provided epsilon,
<code>false</code> otherwise.
</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="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The right hand side interval.</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 epsilon to use for equality testing.</td>
</tr>
<tr>
<td class="name"><code>dataComparer</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html#.DataComparer">TimeInterval.DataComparer</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A function which compares the data of the two intervals. If omitted, reference equality is used.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if they are within the provided epsilon, <code>false</code> otherwise.
</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/TimeInterval.js#L403">Core/TimeInterval.js 403</a>
</div>
</h4>
</div>
<div class="description">
Creates a string representing this TimeInterval in ISO8601 format.
</div>
<h5>Returns:</h5>
<div class="param-desc">
A string representing this TimeInterval in ISO8601 format.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".DataComparer">
<a href="#.DataComparer" class="doc-link"></a>
Cesium.TimeInterval.DataComparer<span class="signature">(leftData, rightData)</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/TimeInterval.js#L431">Core/TimeInterval.js 431</a>
</div>
</h4>
</div>
<div class="description">
Function interface for comparing interval data.
</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>leftData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
The first data instance.</td>
</tr>
<tr>
<td class="name"><code>rightData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
The second data instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the provided instances are equal, <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".MergeCallback">
<a href="#.MergeCallback" class="doc-link"></a>
Cesium.TimeInterval.MergeCallback<span class="signature">(leftData, rightData)</span> &rarr; <span class="type-signature returnType">*</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TimeInterval.js#L422">Core/TimeInterval.js 422</a>
</div>
</h4>
</div>
<div class="description">
Function interface for merging interval data.
</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>leftData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
The first data instance.</td>
</tr>
<tr>
<td class="name"><code>rightData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
The second data instance.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The result of merging the two data instances.
</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>