XYZ Maps Documentation
    Preparing search index...

    Type Alias ClusterFeatureProperties

    Properties of a ClusterFeature.

    The isCluster, clusterSize, and zoom properties are automatically populated for each cluster feature.

    Custom properties aggregation for clusters can be achieved by defining custom property creation and aggregation functions using the createProperties and aggregateProperties options.

    type ClusterFeatureProperties = {
        clusterSize: number;
        isCluster: true;
        zoom: number;
        [name: string]: any;
    }

    Indexable

    • [name: string]: any

      Additional custom properties of the cluster feature.

    Index
    clusterSize isCluster zoom
    clusterSize: number

    The size of the cluster, i.e., the number of features it contains.

    isCluster: true

    Indicates if the feature is a cluster.

    zoom: number

    The zoom level at which the cluster was formed.

    Settings
    Member Visibility

    On This Page
    Properties