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

1200 lines
62 KiB
HTML
Raw Permalink 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>DataSourceDisplay - 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>
DataSourceDisplay
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="DataSourceDisplay">
<a href="#DataSourceDisplay" class="doc-link"></a>
new Cesium.DataSourceDisplay<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L35">DataSources/DataSourceDisplay.js 35</a>
</div>
</h4>
</div>
<div class="description">
Visualizes a collection of <a href="DataSource.html"><code>DataSource</code></a> instances.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The scene in which to display the data.</td>
</tr>
<tr>
<td class="name"><code>dataSourceCollection</code></td>
<td class="type">
<span class="param-type"><a href="DataSourceCollection.html">DataSourceCollection</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The data sources to display.</td>
</tr>
<tr>
<td class="name"><code>visualizersCallback</code></td>
<td class="type">
<span class="param-type"><a href="DataSourceDisplay.html#.VisualizersCallback">DataSourceDisplay.VisualizersCallback</a></span>
</td>
<td class="default">
<code class="language-javascript">DataSourceDisplay.defaultVisualizersCallback</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A function which creates an array of visualizers used for visualization.
If undefined, all standard visualizers are used.</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="dataSources">
<a href="#dataSources" class="doc-link"></a>
dataSources<span class="type-signature"> : <a href="DataSourceCollection.html">DataSourceCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L173">DataSources/DataSourceDisplay.js 173</a>
</div>
</h4>
</div>
<div class="description">
Gets the collection of data sources to display.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultDataSource">
<a href="#defaultDataSource" class="doc-link"></a>
defaultDataSource<span class="type-signature"> : <a href="CustomDataSource.html">CustomDataSource</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L186">DataSources/DataSourceDisplay.js 186</a>
</div>
</h4>
</div>
<div class="description">
Gets the default data source instance which can be used to
manually create and visualize entities not tied to
a specific data source. This instance is always available
and does not appear in the list dataSources collection.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="ready">
<a href="#ready" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> ready<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L198">DataSources/DataSourceDisplay.js 198</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating whether or not all entities in the data source are ready
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="scene">
<a href="#scene" class="doc-link"></a>
scene<span class="type-signature"> : <a href="Scene.html">Scene</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L163">DataSources/DataSourceDisplay.js 163</a>
</div>
</h4>
</div>
<div class="description">
Gets the scene associated with this display.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".defaultVisualizersCallback">
<a href="#.defaultVisualizersCallback" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.DataSourceDisplay.defaultVisualizersCallback<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L129">DataSources/DataSourceDisplay.js 129</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the default function which creates an array of visualizers used for visualization.
By default, this function uses all standard visualizers.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L235">DataSources/DataSourceDisplay.js 235</a>
</div>
</h4>
</div>
<div class="description">
Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
release of WebGL resources, instead of relying on the garbage collector to destroy this object.
<br /><br />
Once an object is destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore,
assign the return value (<code>undefined</code>) to the object as done in the example.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">dataSourceDisplay = dataSourceDisplay.destroy();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="DataSourceDisplay.html#isDestroyed">DataSourceDisplay#isDestroyed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="isDestroyed">
<a href="#isDestroyed" class="doc-link"></a>
isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L215">DataSources/DataSourceDisplay.js 215</a>
</div>
</h4>
</div>
<div class="description">
Returns true if this object was destroyed; otherwise, false.
<br /><br />
If this object was destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception.
</div>
<h5>Returns:</h5>
<div class="param-desc">
True if this object was destroyed; otherwise, false.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="DataSourceDisplay.html#destroy">DataSourceDisplay#destroy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="update">
<a href="#update" class="doc-link"></a>
update<span class="signature">(time)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L264">DataSources/DataSourceDisplay.js 264</a>
</div>
</h4>
</div>
<div class="description">
Updates the display to the provided time.
</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>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The simulation time.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
True if all data sources are ready to be displayed, false otherwise.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".VisualizersCallback">
<a href="#.VisualizersCallback" class="doc-link"></a>
Cesium.DataSourceDisplay.VisualizersCallback<span class="signature">(scene, dataSource)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="Visualizer.html">Visualizer</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/DataSourceDisplay.js#L497">DataSources/DataSourceDisplay.js 497</a>
</div>
</h4>
</div>
<div class="description">
A function which creates an array of visualizers used for visualization.
</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>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="description last">
The scene to create visualizers for.</td>
</tr>
<tr>
<td class="name"><code>dataSource</code></td>
<td class="type">
<span class="param-type"><a href="DataSource.html">DataSource</a></span>
</td>
<td class="description last">
The data source to create visualizers for.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
An array of visualizers used for visualization.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">function createVisualizers(scene, dataSource) {
return [new Cesium.BillboardVisualizer(scene, dataSource.entities)];
}</code></pre>
</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>