12901 lines
259 KiB
HTML
12901 lines
259 KiB
HTML
<!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>Resource - 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>
|
|
Resource
|
|
<div class="titleCenterer"></div>
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
<header>
|
|
|
|
</header>
|
|
|
|
<article>
|
|
<div class="container-overview">
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="Resource">
|
|
<a href="#Resource" class="doc-link"></a>
|
|
new Cesium.Resource<span class="signature">(options)</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L285">Core/Resource.js 285</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
A resource that includes the location and any other parameters we need to retrieve it or create derived resources. It also provides the ability to retry requests.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">function refreshTokenRetryCallback(resource, error) {
|
|
if (error.statusCode === 403) {
|
|
// 403 status code means a new token should be generated
|
|
return getNewAccessToken()
|
|
.then(function(token) {
|
|
resource.queryParameters.access_token = token;
|
|
return true;
|
|
})
|
|
.otherwise(function() {
|
|
return false;
|
|
});
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
var resource = new Resource({
|
|
url: 'http://server.com/path/to/resource.json',
|
|
proxy: new DefaultProxy('/proxy/'),
|
|
headers: {
|
|
'X-My-Header': 'valueOfHeader'
|
|
},
|
|
queryParameters: {
|
|
'access_token': '123-435-456-000'
|
|
},
|
|
retryCallback: refreshTokenRetryCallback,
|
|
retryAttempts: 1
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="subsection-title">Members</h3>
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".DEFAULT">
|
|
<a href="#.DEFAULT" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span><span class="type-signature attribute-constant">constant</span>Cesium.Resource.DEFAULT<span class="type-signature"> : <a href="Resource.html">Resource</a></span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L2091">Core/Resource.js 2091</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
A resource instance initialized to the current browser location
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".isBlobSupported">
|
|
<a href="#.isBlobSupported" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span><span class="type-signature attribute-readonly">readonly</span>Cesium.Resource.isBlobSupported<span class="type-signature"> : Boolean</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L426">Core/Resource.js 426</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
Returns true if blobs are supported.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="extension">
|
|
<a href="#extension" class="doc-link"></a>
|
|
<span class="type-signature attribute-readonly">readonly</span>extension<span class="type-signature"> : String</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L492">Core/Resource.js 492</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
The file extension of the resource.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="hasHeaders">
|
|
<a href="#hasHeaders" class="doc-link"></a>
|
|
hasHeaders<span class="type-signature"> : Boolean</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L540">Core/Resource.js 540</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
True if the Resource has request headers. This is equivalent to checking if the headers property has any keys.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="headers">
|
|
<a href="#headers" class="doc-link"></a>
|
|
headers<span class="type-signature"> : Object</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L306">Core/Resource.js 306</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
Additional HTTP headers that will be sent with the request.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="isBlobUri">
|
|
<a href="#isBlobUri" class="doc-link"></a>
|
|
isBlobUri<span class="type-signature"> : Boolean</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L516">Core/Resource.js 516</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
True if the Resource refers to a blob URI.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="isCrossOriginUrl">
|
|
<a href="#isCrossOriginUrl" class="doc-link"></a>
|
|
isCrossOriginUrl<span class="type-signature"> : Boolean</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L528">Core/Resource.js 528</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
True if the Resource refers to a cross origin URL.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="isDataUri">
|
|
<a href="#isDataUri" class="doc-link"></a>
|
|
isDataUri<span class="type-signature"> : Boolean</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L504">Core/Resource.js 504</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
True if the Resource refers to a data URI.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="proxy">
|
|
<a href="#proxy" class="doc-link"></a>
|
|
proxy<span class="type-signature"> : <a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L320">Core/Resource.js 320</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
A proxy to be used when loading the resource.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="queryParameters">
|
|
<a href="#queryParameters" class="doc-link"></a>
|
|
<span class="type-signature attribute-readonly">readonly</span>queryParameters<span class="type-signature"> : Object</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L442">Core/Resource.js 442</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
Query parameters appended to the url.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="request">
|
|
<a href="#request" class="doc-link"></a>
|
|
request<span class="type-signature"> : <a href="Request.html">Request</a></span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L313">Core/Resource.js 313</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
A Request object that will be used. Intended for internal use only.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="retryAttempts">
|
|
<a href="#retryAttempts" class="doc-link"></a>
|
|
retryAttempts<span class="type-signature"> : Number</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L334">Core/Resource.js 334</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
The number of times the retryCallback should be called before giving up.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="retryCallback">
|
|
<a href="#retryCallback" class="doc-link"></a>
|
|
retryCallback<span class="type-signature"> : function</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L327">Core/Resource.js 327</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
Function to call when a request for this resource fails. If it returns true or a Promise that resolves to true, the request will be retried.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="templateValues">
|
|
<a href="#templateValues" class="doc-link"></a>
|
|
<span class="type-signature attribute-readonly">readonly</span>templateValues<span class="type-signature"> : Object</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L456">Core/Resource.js 456</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
The key/value pairs used to replace template parameters in the url.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="url">
|
|
<a href="#url" class="doc-link"></a>
|
|
url<span class="type-signature"> : String</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L468">Core/Resource.js 468</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="description">
|
|
The url to the resource with template values replaced, query string appended and encoded by proxy if one was set.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="subsection-title">Methods</h3>
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".delete">
|
|
<a href="#.delete" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.delete<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1520">Core/Resource.js 1520</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls delete() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</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>
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetch">
|
|
<a href="#.fetch" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetch<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1463">Core/Resource.js 1463</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls fetch() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetchArrayBuffer">
|
|
<a href="#.fetchArrayBuffer" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetchArrayBuffer<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<ArrayBuffer>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L791">Core/Resource.js 791</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource and calls fetchArrayBuffer() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetchBlob">
|
|
<a href="#.fetchBlob" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetchBlob<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Blob>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L835">Core/Resource.js 835</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource and calls fetchBlob() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetchImage">
|
|
<a href="#.fetchImage" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetchImage<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<ImageBitmap>|Promise.<Image>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1038">Core/Resource.js 1038</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource and calls fetchImage() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>flipY</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Whether to vertically flip the image during fetch and decode. Only applies when requesting an image and the browser supports <code>createImageBitmap</code>.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>preferBlob</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, we will load the image via a blob.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>preferImageBitmap</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, image will be decoded during fetch and an <code>ImageBitmap</code> is returned.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetchJson">
|
|
<a href="#.fetchJson" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetchJson<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1155">Core/Resource.js 1155</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource and calls fetchJson() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetchJsonp">
|
|
<a href="#.fetchJsonp" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetchJsonp<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1306">Core/Resource.js 1306</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls fetchJsonp() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>callbackParameterName</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">'callback'</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The callback parameter name that the server expects.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetchText">
|
|
<a href="#.fetchText" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetchText<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<String>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1093">Core/Resource.js 1093</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource and calls fetchText() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".fetchXML">
|
|
<a href="#.fetchXML" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.fetchXML<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<XMLDocument>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1204">Core/Resource.js 1204</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource and calls fetchXML() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".head">
|
|
<a href="#.head" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.head<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1577">Core/Resource.js 1577</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls head() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".options">
|
|
<a href="#.options" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.options<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1633">Core/Resource.js 1633</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls options() on it.
|
|
</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">String</span>
|
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".patch">
|
|
<a href="#.patch" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.patch<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1817">Core/Resource.js 1817</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls patch() on it.
|
|
</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">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".post">
|
|
<a href="#.post" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.post<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1695">Core/Resource.js 1695</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls post() on it.
|
|
</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">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id=".put">
|
|
<a href="#.put" class="doc-link"></a>
|
|
<span class="type-signature attribute-static">static</span>Cesium.Resource.put<span class="signature">(options)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1756">Core/Resource.js 1756</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Creates a Resource from a URL and calls put() on it.
|
|
</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">
|
|
|
|
A url or an 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The url of the resource.</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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be sent when retrieving the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}).</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The Function to call when a request for this resource fails. If it returns true, the request will be retried.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="appendForwardSlash">
|
|
<a href="#appendForwardSlash" class="doc-link"></a>
|
|
appendForwardSlash<span class="signature">()</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L748">Core/Resource.js 748</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Appends a forward slash to the URL.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="appendQueryParameters">
|
|
<a href="#appendQueryParameters" class="doc-link"></a>
|
|
appendQueryParameters<span class="signature">(params)</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L607">Core/Resource.js 607</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Combines the specified object and the existing query parameters. This allows you to add many parameters at once,
|
|
as opposed to adding them one at a time to the queryParameters property.
|
|
</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>params</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
The query parameters</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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> → <span class="type-signature returnType"><a href="Resource.html">Resource</a></span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L714">Core/Resource.js 714</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Duplicates a Resource 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="Resource.html">Resource</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The object onto which to store the result.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
The modified result parameter or a new Resource instance if one was not provided.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="delete">
|
|
<a href="#delete" class="doc-link"></a>
|
|
delete<span class="signature">(<span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1496">Core/Resource.js 1496</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously deletes the given resource. Returns a promise that will resolve to
|
|
the result once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</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 class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers to send with the request, if any.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.delete()
|
|
.then(function(body) {
|
|
// use the data
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetch">
|
|
<a href="#fetch" class="doc-link"></a>
|
|
fetch<span class="signature">(<span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1440">Core/Resource.js 1440</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously loads the given resource. Returns a promise that will resolve to
|
|
the result once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled. It's recommended that you use
|
|
the more specific functions eg. fetchJson, fetchBlob, etc.
|
|
</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 class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers to send with the request, if any.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.fetch()
|
|
.then(function(body) {
|
|
// use the data
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetchArrayBuffer">
|
|
<a href="#fetchArrayBuffer" class="doc-link"></a>
|
|
fetchArrayBuffer<span class="signature">()</span> → <span class="type-signature returnType">Promise.<ArrayBuffer>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L771">Core/Resource.js 771</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously loads the resource as raw binary data. Returns a promise that will resolve to
|
|
an ArrayBuffer once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">// load a single URL asynchronously
|
|
resource.fetchArrayBuffer().then(function(arrayBuffer) {
|
|
// use the data
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetchBlob">
|
|
<a href="#fetchBlob" class="doc-link"></a>
|
|
fetchBlob<span class="signature">()</span> → <span class="type-signature returnType">Promise.<Blob>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L815">Core/Resource.js 815</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously loads the given resource as a blob. Returns a promise that will resolve to
|
|
a Blob once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">// load a single URL asynchronously
|
|
resource.fetchBlob().then(function(blob) {
|
|
// use the data
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetchImage">
|
|
<a href="#fetchImage" class="doc-link"></a>
|
|
fetchImage<span class="signature">(<span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<ImageBitmap>|Promise.<Image>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L868">Core/Resource.js 868</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously loads the given image resource. Returns a promise that will resolve to
|
|
an <a href="https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap">ImageBitmap</a> if <code>preferImageBitmap</code> is true and the browser supports <code>createImageBitmap</code> or otherwise an
|
|
<a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement">Image</a> once loaded, or reject if the image failed to load.
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
An 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>preferBlob</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, we will load the image via a blob.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>preferImageBitmap</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, image will be decoded during fetch and an <code>ImageBitmap</code> is returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>flipY</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, image will be vertically flipped during decode. Only applies if the browser supports <code>createImageBitmap</code>.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">// load a single image asynchronously
|
|
resource.fetchImage().then(function(image) {
|
|
// use the loaded image
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});
|
|
|
|
// load several images in parallel
|
|
when.all([resource1.fetchImage(), resource2.fetchImage()]).then(function(images) {
|
|
// images is an array containing all the loaded images
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetchJson">
|
|
<a href="#fetchJson" class="doc-link"></a>
|
|
fetchJson<span class="signature">()</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1120">Core/Resource.js 1120</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously loads the given resource as JSON. Returns a promise that will resolve to
|
|
a JSON object once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled. This function
|
|
adds 'Accept: application/json,*/*;q=0.01' to the request headers, if not
|
|
already specified.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.fetchJson().then(function(jsonData) {
|
|
// Do something with the JSON object
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetchJsonp">
|
|
<a href="#fetchJsonp" class="doc-link"></a>
|
|
fetchJsonp<span class="signature">(<span class="optional">callbackParameterName</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1226">Core/Resource.js 1226</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Requests a resource using JSONP.
|
|
</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>callbackParameterName</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">'callback'</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The callback parameter name that the server expects.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">// load a data asynchronously
|
|
resource.fetchJsonp().then(function(data) {
|
|
// use the loaded data
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetchText">
|
|
<a href="#fetchText" class="doc-link"></a>
|
|
fetchText<span class="signature">()</span> → <span class="type-signature returnType">Promise.<String>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1073">Core/Resource.js 1073</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously loads the given resource as text. Returns a promise that will resolve to
|
|
a String once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">// load text from a URL, setting a custom header
|
|
var resource = new Resource({
|
|
url: 'http://someUrl.com/someJson.txt',
|
|
headers: {
|
|
'X-Custom-Header' : 'some value'
|
|
}
|
|
});
|
|
resource.fetchText().then(function(text) {
|
|
// Do something with the text
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest">XMLHttpRequest</a></li>
|
|
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="fetchXML">
|
|
<a href="#fetchXML" class="doc-link"></a>
|
|
fetchXML<span class="signature">()</span> → <span class="type-signature returnType">Promise.<XMLDocument>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1183">Core/Resource.js 1183</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously loads the given resource as XML. Returns a promise that will resolve to
|
|
an XML Document once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">// load XML from a URL, setting a custom header
|
|
Cesium.loadXML('http://someUrl.com/someXML.xml', {
|
|
'X-Custom-Header' : 'some value'
|
|
}).then(function(document) {
|
|
// Do something with the document
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest">XMLHttpRequest</a></li>
|
|
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="getBaseUri">
|
|
<a href="#getBaseUri" class="doc-link"></a>
|
|
getBaseUri<span class="signature">(<span class="optional">includeQuery</span>)</span> → <span class="type-signature returnType">String</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L741">Core/Resource.js 741</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Returns the base path of the Resource.
|
|
</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>includeQuery</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Whether or not to include the query string and fragment form the uri</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
The base URI of the resource
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="getDerivedResource">
|
|
<a href="#getDerivedResource" class="doc-link"></a>
|
|
getDerivedResource<span class="signature">(options)</span> → <span class="type-signature returnType"><a href="Resource.html">Resource</a></span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L642">Core/Resource.js 642</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Returns a resource relative to the current instance. All properties remain the same as the current instance unless overridden in options.
|
|
</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">
|
|
|
|
An 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>url</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The url that will be resolved relative to the url of the current instance.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>queryParameters</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>
|
|
|
|
|
|
|
|
|
|
|
|
An object containing query parameters that will be combined with those of the current instance.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>templateValues</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>
|
|
|
|
|
|
|
|
|
|
|
|
Key/Value pairs that are used to replace template values (eg. {x}). These will be combined with those of the current instance.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">{}</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers that will be sent.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="DefaultProxy.html">DefaultProxy</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A proxy to be used when loading the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryCallback</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html#~RetryCallback">Resource~RetryCallback</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The function to call when loading the resource fails.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>retryAttempts</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 number of times the retryCallback should be called before giving up.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>request</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Request.html">Request</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
A Request object that will be used. Intended for internal use only.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>preserveQueryParameters</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, this will keep all query parameters from the current resource and derived resource. If false, derived parameters will replace those of the current resource.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
The resource derived from the current one.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="getUrlComponent">
|
|
<a href="#getUrlComponent" class="doc-link"></a>
|
|
getUrlComponent<span class="signature">(<span class="optional">query</span>, <span class="optional">proxy</span>)</span> → <span class="type-signature returnType">String</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L555">Core/Resource.js 555</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Returns the url, optional with the query string and processed by a proxy.
|
|
</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>query</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, the query string is included.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>proxy</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true, the url is processed the proxy object if defined.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
The url with all the requested components.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="head">
|
|
<a href="#head" class="doc-link"></a>
|
|
head<span class="signature">(<span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1554">Core/Resource.js 1554</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously gets headers the given resource. Returns a promise that will resolve to
|
|
the result once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</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 class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers to send with the request, if any.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.head()
|
|
.then(function(headers) {
|
|
// use the data
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="options">
|
|
<a href="#options" class="doc-link"></a>
|
|
options<span class="signature">(<span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1610">Core/Resource.js 1610</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously gets options the given resource. Returns a promise that will resolve to
|
|
the result once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</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 class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers to send with the request, if any.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.options()
|
|
.then(function(headers) {
|
|
// use the data
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="patch">
|
|
<a href="#patch" class="doc-link"></a>
|
|
patch<span class="signature">(data, <span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1790">Core/Resource.js 1790</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously patches data to the given resource. Returns a promise that will resolve to
|
|
the result once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</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>data</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<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 class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers to send with the request, if any.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.patch(data)
|
|
.then(function(result) {
|
|
// use the result
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="post">
|
|
<a href="#post" class="doc-link"></a>
|
|
post<span class="signature">(data, <span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1668">Core/Resource.js 1668</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously posts data to the given resource. Returns a promise that will resolve to
|
|
the result once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</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>data</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<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 class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>data</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers to send with the request, if any.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.post(data)
|
|
.then(function(result) {
|
|
// use the result
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="put">
|
|
<a href="#put" class="doc-link"></a>
|
|
put<span class="signature">(data, <span class="optional">options</span>)</span> → <span class="type-signature returnType">Promise.<Object>|undefined</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L1729">Core/Resource.js 1729</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Asynchronously puts data to the given resource. Returns a promise that will resolve to
|
|
the result once loaded, or reject if the resource failed to load. The data is loaded
|
|
using XMLHttpRequest, which means that in order to make requests to another origin,
|
|
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
|
|
</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>data</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Data that is posted with the resource.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<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 class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>responseType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The type of response. This controls the type of item returned.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>headers</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Additional HTTP headers to send with the request, if any.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>overrideMimeType</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">String</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
Overrides the MIME type returned by the server.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
a promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Example:</h5>
|
|
|
|
<pre><code class="language-javascript">resource.put(data)
|
|
.then(function(result) {
|
|
// use the result
|
|
}).otherwise(function(error) {
|
|
// an error occurred
|
|
});</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>See:</h5>
|
|
<ul class="see-list">
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
|
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="setQueryParameters">
|
|
<a href="#setQueryParameters" class="doc-link"></a>
|
|
setQueryParameters<span class="signature">(params, <span class="optional">useAsDefault</span>)</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L593">Core/Resource.js 593</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Combines the specified object and the existing query parameters. This allows you to add many parameters at once,
|
|
as opposed to adding them one at a time to the queryParameters property. If a value is already set, it will be replaced with the new value.
|
|
</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>params</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The query parameters</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>useAsDefault</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true the params will be used as the default values, so they will only be set if they are undefined.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="setTemplateValues">
|
|
<a href="#setTemplateValues" class="doc-link"></a>
|
|
setTemplateValues<span class="signature">(template, <span class="optional">useAsDefault</span>)</span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L618">Core/Resource.js 618</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
Combines the specified object and the existing template values. This allows you to add many values at once,
|
|
as opposed to adding them one at a time to the templateValues property. If a value is already set, it will become an array and the new value will be appended.
|
|
</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>template</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Object</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The template values</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>useAsDefault</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Boolean</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td class="default">
|
|
|
|
<code class="language-javascript">false</code>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
If true the values will be used as the default values, so they will only be set if they are undefined.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="subsection-title">Type Definitions</h3>
|
|
|
|
|
|
|
|
<div class="nameContainer">
|
|
<h4 class="name" id="~RetryCallback">
|
|
<a href="#~RetryCallback" class="doc-link"></a>
|
|
RetryCallback<span class="signature">(<span class="optional">resource</span>, <span class="optional">error</span>)</span> → <span class="type-signature returnType">Boolean|Promise.<Boolean></span>
|
|
|
|
|
|
<div class="source-link rightLinks">
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Resource.js#L2095">Core/Resource.js 2095</a>
|
|
</div>
|
|
|
|
|
|
</h4>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="description">
|
|
A function that returns the value of the property.
|
|
</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>resource</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The resource that failed to load.</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="name"><code>error</code></td>
|
|
|
|
|
|
<td class="type">
|
|
|
|
|
|
<span class="param-type">Error</span>
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td class="description last">
|
|
|
|
|
|
<span class="optional">optional</span>
|
|
|
|
|
|
|
|
|
|
|
|
The error that occurred during the loading of the resource.</td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
|
<div class="param-desc">
|
|
If true or a promise that resolved to true, the resource will be retried. Otherwise the failure will be returned.
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</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="ArcType"><a href="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</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="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-name="Cesium3DTileFeature"><a href="Cesium3DTileFeature.html">Cesium3DTileFeature</a></li><li data-name="Cesium3DTilePointFeature"><a href="Cesium3DTilePointFeature.html">Cesium3DTilePointFeature</a></li><li data-name="Cesium3DTileset"><a href="Cesium3DTileset.html">Cesium3DTileset</a></li><li data-name="Cesium3DTilesInspector"><a href="Cesium3DTilesInspector.html">Cesium3DTilesInspector</a></li><li data-name="Cesium3DTilesInspectorViewModel"><a href="Cesium3DTilesInspectorViewModel.html">Cesium3DTilesInspectorViewModel</a></li><li data-name="Cesium3DTileStyle"><a href="Cesium3DTileStyle.html">Cesium3DTileStyle</a></li><li data-name="CesiumInspector"><a href="CesiumInspector.html">CesiumInspector</a></li><li data-name="CesiumInspectorViewModel"><a href="CesiumInspectorViewModel.html">CesiumInspectorViewModel</a></li><li data-name="CesiumTerrainProvider"><a href="CesiumTerrainProvider.html">CesiumTerrainProvider</a></li><li data-name="CesiumWidget"><a href="CesiumWidget.html">CesiumWidget</a></li><li data-name="CheckerboardMaterialProperty"><a href="CheckerboardMaterialProperty.html">CheckerboardMaterialProperty</a></li><li data-name="CircleEmitter"><a href="CircleEmitter.html">CircleEmitter</a></li><li data-name="CircleGeometry"><a href="CircleGeometry.html">CircleGeometry</a></li><li data-name="CircleOutlineGeometry"><a href="CircleOutlineGeometry.html">CircleOutlineGeometry</a></li><li data-name="ClassificationPrimitive"><a href="ClassificationPrimitive.html">ClassificationPrimitive</a></li><li data-name="ClassificationType"><a href="ClassificationType.html">ClassificationType</a></li><li data-name="ClippingPlane"><a href="ClippingPlane.html">ClippingPlane</a></li><li data-name="ClippingPlaneCollection"><a href="ClippingPlaneCollection.html">ClippingPlaneCollection</a></li><li data-name="Clock"><a href="Clock.html">Clock</a></li><li data-name="ClockRange"><a href="ClockRange.html">ClockRange</a></li><li data-name="ClockStep"><a href="ClockStep.html">ClockStep</a></li><li data-name="ClockViewModel"><a href="ClockViewModel.html">ClockViewModel</a></li><li data-name="clone"><a href="clone.html">clone</a></li><li data-name="Color"><a href="Color.html">Color</a></li><li data-name="ColorBlendMode"><a href="ColorBlendMode.html">ColorBlendMode</a></li><li data-name="ColorGeometryInstanceAttribute"><a href="ColorGeometryInstanceAttribute.html">ColorGeometryInstanceAttribute</a></li><li data-name="ColorMaterialProperty"><a href="ColorMaterialProperty.html">ColorMaterialProperty</a></li><li data-name="combine"><a href="combine.html">combine</a></li><li data-name="Command"><a href="Command.html">Command</a></li><li data-name="ComponentDatatype"><a href="ComponentDatatype.html">ComponentDatatype</a></li><li data-name="CompositeEntityCollection"><a href="CompositeEntityCollection.html">CompositeEntityCollection</a></li><li data-name="CompositeMaterialProperty"><a href="CompositeMaterialProperty.html">CompositeMaterialProperty</a></li><li data-name="CompositePositionProperty"><a href="CompositePositionProperty.html">CompositePositionProperty</a></li><li data-name="CompositeProperty"><a href="CompositeProperty.html">CompositeProperty</a></li><li data-name="CompressedTextureBuffer"><a href="CompressedTextureBuffer.html">CompressedTextureBuffer</a></li><li data-name="ConditionsExpression"><a href="ConditionsExpression.html">ConditionsExpression</a></li><li data-name="ConeEmitter"><a href="ConeEmitter.html">ConeEmitter</a></li><li data-name="ConstantPositionProperty"><a href="ConstantPositionProperty.html">ConstantPositionProperty</a></li><li data-name="ConstantProperty"><a href="ConstantProperty.html">ConstantProperty</a></li><li data-name="CoplanarPolygonGeometry"><a href="CoplanarPolygonGeometry.html">CoplanarPolygonGeometry</a></li><li data-name="CoplanarPolygonOutlineGeometry"><a href="CoplanarPolygonOutlineGeometry.html">CoplanarPolygonOutlineGeometry</a></li><li data-name="CornerType"><a href="CornerType.html">CornerType</a></li><li data-name="CorridorGeometry"><a href="CorridorGeometry.html">CorridorGeometry</a></li><li data-name="CorridorGeometryUpdater"><a href="CorridorGeometryUpdater.html">CorridorGeometryUpdater</a></li><li data-name="CorridorGraphics"><a href="CorridorGraphics.html">CorridorGraphics</a></li><li data-name="CorridorOutlineGeometry"><a href="CorridorOutlineGeometry.html">CorridorOutlineGeometry</a></li><li data-name="createCommand"><a href="createCommand.html">createCommand</a></li><li data-name="createGuid"><a href="createGuid.html">createGuid</a></li><li data-name="createOpenStreetMapImageryProvider"><a href="createOpenStreetMapImageryProvider.html">createOpenStreetMapImageryProvider</a></li><li data-name="createTangentSpaceDebugPrimitive"><a href="createTangentSpaceDebugPrimitive.html">createTangentSpaceDebugPrimitive</a></li><li data-name="createTaskProcessorWorker"><a href="createTaskProcessorWorker.html">createTaskProcessorWorker</a></li><li data-name="createTileMapServiceImageryProvider"><a href="createTileMapServiceImageryProvider.html">createTileMapServiceImageryProvider</a></li><li data-name="createWorldImagery"><a href="createWorldImagery.html">createWorldImagery</a></li><li data-name="createWorldTerrain"><a href="createWorldTerrain.html">createWorldTerrain</a></li><li data-name="Credit"><a href="Credit.html">Credit</a></li><li data-name="CreditDisplay"><a href="CreditDisplay.html">CreditDisplay</a></li><li data-name="CubicRealPolynomial"><a href="CubicRealPolynomial.html">CubicRealPolynomial</a></li><li data-name="CullFace"><a href="CullFace.html">CullFace</a></li><li data-name="CullingVolume"><a href="CullingVolume.html">CullingVolume</a></li><li data-name="CustomDataSource"><a href="CustomDataSource.html">CustomDataSource</a></li><li data-name="CylinderGeometry"><a href="CylinderGeometry.html">CylinderGeometry</a></li><li data-name="CylinderGeometryUpdater"><a href="CylinderGeometryUpdater.html">CylinderGeometryUpdater</a></li><li data-name="CylinderGraphics"><a href="CylinderGraphics.html">CylinderGraphics</a></li><li data-name="CylinderOutlineGeometry"><a href="CylinderOutlineGeometry.html">CylinderOutlineGeometry</a></li><li data-name="CzmlDataSource"><a href="CzmlDataSource.html">CzmlDataSource</a></li><li data-name="DataSource"><a href="DataSource.html">DataSource</a></li><li data-name="DataSourceClock"><a href="DataSourceClock.html">DataSourceClock</a></li><li data-name="DataSourceCollection"><a href="DataSourceCollection.html">DataSourceCollection</a></li><li data-name="DataSourceDisplay"><a href="DataSourceDisplay.html">DataSourceDisplay</a></li><li data-name="DebugAppearance"><a href="DebugAppearance.html">DebugAppearance</a></li><li data-name="DebugCameraPrimitive"><a href="DebugCameraPrimitive.html">DebugCameraPrimitive</a></li><li data-name="DebugModelMatrixPrimitive"><a href="DebugModelMatrixPrimitive.html">DebugModelMatrixPrimitive</a></li><li data-name="DefaultProxy"><a href="DefaultProxy.html">DefaultProxy</a></li><li data-name="defaultValue"><a href="defaultValue.html">defaultValue</a></li><li data-name="defined"><a href="defined.html">defined</a></li><li data-name="DepthFunction"><a href="DepthFunction.html">DepthFunction</a></li><li data-name="destroyObject"><a href="destroyObject.html">destroyObject</a></li><li data-name="DeveloperError"><a href="DeveloperError.html">DeveloperError</a></li><li data-name="DiscardEmptyTileImagePolicy"><a href="DiscardEmptyTileImagePolicy.html">DiscardEmptyTileImagePolicy</a></li><li data-name="DiscardMissingTileImagePolicy"><a href="DiscardMissingTileImagePolicy.html">DiscardMissingTileImagePolicy</a></li><li data-name="DistanceDisplayCondition"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></li><li data-name="DistanceDisplayConditionGeometryInstanceAttribute"><a href="DistanceDisplayConditionGeometryInstanceAttribute.html">DistanceDisplayConditionGeometryInstanceAttribute</a></li><li data-name="EasingFunction"><a href="EasingFunction.html">EasingFunction</a></li><li data-name="EllipseGeometry"><a href="EllipseGeometry.html">EllipseGeometry</a></li><li data-name="EllipseGeometryUpdater"><a href="EllipseGeometryUpdater.html">EllipseGeometryUpdater</a></li><li data-name="EllipseGraphics"><a href="EllipseGraphics.html">EllipseGraphics</a></li><li data-name="EllipseOutlineGeometry"><a href="EllipseOutlineGeometry.html">EllipseOutlineGeometry</a></li><li data-name="Ellipsoid"><a href="Ellipsoid.html">Ellipsoid</a></li><li data-name="EllipsoidGeodesic"><a href="EllipsoidGeodesic.html">EllipsoidGeodesic</a></li><li data-name="EllipsoidGeometry"><a href="EllipsoidGeometry.html">EllipsoidGeometry</a></li><li data-name="EllipsoidGeometryUpdater"><a href="EllipsoidGeometryUpdater.html">EllipsoidGeometryUpdater</a></li><li data-name="EllipsoidGraphics"><a href="EllipsoidGraphics.html">EllipsoidGraphics</a></li><li data-name="EllipsoidOutlineGeometry"><a href="EllipsoidOutlineGeometry.html">EllipsoidOutlineGeometry</a></li><li data-name="EllipsoidRhumbLine"><a href="EllipsoidRhumbLine.html">EllipsoidRhumbLine</a></li><li data-name="EllipsoidSurfaceAppearance"><a href="EllipsoidSurfaceAppearance.html">EllipsoidSurfaceAppearance</a></li><li data-name="EllipsoidTangentPlane"><a href="EllipsoidTangentPlane.html">EllipsoidTangentPlane</a></li><li data-name="EllipsoidTerrainProvider"><a href="EllipsoidTerrainProvider.html">EllipsoidTerrainProvider</a></li><li data-name="Entity"><a href="Entity.html">Entity</a></li><li data-name="EntityCluster"><a href="EntityCluster.html">EntityCluster</a></li><li data-name="EntityCollection"><a href="EntityCollection.html">EntityCollection</a></li><li data-name="EntityView"><a href="EntityView.html">EntityView</a></li><li data-name="Event"><a href="Event.html">Event</a></li><li data-name="EventHelper"><a href="EventHelper.html">EventHelper</a></li><li data-name="Expression"><a href="Expression.html">Expression</a></li><li data-name="ExtrapolationType"><a href="ExtrapolationType.html">ExtrapolationType</a></li><li data-name="FeatureDetection"><a href="FeatureDetection.html">FeatureDetection</a></li><li data-name="Fog"><a href="Fog.html">Fog</a></li><li data-name="formatError"><a href="formatError.html">formatError</a></li><li data-name="FrameRateMonitor"><a href="FrameRateMonitor.html">FrameRateMonitor</a></li><li data-name="FrustumGeometry"><a href="FrustumGeometry.html">FrustumGeometry</a></li><li data-name="FrustumOutlineGeometry"><a href="FrustumOutlineGeometry.html">FrustumOutlineGeometry</a></li><li data-name="Fullscreen"><a href="Fullscreen.html">Fullscreen</a></li><li data-name="FullscreenButton"><a href="FullscreenButton.html">FullscreenButton</a></li><li data-name="FullscreenButtonViewModel"><a href="FullscreenButtonViewModel.html">FullscreenButtonViewModel</a></li><li data-name="Geocoder"><a href="Geocoder.html">Geocoder</a></li><li data-name="GeocoderService"><a href="GeocoderService.html">GeocoderService</a></li><li data-name="GeocoderViewModel"><a href="GeocoderViewModel.html">GeocoderViewModel</a></li><li data-name="GeocodeType"><a href="GeocodeType.html">GeocodeType</a></li><li data-name="GeographicProjection"><a href="GeographicProjection.html">GeographicProjection</a></li><li data-name="GeographicTilingScheme"><a href="GeographicTilingScheme.html">GeographicTilingScheme</a></li><li data-name="GeoJsonDataSource"><a href="GeoJsonDataSource.html">GeoJsonDataSource</a></li><li data-name="Geometry"><a href="Geometry.html">Geometry</a></li><li data-name="GeometryAttribute"><a href="GeometryAttribute.html">GeometryAttribute</a></li><li data-name="GeometryAttributes"><a href="GeometryAttributes.html">GeometryAttributes</a></li><li data-name="GeometryInstance"><a href="GeometryInstance.html">GeometryInstance</a></li><li data-name="GeometryInstanceAttribute"><a href="GeometryInstanceAttribute.html">GeometryInstanceAttribute</a></li><li data-name="GeometryPipeline"><a href="GeometryPipeline.html">GeometryPipeline</a></li><li data-name="GeometryUpdater"><a href="GeometryUpdater.html">GeometryUpdater</a></li><li data-name="GeometryVisualizer"><a href="GeometryVisualizer.html">GeometryVisualizer</a></li><li data-name="getAbsoluteUri"><a href="getAbsoluteUri.html">getAbsoluteUri</a></li><li data-name="getBaseUri"><a href="getBaseUri.html">getBaseUri</a></li><li data-name="getExtensionFromUri"><a href="getExtensionFromUri.html">getExtensionFromUri</a></li><li data-name="GetFeatureInfoFormat"><a href="GetFeatureInfoFormat.html">GetFeatureInfoFormat</a></li><li data-name="getFilenameFromUri"><a href="getFilenameFromUri.html">getFilenameFromUri</a></li><li data-name="getImagePixels"><a href="getImagePixels.html">getImagePixels</a></li><li data-name="getTimestamp"><a href="getTimestamp.html">getTimestamp</a></li><li data-name="Globe"><a href="Globe.html">Globe</a></li><li data-name="GoogleEarthEnterpriseImageryProvider"><a href="GoogleEarthEnterpriseImageryProvider.html">GoogleEarthEnterpriseImageryProvider</a></li><li data-name="GoogleEarthEnterpriseMapsProvider"><a href="GoogleEarthEnterpriseMapsProvider.html">GoogleEarthEnterpriseMapsProvider</a></li><li data-name="GoogleEarthEnterpriseMetadata"><a href="GoogleEarthEnterpriseMetadata.html">GoogleEarthEnterpriseMetadata</a></li><li data-name="GoogleEarthEnterpriseTerrainData"><a href="GoogleEarthEnterpriseTerrainData.html">GoogleEarthEnterpriseTerrainData</a></li><li data-name="GoogleEarthEnterpriseTerrainProvider"><a href="GoogleEarthEnterpriseTerrainProvider.html">GoogleEarthEnterpriseTerrainProvider</a></li><li data-name="GregorianDate"><a href="GregorianDate.html">GregorianDate</a></li><li data-name="GridImageryProvider"><a href="GridImageryProvider.html">GridImageryProvider</a></li><li data-name="GridMaterialProperty"><a href="GridMaterialProperty.html">GridMaterialProperty</a></li><li data-name="GroundGeometryUpdater"><a href="GroundGeometryUpdater.html">GroundGeometryUpdater</a></li><li data-name="GroundPolylineGeometry"><a href="GroundPolylineGeometry.html">GroundPolylineGeometry</a></li><li data-name="GroundPolylinePrimitive"><a href="GroundPolylinePrimitive.html">GroundPolylinePrimitive</a></li><li data-name="GroundPrimitive"><a href="GroundPrimitive.html">GroundPrimitive</a></li><li data-name="HeadingPitchRange"><a href="HeadingPitchRange.html">HeadingPitchRange</a></li><li data-name="HeadingPitchRoll"><a href="HeadingPitchRoll.html">HeadingPitchRoll</a></li><li data-name="HeightmapTerrainData"><a href="HeightmapTerrainData.html">HeightmapTerrainData</a></li><li data-name="HeightReference"><a href="HeightReference.html">HeightReference</a></li><li data-name="HermitePolynomialApproximation"><a href="HermitePolynomialApproximation.html">HermitePolynomialApproximation</a></li><li data-name="HermiteSpline"><a href="HermiteSpline.html">HermiteSpline</a></li><li data-name="HomeButton"><a href="HomeButton.html">HomeButton</a></li><li data-name="HomeButtonViewModel"><a href="HomeButtonViewModel.html">HomeButtonViewModel</a></li><li data-name="HorizontalOrigin"><a href="HorizontalOrigin.html">HorizontalOrigin</a></li><li data-name="ImageMaterialProperty"><a href="ImageMaterialProperty.html">ImageMaterialProperty</a></li><li data-name="ImageryLayer"><a href="ImageryLayer.html">ImageryLayer</a></li><li data-name="ImageryLayerCollection"><a href="ImageryLayerCollection.html">ImageryLayerCollection</a></li><li data-name="ImageryLayerFeatureInfo"><a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a></li><li data-name="ImageryProvider"><a href="ImageryProvider.html">ImageryProvider</a></li><li data-name="ImagerySplitDirection"><a href="ImagerySplitDirection.html">ImagerySplitDirection</a></li><li data-name="IndexDatatype"><a href="IndexDatatype.html">IndexDatatype</a></li><li data-name="InfoBox"><a href="InfoBox.html">InfoBox</a></li><li data-name="InfoBoxViewModel"><a href="InfoBoxViewModel.html">InfoBoxViewModel</a></li><li data-name="InterpolationAlgorithm"><a href="InterpolationAlgorithm.html">InterpolationAlgorithm</a></li><li data-name="Intersect"><a href="Intersect.html">Intersect</a></li><li data-name="Intersections2D"><a href="Intersections2D.html">Intersections2D</a></li><li data-name="IntersectionTests"><a href="IntersectionTests.html">IntersectionTests</a></li><li data-name="Interval"><a href="Interval.html">Interval</a></li><li data-name="Ion"><a href="Ion.html">Ion</a></li><li data-name="IonGeocoderService"><a href="IonGeocoderService.html">IonGeocoderService</a></li><li data-name="IonImageryProvider"><a href="IonImageryProvider.html">IonImageryProvider</a></li><li data-name="IonResource"><a href="IonResource.html">IonResource</a></li><li data-name="IonWorldImageryStyle"><a href="IonWorldImageryStyle.html">IonWorldImageryStyle</a></li><li data-name="isArray"><a href="isArray.html">isArray</a></li><li data-name="isLeapYear"><a href="isLeapYear.html">isLeapYear</a></li><li data-name="Iso8601"><a href="Iso8601.html">Iso8601</a></li><li data-name="JulianDate"><a href="JulianDate.html">JulianDate</a></li><li data-name="KeyboardEventModifier"><a href="KeyboardEventModifier.html">KeyboardEventModifier</a></li><li data-name="KmlCamera"><a href="KmlCamera.html">KmlCamera</a></li><li data-name="KmlDataSource"><a href="KmlDataSource.html">KmlDataSource</a></li><li data-name="KmlFeatureData"><a href="KmlFeatureData.html">KmlFeatureData</a></li><li data-name="KmlLookAt"><a href="KmlLookAt.html">KmlLookAt</a></li><li data-name="KmlTour"><a href="KmlTour.html">KmlTour</a></li><li data-name="KmlTourFlyTo"><a href="KmlTourFlyTo.html">KmlTourFlyTo</a></li><li data-name="KmlTourWait"><a href="KmlTourWait.html">KmlTourWait</a></li><li data-name="Label"><a href="Label.html">Label</a></li><li data-name="LabelCollection"><a href="LabelCollection.html">LabelCollection</a></li><li data-name="LabelGraphics"><a href="LabelGraphics.html">LabelGraphics</a></li><li data-name="LabelStyle"><a href="LabelStyle.html">LabelStyle</a></li><li data-name="LabelVisualizer"><a href="LabelVisualizer.html">LabelVisualizer</a></li><li data-name="LagrangePolynomialApproximation"><a href="LagrangePolynomialApproximation.html">LagrangePolynomialApproximation</a></li><li data-name="LeapSecond"><a href="LeapSecond.html">LeapSecond</a></li><li data-name="LinearApproximation"><a href="LinearApproximation.html">LinearApproximation</a></li><li data-name="LinearSpline"><a href="LinearSpline.html">LinearSpline</a></li><li data-name="loadCRN"><a href="loadCRN.html">loadCRN</a></li><li data-name="loadKTX"><a href="loadKTX.html">loadKTX</a></li><li data-name="MapboxApi"><a href="MapboxApi.html">MapboxApi</a></li><li data-name="MapboxImageryProvider"><a href="MapboxImageryProvider.html">MapboxImageryProvider</a></li><li data-name="MapMode2D"><a href="MapMode2D.html">MapMode2D</a></li><li data-name="MapProjection"><a href="MapProjection.html">MapProjection</a></li><li data-name="Material"><a href="Material.html">Material</a></li><li data-name="MaterialAppearance"><a href="MaterialAppearance.html">MaterialAppearance</a></li><li data-name="MaterialSupport"><a href="MaterialAppearance.module_MaterialSupport.html">MaterialSupport</a></li><li data-name="MaterialProperty"><a href="MaterialProperty.html">MaterialProperty</a></li><li data-name="Math"><a href="Math.html">Math</a></li><li data-name="Matrix2"><a href="Matrix2.html">Matrix2</a></li><li data-name="Matrix3"><a href="Matrix3.html">Matrix3</a></li><li data-name="Matrix4"><a href="Matrix4.html">Matrix4</a></li><li data-name="mergeSort"><a href="mergeSort.html">mergeSort</a></li><li data-name="Model"><a href="Model.html">Model</a></li><li data-name="ModelAnimation"><a href="ModelAnimation.html">ModelAnimation</a></li><li data-name="ModelAnimationCollection"><a href="ModelAnimationCollection.html">ModelAnimationCollection</a></li><li data-name="ModelAnimationLoop"><a href="ModelAnimationLoop.html">ModelAnimationLoop</a></li><li data-name="ModelGraphics"><a href="ModelGraphics.html">ModelGraphics</a></li><li data-name="ModelMaterial"><a href="ModelMaterial.html">ModelMaterial</a></li><li data-name="ModelMesh"><a href="ModelMesh.html">ModelMesh</a></li><li data-name="ModelNode"><a href="ModelNode.html">ModelNode</a></li><li data-name="ModelVisualizer"><a href="ModelVisualizer.html">ModelVisualizer</a></li><li data-name="Moon"><a href="Moon.html">Moon</a></li><li data-name="NavigationHelpButton"><a href="NavigationHelpButton.html">NavigationHelpButton</a></li><li data-name="NavigationHelpButtonViewModel"><a href="NavigationHelpButtonViewModel.html">NavigationHelpButtonViewModel</a></li><li data-name="NearFarScalar"><a href="NearFarScalar.html">NearFarScalar</a></li><li data-name="NeverTileDiscardPolicy"><a href="NeverTileDiscardPolicy.html">NeverTileDiscardPolicy</a></li><li data-name="NodeTransformationProperty"><a href="NodeTransformationProperty.html">NodeTransformationProperty</a></li><li data-name="objectToQuery"><a href="objectToQuery.html">objectToQuery</a></li><li data-name="Occluder"><a href="Occluder.html">Occluder</a></li><li data-name="OpenCageGeocoderService"><a href="OpenCageGeocoderService.html">OpenCageGeocoderService</a></li><li data-name="OrientedBoundingBox"><a href="OrientedBoundingBox.html">OrientedBoundingBox</a></li><li data-name="OrthographicFrustum"><a href="OrthographicFrustum.html">OrthographicFrustum</a></li><li data-name="OrthographicOffCenterFrustum"><a href="OrthographicOffCenterFrustum.html">OrthographicOffCenterFrustum</a></li><li data-name="Packable"><a href="Packable.html">Packable</a></li><li data-name="PackableForInterpolation"><a href="PackableForInterpolation.html">PackableForInterpolation</a></li><li data-name="Particle"><a href="Particle.html">Particle</a></li><li data-name="ParticleBurst"><a href="ParticleBurst.html">ParticleBurst</a></li><li data-name="ParticleEmitter"><a href="ParticleEmitter.html">ParticleEmitter</a></li><li data-name="ParticleSystem"><a href="ParticleSystem.html">ParticleSystem</a></li><li data-name="PathGraphics"><a href="PathGraphics.html">PathGraphics</a></li><li data-name="PathVisualizer"><a href="PathVisualizer.html">PathVisualizer</a></li><li data-name="PeliasGeocoderService"><a href="PeliasGeocoderService.html">PeliasGeocoderService</a></li><li data-name="PerformanceWatchdog"><a href="PerformanceWatchdog.html">PerformanceWatchdog</a></li><li data-name="PerformanceWatchdogViewModel"><a href="PerformanceWatchdogViewModel.html">PerformanceWatchdogViewModel</a></li><li data-name="PerInstanceColorAppearance"><a href="PerInstanceColorAppearance.html">PerInstanceColorAppearance</a></li><li data-name="PerspectiveFrustum"><a href="PerspectiveFrustum.html">PerspectiveFrustum</a></li><li data-name="PerspectiveOffCenterFrustum"><a href="PerspectiveOffCenterFrustum.html">PerspectiveOffCenterFrustum</a></li><li data-name="PinBuilder"><a href="PinBuilder.html">PinBuilder</a></li><li data-name="PixelFormat"><a href="PixelFormat.html">PixelFormat</a></li><li data-name="Plane"><a href="Plane.html">Plane</a></li><li data-name="PlaneGeometry"><a href="PlaneGeometry.html">PlaneGeometry</a></li><li data-name="PlaneGeometryUpdater"><a href="PlaneGeometryUpdater.html">PlaneGeometryUpdater</a></li><li data-name="PlaneGraphics"><a href="PlaneGraphics.html">PlaneGraphics</a></li><li data-name="PlaneOutlineGeometry"><a href="PlaneOutlineGeometry.html">PlaneOutlineGeometry</a></li><li data-name="PointCloudShading"><a href="PointCloudShading.html">PointCloudShading</a></li><li data-name="PointGraphics"><a href="PointGraphics.html">PointGraphics</a></li><li data-name="pointInsideTriangle"><a href="pointInsideTriangle.html">pointInsideTriangle</a></li><li data-name="PointPrimitive"><a href="PointPrimitive.html">PointPrimitive</a></li><li data-name="PointPrimitiveCollection"><a href="PointPrimitiveCollection.html">PointPrimitiveCollection</a></li><li data-name="PointVisualizer"><a href="PointVisualizer.html">PointVisualizer</a></li><li data-name="PolygonGeometry"><a href="PolygonGeometry.html">PolygonGeometry</a></li><li data-name="PolygonGeometryUpdater"><a href="PolygonGeometryUpdater.html">PolygonGeometryUpdater</a></li><li data-name="PolygonGraphics"><a href="PolygonGraphics.html">PolygonGraphics</a></li><li data-name="PolygonHierarchy"><a href="PolygonHierarchy.html">PolygonHierarchy</a></li><li data-name="PolygonOutlineGeometry"><a href="PolygonOutlineGeometry.html">PolygonOutlineGeometry</a></li><li data-name="Polyline"><a href="Polyline.html">Polyline</a></li><li data-name="PolylineArrowMaterialProperty"><a href="PolylineArrowMaterialProperty.html">PolylineArrowMaterialProperty</a></li><li data-name="PolylineCollection"><a href="PolylineCollection.html">PolylineCollection</a></li><li data-name="PolylineColorAppearance"><a href="PolylineColorAppearance.html">PolylineColorAppearance</a></li><li data-name="PolylineDashMaterialProperty"><a href="PolylineDashMaterialProperty.html">PolylineDashMaterialProperty</a></li><li data-name="PolylineGeometry"><a href="PolylineGeometry.html">PolylineGeometry</a></li><li data-name="PolylineGeometryUpdater"><a href="PolylineGeometryUpdater.html">PolylineGeometryUpdater</a></li><li data-name="PolylineGlowMaterialProperty"><a href="PolylineGlowMaterialProperty.html">PolylineGlowMaterialProperty</a></li><li data-name="PolylineGraphics"><a href="PolylineGraphics.html">PolylineGraphics</a></li><li data-name="PolylineMaterialAppearance"><a href="PolylineMaterialAppearance.html">PolylineMaterialAppearance</a></li><li data-name="PolylineOutlineMaterialProperty"><a href="PolylineOutlineMaterialProperty.html">PolylineOutlineMaterialProperty</a></li><li data-name="PolylineVisualizer"><a href="PolylineVisualizer.html">PolylineVisualizer</a></li><li data-name="PolylineVolumeGeometry"><a href="PolylineVolumeGeometry.html">PolylineVolumeGeometry</a></li><li data-name="PolylineVolumeGeometryUpdater"><a href="PolylineVolumeGeometryUpdater.html">PolylineVolumeGeometryUpdater</a></li><li data-name="PolylineVolumeGraphics"><a href="PolylineVolumeGraphics.html">PolylineVolumeGraphics</a></li><li data-name="PolylineVolumeOutlineGeometry"><a href="PolylineVolumeOutlineGeometry.html">PolylineVolumeOutlineGeometry</a></li><li data-name="PositionProperty"><a href="PositionProperty.html">PositionProperty</a></li><li data-name="PositionPropertyArray"><a href="PositionPropertyArray.html">PositionPropertyArray</a></li><li data-name="PostProcessStage"><a href="PostProcessStage.html">PostProcessStage</a></li><li data-name="PostProcessStageCollection"><a href="PostProcessStageCollection.html">PostProcessStageCollection</a></li><li data-name="PostProcessStageComposite"><a href="PostProcessStageComposite.html">PostProcessStageComposite</a></li><li data-name="PostProcessStageLibrary"><a href="PostProcessStageLibrary.html">PostProcessStageLibrary</a></li><li data-name="PostProcessStageSampleMode"><a href="PostProcessStageSampleMode.html">PostProcessStageSampleMode</a></li><li data-name="Primitive"><a href="Primitive.html">Primitive</a></li><li data-name="PrimitiveCollection"><a href="PrimitiveCollection.html">PrimitiveCollection</a></li><li data-name="PrimitiveType"><a href="PrimitiveType.html">PrimitiveType</a></li><li data-name="ProjectionPicker"><a href="ProjectionPicker.html">ProjectionPicker</a></li><li data-name="ProjectionPickerViewModel"><a href="ProjectionPickerViewModel.html">ProjectionPickerViewModel</a></li><li data-name="Property"><a href="Property.html">Property</a></li><li data-name="PropertyArray"><a href="PropertyArray.html">PropertyArray</a></li><li data-name="PropertyBag"><a href="PropertyBag.html">PropertyBag</a></li><li data-name="ProviderViewModel"><a href="ProviderViewModel.html">ProviderViewModel</a></li><li data-name="QuadraticRealPolynomial"><a href="QuadraticRealPolynomial.html">QuadraticRealPolynomial</a></li><li data-name="QuantizedMeshTerrainData"><a href="QuantizedMeshTerrainData.html">QuantizedMeshTerrainData</a></li><li data-name="QuarticRealPolynomial"><a href="QuarticRealPolynomial.html">QuarticRealPolynomial</a></li><li data-name="Quaternion"><a href="Quaternion.html">Quaternion</a></li><li data-name="QuaternionSpline"><a href="QuaternionSpline.html">QuaternionSpline</a></li><li data-name="queryToObject"><a href="queryToObject.html">queryToObject</a></li><li data-name="Queue"><a href="Queue.html">Queue</a></li><li data-name="Ray"><a href="Ray.html">Ray</a></li><li data-name="Rectangle"><a href="Rectangle.html">Rectangle</a></li><li data-name="RectangleGeometry"><a href="RectangleGeometry.html">RectangleGeometry</a></li><li data-name="RectangleGeometryUpdater"><a href="RectangleGeometryUpdater.html">RectangleGeometryUpdater</a></li><li data-name="RectangleGraphics"><a href="RectangleGraphics.html">RectangleGraphics</a></li><li data-name="RectangleOutlineGeometry"><a href="RectangleOutlineGeometry.html">RectangleOutlineGeometry</a></li><li data-name="ReferenceFrame"><a href="ReferenceFrame.html">ReferenceFrame</a></li><li data-name="ReferenceProperty"><a href="ReferenceProperty.html">ReferenceProperty</a></li><li data-name="Request"><a href="Request.html">Request</a></li><li data-name="requestAnimationFrame"><a href="requestAnimationFrame.html">requestAnimationFrame</a></li><li data-name="RequestErrorEvent"><a href="RequestErrorEvent.html">RequestErrorEvent</a></li><li data-name="RequestState"><a href="RequestState.html">RequestState</a></li><li data-name="RequestType"><a href="RequestType.html">RequestType</a></li><li data-name="Resource"><a href="Resource.html">Resource</a></li><li data-name="Rotation"><a href="Rotation.html">Rotation</a></li><li data-name="RuntimeError"><a href="RuntimeError.html">RuntimeError</a></li><li data-name="SampledPositionProperty"><a href="SampledPositionProperty.html">SampledPositionProperty</a></li><li data-name="SampledProperty"><a href="SampledProperty.html">SampledProperty</a></li><li data-name="sampleTerrain"><a href="sampleTerrain.html">sampleTerrain</a></li><li data-name="sampleTerrainMostDetailed"><a href="sampleTerrainMostDetailed.html">sampleTerrainMostDetailed</a></li><li data-name="Scene"><a href="Scene.html">Scene</a></li><li data-name="SceneMode"><a href="SceneMode.html">SceneMode</a></li><li data-name="SceneModePicker"><a href="SceneModePicker.html">SceneModePicker</a></li><li data-name="SceneModePickerViewModel"><a href="SceneModePickerViewModel.html">SceneModePickerViewModel</a></li><li data-name="SceneTransforms"><a href="SceneTransforms.html">SceneTransforms</a></li><li data-name="ScreenSpaceCameraController"><a href="ScreenSpaceCameraController.html">ScreenSpaceCameraController</a></li><li data-name="ScreenSpaceEventHandler"><a href="ScreenSpaceEventHandler.html">ScreenSpaceEventHandler</a></li><li data-name="ScreenSpaceEventType"><a href="ScreenSpaceEventType.html">ScreenSpaceEventType</a></li><li data-name="SelectionIndicator"><a href="SelectionIndicator.html">SelectionIndicator</a></li><li data-name="SelectionIndicatorViewModel"><a href="SelectionIndicatorViewModel.html">SelectionIndicatorViewModel</a></li><li data-name="ShadowMap"><a href="ShadowMap.html">ShadowMap</a></li><li data-name="ShadowMode"><a href="ShadowMode.html">ShadowMode</a></li><li data-name="ShowGeometryInstanceAttribute"><a href="ShowGeometryInstanceAttribute.html">ShowGeometryInstanceAttribute</a></li><li data-name="Simon1994PlanetaryPositions"><a href="Simon1994PlanetaryPositions.html">Simon1994PlanetaryPositions</a></li><li data-name="SimplePolylineGeometry"><a href="SimplePolylineGeometry.html">SimplePolylineGeometry</a></li><li data-name="SingleTileImageryProvider"><a href="SingleTileImageryProvider.html">SingleTileImageryProvider</a></li><li data-name="SkyAtmosphere"><a href="SkyAtmosphere.html">SkyAtmosphere</a></li><li data-name="SkyBox"><a href="SkyBox.html">SkyBox</a></li><li data-name="SphereEmitter"><a href="SphereEmitter.html">SphereEmitter</a></li><li data-name="SphereGeometry"><a href="SphereGeometry.html">SphereGeometry</a></li><li data-name="SphereOutlineGeometry"><a href="SphereOutlineGeometry.html">SphereOutlineGeometry</a></li><li data-name="Spherical"><a href="Spherical.html">Spherical</a></li><li data-name="Spline"><a href="Spline.html">Spline</a></li><li data-name="StencilFunction"><a href="StencilFunction.html">StencilFunction</a></li><li data-name="StencilOperation"><a href="StencilOperation.html">StencilOperation</a></li><li data-name="StripeMaterialProperty"><a href="StripeMaterialProperty.html">StripeMaterialProperty</a></li><li data-name="StripeOrientation"><a href="StripeOrientation.html">StripeOrientation</a></li><li data-name="StyleExpression"><a href="StyleExpression.html">StyleExpression</a></li><li data-name="subdivideArray"><a href="subdivideArray.html">subdivideArray</a></li><li data-name="Sun"><a href="Sun.html">Sun</a></li><li data-name="SvgPathBindingHandler"><a href="SvgPathBindingHandler.html">SvgPathBindingHandler</a></li><li data-name="TaskProcessor"><a href="TaskProcessor.html">TaskProcessor</a></li><li data-name="TerrainData"><a href="TerrainData.html">TerrainData</a></li><li data-name="TerrainProvider"><a href="TerrainProvider.html">TerrainProvider</a></li><li data-name="TextureMagnificationFilter"><a href="TextureMagnificationFilter.html">TextureMagnificationFilter</a></li><li data-name="TextureMinificationFilter"><a href="TextureMinificationFilter.html">TextureMinificationFilter</a></li><li data-name="TileAvailability"><a href="TileAvailability.html">TileAvailability</a></li><li data-name="TileCoordinatesImageryProvider"><a href="TileCoordinatesImageryProvider.html">TileCoordinatesImageryProvider</a></li><li data-name="TileDiscardPolicy"><a href="TileDiscardPolicy.html">TileDiscardPolicy</a></li><li data-name="TileProviderError"><a href="TileProviderError.html">TileProviderError</a></li><li data-name="TilingScheme"><a href="TilingScheme.html">TilingScheme</a></li><li data-name="TimeDynamicImagery"><a href="TimeDynamicImagery.html">TimeDynamicImagery</a></li><li data-name="TimeDynamicPointCloud"><a href="TimeDynamicPointCloud.html">TimeDynamicPointCloud</a></li><li data-name="TimeInterval"><a href="TimeInterval.html">TimeInterval</a></li><li data-name="TimeIntervalCollection"><a href="TimeIntervalCollection.html">TimeIntervalCollection</a></li><li data-name="TimeIntervalCollectionPositionProperty"><a href="TimeIntervalCollectionPositionProperty.html">TimeIntervalCollectionPositionProperty</a></li><li data-name="TimeIntervalCollectionProperty"><a href="TimeIntervalCollectionProperty.html">TimeIntervalCollectionProperty</a></li><li data-name="Timeline"><a href="Timeline.html">Timeline</a></li><li data-name="TimeStandard"><a href="TimeStandard.html">TimeStandard</a></li><li data-name="ToggleButtonViewModel"><a href="ToggleButtonViewModel.html">ToggleButtonViewModel</a></li><li data-name="Transforms"><a href="Transforms.html">Transforms</a></li><li data-name="TranslationRotationScale"><a href="TranslationRotationScale.html">TranslationRotationScale</a></li><li data-name="TridiagonalSystemSolver"><a href="TridiagonalSystemSolver.html">TridiagonalSystemSolver</a></li><li data-name="TrustedServers"><a href="TrustedServers.html">TrustedServers</a></li><li data-name="UrlTemplateImageryProvider"><a href="UrlTemplateImageryProvider.html">UrlTemplateImageryProvider</a></li><li data-name="VelocityOrientationProperty"><a href="VelocityOrientationProperty.html">VelocityOrientationProperty</a></li><li data-name="VelocityVectorProperty"><a href="VelocityVectorProperty.html">VelocityVectorProperty</a></li><li data-name="VertexFormat"><a href="VertexFormat.html">VertexFormat</a></li><li data-name="VerticalOrigin"><a href="VerticalOrigin.html">VerticalOrigin</a></li><li data-name="VideoSynchronizer"><a href="VideoSynchronizer.html">VideoSynchronizer</a></li><li data-name="Viewer"><a href="Viewer.html">Viewer</a></li><li data-name="viewerCesium3DTilesInspectorMixin"><a href="viewerCesium3DTilesInspectorMixin.html">viewerCesium3DTilesInspectorMixin</a></li><li data-name="viewerCesiumInspectorMixin"><a href="viewerCesiumInspectorMixin.html">viewerCesiumInspectorMixin</a></li><li data-name="viewerDragDropMixin"><a href="viewerDragDropMixin.html">viewerDragDropMixin</a></li><li data-name="viewerPerformanceWatchdogMixin"><a href="viewerPerformanceWatchdogMixin.html">viewerPerformanceWatchdogMixin</a></li><li data-name="ViewportQuad"><a href="ViewportQuad.html">ViewportQuad</a></li><li data-name="Visibility"><a href="Visibility.html">Visibility</a></li><li data-name="Visualizer"><a href="Visualizer.html">Visualizer</a></li><li data-name="VRButton"><a href="VRButton.html">VRButton</a></li><li data-name="VRButtonViewModel"><a href="VRButtonViewModel.html">VRButtonViewModel</a></li><li data-name="VRTheWorldTerrainProvider"><a href="VRTheWorldTerrainProvider.html">VRTheWorldTerrainProvider</a></li><li data-name="WallGeometry"><a href="WallGeometry.html">WallGeometry</a></li><li data-name="WallGeometryUpdater"><a href="WallGeometryUpdater.html">WallGeometryUpdater</a></li><li data-name="WallGraphics"><a href="WallGraphics.html">WallGraphics</a></li><li data-name="WallOutlineGeometry"><a href="WallOutlineGeometry.html">WallOutlineGeometry</a></li><li data-name="WebGLConstants"><a href="WebGLConstants.html">WebGLConstants</a></li><li data-name="WebMapServiceImageryProvider"><a href="WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li><li data-name="WebMapTileServiceImageryProvider"><a href="WebMapTileServiceImageryProvider.html">WebMapTileServiceImageryProvider</a></li><li data-name="WebMercatorProjection"><a href="WebMercatorProjection.html">WebMercatorProjection</a></li><li data-name="WebMercatorTilingScheme"><a href="WebMercatorTilingScheme.html">WebMercatorTilingScheme</a></li><li data-name="WeightSpline"><a href="WeightSpline.html">WeightSpline</a></li><li data-name="WindingOrder"><a href="WindingOrder.html">WindingOrder</a></li><li data-name="writeTextToCanvas"><a href="writeTextToCanvas.html">writeTextToCanvas</a></li></ul>
|
|
</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> |