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

1258 lines
63 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>EntityCluster - 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>
EntityCluster
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="EntityCluster">
<a href="#EntityCluster" class="doc-link"></a>
new Cesium.EntityCluster<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/DataSources/EntityCluster.js#L35">DataSources/EntityCluster.js 35</a>
</div>
</h4>
</div>
<div class="description">
Defines how screen space objects (billboards, points, labels) are clustered.
</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>enabled</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 enable clustering.</td>
</tr>
<tr>
<td class="name"><code>pixelRange</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">80</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The pixel range to extend the screen space bounding box.</td>
</tr>
<tr>
<td class="name"><code>minimumClusterSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">2</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The minimum number of screen space objects that can be clustered.</td>
</tr>
<tr>
<td class="name"><code>clusterBillboards</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether or not to cluster the billboards of an entity.</td>
</tr>
<tr>
<td class="name"><code>clusterLabels</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether or not to cluster the labels of an entity.</td>
</tr>
<tr>
<td class="name"><code>clusterPoints</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether or not to cluster the points of an entity.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Determines if the entities in the cluster will be shown.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Clustering.html">Cesium Sandcastle Clustering Demo</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="clusterBillboards">
<a href="#clusterBillboards" class="doc-link"></a>
clusterBillboards<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L575">DataSources/EntityCluster.js 575</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether clustering billboard entities is enabled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clusterEvent">
<a href="#clusterEvent" class="doc-link"></a>
clusterEvent<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L565">DataSources/EntityCluster.js 565</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that will be raised when a new cluster will be displayed. The signature of the event listener is <a href="EntityCluster.html#.newClusterCallback"><code>EntityCluster.newClusterCallback</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clusterLabels">
<a href="#clusterLabels" class="doc-link"></a>
clusterLabels<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L590">DataSources/EntityCluster.js 590</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether clustering labels entities is enabled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clusterPoints">
<a href="#clusterPoints" class="doc-link"></a>
clusterPoints<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L604">DataSources/EntityCluster.js 604</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether clustering point entities is enabled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="enabled">
<a href="#enabled" class="doc-link"></a>
enabled<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L522">DataSources/EntityCluster.js 522</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether clustering is enabled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="minimumClusterSize">
<a href="#minimumClusterSize" class="doc-link"></a>
minimumClusterSize<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L550">DataSources/EntityCluster.js 550</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the minimum number of screen space objects that can be clustered.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pixelRange">
<a href="#pixelRange" class="doc-link"></a>
pixelRange<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L536">DataSources/EntityCluster.js 536</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the pixel range to extend the screen space bounding box.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L76">DataSources/EntityCluster.js 76</a>
</div>
</h4>
</div>
<div class="description">
Determines if entities in this collection will be shown.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<h3 class="subsection-title">Methods</h3>
<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/EntityCluster.js#L931">DataSources/EntityCluster.js 931</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.
<p>
Unlike other objects that use WebGL resources, this object can be reused. For example, if a data source is removed
from a data source collection and added to another.
</p>
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".newClusterCallback">
<a href="#.newClusterCallback" class="doc-link"></a>
Cesium.EntityCluster.newClusterCallback<span class="signature">(clusteredEntities, cluster)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/EntityCluster.js#L976">DataSources/EntityCluster.js 976</a>
</div>
</h4>
</div>
<div class="description">
A event listener function used to style clusters.
</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>clusteredEntities</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Entity.html">Entity</a>></span>
</td>
<td class="description last">
An array of the entities contained in the cluster.</td>
</tr>
<tr>
<td class="name"><code>cluster</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
An object containing billboard, label, and point properties. The values are the same as
billboard, label and point entities, but must be the values of the ConstantProperty.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// The default cluster values.
dataSource.clustering.clusterEvent.addEventListener(function(entities, cluster) {
cluster.label.show = true;
cluster.label.text = entities.length.toLocaleString();
});</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>