Clustering¶

Cluster nearby points, billboards, and labels into a single badge.

import cesiumkit

viewer = cesiumkit.Viewer(
    clustering=cesiumkit.EntityClusterConfig(
        enabled=True,
        pixel_range=64,
        minimum_cluster_size=2,
    )
)

clustering ¶

Entity clustering configuration for CesiumJS EntityCluster.

Classes:

Name	Description
`EntityClusterConfig`	Configure clustering of points, billboards, and labels.

EntityClusterConfig ¶

Bases: CesiumBase

Configure clustering of points, billboards, and labels.

Maps to Cesium's EntityCollection.clustering, which is an EntityCluster instance. Clustering groups nearby entities into a single cluster label once they are closer than pixel_range.

Methods:

Name	Description
`to_js_statements`	Return JS statements configuring the viewer's entity clustering.

to_js_statements ¶

to_js_statements(viewer_var: str = 'viewer') -> list[str]

Return JS statements configuring the viewer's entity clustering.