Class: EntityCluster

EntityCluster

new EntityCluster(optionsopt)

Defines how screen space objects (billboards, points, labels) are clustered.
Parameters:
Name Type Attributes Description
options Object <optional>
 An object with the following properties:
Properties
Name Type Attributes Default Description
enabled Boolean <optional>
 false Whether or not to enable clustering.
pixelRange Number <optional>
 80 The pixel range to extend the screen space bounding box.
minimumClusterSize Number <optional>
 2 The minimum number of screen space objects that can be clustered.
clusterBillboards Boolean <optional>
 true Whether or not to cluster the billboards of an entity.
clusterLabels Boolean <optional>
 true Whether or not to cluster the labels of an entity.
clusterPoints Boolean <optional>
 true Whether or not to cluster the points of an entity.
Source:

Members

clusterBillboards :Boolean

Gets or sets whether clustering billboard entities is enabled.
Type:
  • Boolean
Source:

clusterEvent :Event

Gets the event that will be raised when a new cluster will be displayed. The signature of the event listener is EntityCluster~newClusterCallback.
Type:
Source:

clusterLabels :Boolean

Gets or sets whether clustering labels entities is enabled.
Type:
  • Boolean
Source:

clusterPoints :Boolean

Gets or sets whether clustering point entities is enabled.
Type:
  • Boolean
Source:

enabled :Boolean

Gets or sets whether clustering is enabled.
Type:
  • Boolean
Source:

minimumClusterSize :Number

Gets or sets the minimum number of screen space objects that can be clustered.
Type:
  • Number
Source:

pixelRange :Number

Gets or sets the pixel range to extend the screen space bounding box.
Type:
  • Number
Source:

Methods

destroy() → {undefined}

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.

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.

Source:
Returns:
Type
undefined

Type Definitions

newClusterCallback(clusteredEntities, cluster)

A event listener function used to style clusters.
Parameters:
Name Type Description
clusteredEntities Array.<Entity> An array of the entities contained in the cluster.
cluster Object 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.
Source:
Example
// The default cluster values.
dataSource.clustering.clusterEvent.addEventListener(function(entities, cluster) {
    cluster.label.show = true;
    cluster.label.text = entities.length.toLocaleString();
});