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

1543 lines
68 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>TileProviderError - 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>
TileProviderError
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="TileProviderError">
<a href="#TileProviderError" class="doc-link"></a>
new Cesium.TileProviderError<span class="signature">(provider, message, <span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">level</span>, <span class="optional">timesRetried</span>, <span class="optional">error</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L22">Core/TileProviderError.js 22</a>
</div>
</h4>
</div>
<div class="description">
Provides details about an error that occurred in an <a href="ImageryProvider.html"><code>ImageryProvider</code></a> or a <a href="TerrainProvider.html"><code>TerrainProvider</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>provider</code></td>
<td class="type">
<span class="param-type"><a href="ImageryProvider.html">ImageryProvider</a></span>
|
<span class="param-type"><a href="TerrainProvider.html">TerrainProvider</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The imagery or terrain provider that experienced the error.</td>
</tr>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
A message describing the error.</td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The X coordinate of the tile that experienced the error, or undefined if the error
is not specific to a particular tile.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The Y coordinate of the tile that experienced the error, or undefined if the error
is not specific to a particular tile.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The level of the tile that experienced the error, or undefined if the error
is not specific to a particular tile.</td>
</tr>
<tr>
<td class="name"><code>timesRetried</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 number of times this operation has been retried.</td>
</tr>
<tr>
<td class="name"><code>error</code></td>
<td class="type">
<span class="param-type">Error</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The error or exception that occurred, if any.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="error">
<a href="#error" class="doc-link"></a>
error<span class="type-signature"> : Error</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L84">Core/TileProviderError.js 84</a>
</div>
</h4>
</div>
<div class="description">
The error or exception that occurred, if any.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="level">
<a href="#level" class="doc-link"></a>
level<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L62">Core/TileProviderError.js 62</a>
</div>
</h4>
</div>
<div class="description">
The level-of-detail of the tile that experienced the error. If the error is not specific
to a particular tile, this property will be undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="message">
<a href="#message" class="doc-link"></a>
message<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L41">Core/TileProviderError.js 41</a>
</div>
</h4>
</div>
<div class="description">
The message describing the error.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="provider">
<a href="#provider" class="doc-link"></a>
provider<span class="type-signature"> : <a href="ImageryProvider.html">ImageryProvider</a>|<a href="TerrainProvider.html">TerrainProvider</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L35">Core/TileProviderError.js 35</a>
</div>
</h4>
</div>
<div class="description">
The <a href="ImageryProvider.html"><code>ImageryProvider</code></a> or <a href="TerrainProvider.html"><code>TerrainProvider</code></a> that experienced the error.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="retry">
<a href="#retry" class="doc-link"></a>
retry<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L78">Core/TileProviderError.js 78</a>
</div>
</h4>
</div>
<div class="description">
True if the failed operation should be retried; otherwise, false. The imagery or terrain provider
will set the initial value of this property before raising the event, but any listeners
can change it. The value after the last listener is invoked will be acted upon.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="timesRetried">
<a href="#timesRetried" class="doc-link"></a>
timesRetried<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L69">Core/TileProviderError.js 69</a>
</div>
</h4>
</div>
<div class="description">
The number of times this operation has been retried.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="x">
<a href="#x" class="doc-link"></a>
x<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L48">Core/TileProviderError.js 48</a>
</div>
</h4>
</div>
<div class="description">
The X coordinate of the tile that experienced the error. If the error is not specific
to a particular tile, this property will be undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="y">
<a href="#y" class="doc-link"></a>
y<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L55">Core/TileProviderError.js 55</a>
</div>
</h4>
</div>
<div class="description">
The Y coordinate of the tile that experienced the error. If the error is not specific
to a particular tile, this property will be undefined.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".handleError">
<a href="#.handleError" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.TileProviderError.handleError<span class="signature">(previousError, provider, event, message, x, y, level, retryFunction, <span class="optional">errorDetails</span>)</span> &rarr; <span class="type-signature returnType"><a href="TileProviderError.html">TileProviderError</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L112">Core/TileProviderError.js 112</a>
</div>
</h4>
</div>
<div class="description">
Handles an error in an <a href="ImageryProvider.html"><code>ImageryProvider</code></a> or <a href="TerrainProvider.html"><code>TerrainProvider</code></a> by raising an event if it has any listeners, or by
logging the error to the console if the event has no listeners. This method also tracks the number
of times the operation has been retried and will automatically retry if requested to do so by the
event listeners.
</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>previousError</code></td>
<td class="type">
<span class="param-type"><a href="TileProviderError.html">TileProviderError</a></span>
</td>
<td class="description last">
The error instance returned by this function the last
time it was called for this error, or undefined if this is the first time this error has
occurred.</td>
</tr>
<tr>
<td class="name"><code>provider</code></td>
<td class="type">
<span class="param-type"><a href="ImageryProvider.html">ImageryProvider</a></span>
|
<span class="param-type"><a href="TerrainProvider.html">TerrainProvider</a></span>
</td>
<td class="description last">
The imagery or terrain provider that encountered the error.</td>
</tr>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type"><a href="Event.html">Event</a></span>
</td>
<td class="description last">
The event to raise to inform listeners of the error.</td>
</tr>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The message describing the error.</td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The X coordinate of the tile that experienced the error, or undefined if the
error is not specific to a particular tile.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The Y coordinate of the tile that experienced the error, or undefined if the
error is not specific to a particular tile.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The level-of-detail of the tile that experienced the error, or undefined if the
error is not specific to a particular tile.</td>
</tr>
<tr>
<td class="name"><code>retryFunction</code></td>
<td class="type">
<span class="param-type"><a href="TileProviderError.html#.RetryFunction">TileProviderError.RetryFunction</a></span>
</td>
<td class="description last">
The function to call to retry the operation. If undefined, the
operation will not be retried.</td>
</tr>
<tr>
<td class="name"><code>errorDetails</code></td>
<td class="type">
<span class="param-type">Error</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The error or exception that occurred, if any.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The error instance that was passed to the event listeners and that
should be passed to this function the next time it is called for the same error in order
to track retry counts.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".handleSuccess">
<a href="#.handleSuccess" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.TileProviderError.handleSuccess<span class="signature">(previousError)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L169">Core/TileProviderError.js 169</a>
</div>
</h4>
</div>
<div class="description">
Handles success of an operation by resetting the retry count of a previous error, if any. This way,
if the error occurs again in the future, the listeners will be informed that it has not yet been retried.
</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>previousError</code></td>
<td class="type">
<span class="param-type"><a href="TileProviderError.html">TileProviderError</a></span>
</td>
<td class="description last">
The previous error, or undefined if this operation has
not previously resulted in an error.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".RetryFunction">
<a href="#.RetryFunction" class="doc-link"></a>
Cesium.TileProviderError.RetryFunction<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/TileProviderError.js#L175">Core/TileProviderError.js 175</a>
</div>
</h4>
</div>
<div class="description">
A function that will be called to retry the operation.
</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>