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

1515 lines
66 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Request - 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>
Request
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Request">
<a href="#Request" class="doc-link"></a>
new Cesium.Request<span class="signature">(<span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L22">Core/Request.js 22</a>
</div>
</h4>
</div>
<div class="description">
Stores information for making a request. In general this does not need to be constructed directly.
</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>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 to request.</td>
</tr>
<tr>
<td class="name"><code>requestFunction</code></td>
<td class="type">
<span class="param-type"><a href="Request.html#.RequestCallback">Request.RequestCallback</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The function that makes the actual data request.</td>
</tr>
<tr>
<td class="name"><code>cancelFunction</code></td>
<td class="type">
<span class="param-type"><a href="Request.html#.CancelCallback">Request.CancelCallback</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The function that is called when the request is cancelled.</td>
</tr>
<tr>
<td class="name"><code>priorityFunction</code></td>
<td class="type">
<span class="param-type"><a href="Request.html#.PriorityCallback">Request.PriorityCallback</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The function that is called to update the request's priority, which occurs once per frame.</td>
</tr>
<tr>
<td class="name"><code>priority</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The initial priority of the request.</td>
</tr>
<tr>
<td class="name"><code>throttle</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 throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority.</td>
</tr>
<tr>
<td class="name"><code>throttleByServer</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 throttle the request by server.</td>
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type"><a href="global.html#RequestType">RequestType</a></span>
</td>
<td class="default">
<code class="language-javascript">RequestType.OTHER</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The type of request.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="cancelFunction">
<a href="#cancelFunction" class="doc-link"></a>
cancelFunction<span class="type-signature"> : <a href="Request.html#.CancelCallback">Request.CancelCallback</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L47">Core/Request.js 47</a>
</div>
</h4>
</div>
<div class="description">
The function that is called when the request is cancelled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="priority">
<a href="#priority" class="doc-link"></a>
priority<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L66">Core/Request.js 66</a>
</div>
</h4>
</div>
<div class="description">
Priority is a unit-less value where lower values represent higher priority.
For world-based objects, this is usually the distance from the camera.
A request that does not have a priority function defaults to a priority of 0.
If priorityFunction is defined, this value is updated every frame with the result of that call.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="priorityFunction">
<a href="#priorityFunction" class="doc-link"></a>
priorityFunction<span class="type-signature"> : <a href="Request.html#.PriorityCallback">Request.PriorityCallback</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L54">Core/Request.js 54</a>
</div>
</h4>
</div>
<div class="description">
The function that is called to update the request's priority, which occurs once per frame.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="requestFunction">
<a href="#requestFunction" class="doc-link"></a>
requestFunction<span class="type-signature"> : <a href="Request.html#.RequestCallback">Request.RequestCallback</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L40">Core/Request.js 40</a>
</div>
</h4>
</div>
<div class="description">
The function that makes the actual data request.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="state">
<a href="#state" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> state<span class="type-signature"> : <a href="global.html#RequestState">RequestState</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L116">Core/Request.js 116</a>
</div>
</h4>
</div>
<div class="description">
The current state of the request.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="throttle">
<a href="#throttle" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> throttle<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L77">Core/Request.js 77</a>
</div>
</h4>
</div>
<div class="description">
Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the
request will be throttled and sent based on priority.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="throttleByServer">
<a href="#throttleByServer" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> throttleByServer<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L89">Core/Request.js 89</a>
</div>
</h4>
</div>
<div class="description">
Whether to throttle the request by server. Browsers typically support about 6-8 parallel connections
for HTTP/1 servers, and an unlimited amount of connections for HTTP/2 servers. Setting this value
to <code>true</code> is preferable for requests going through HTTP/1 servers.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="type">
<a href="#type" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> type<span class="type-signature"> : <a href="global.html#RequestType">RequestType</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L99">Core/Request.js 99</a>
</div>
</h4>
</div>
<div class="description">
Type of request.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">RequestType.OTHER</code>
</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/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L33">Core/Request.js 33</a>
</div>
</h4>
</div>
<div class="description">
The URL to request.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="clone">
<a href="#clone" class="doc-link"></a>
clone<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Request.html">Request</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L153">Core/Request.js 153</a>
</div>
</h4>
</div>
<div class="description">
Duplicates a Request 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="Request.html">Request</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>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".CancelCallback">
<a href="#.CancelCallback" class="doc-link"></a>
Cesium.Request.CancelCallback<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L182">Core/Request.js 182</a>
</div>
</h4>
</div>
<div class="description">
The function that is called when the request is cancelled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".PriorityCallback">
<a href="#.PriorityCallback" class="doc-link"></a>
Cesium.Request.PriorityCallback<span class="signature">()</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L187">Core/Request.js 187</a>
</div>
</h4>
</div>
<div class="description">
The function that is called to update the request's priority, which occurs once per frame.
</div>
<h5>Returns:</h5>
<div class="param-desc">
The updated priority value.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".RequestCallback">
<a href="#.RequestCallback" class="doc-link"></a>
Cesium.Request.RequestCallback<span class="signature">()</span> &rarr; <span class="type-signature returnType">Promise.&lt;void></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Request.js#L176">Core/Request.js 176</a>
</div>
</h4>
</div>
<div class="description">
The function that makes the actual data request.
</div>
<h5>Returns:</h5>
<div class="param-desc">
A promise for the requested data.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>