Interface ClusterRendererDescriptorExperimental

Serializable cluster descriptor.

interface ClusterRendererDescriptor {
    countField?: string;
    kind: "cluster";
    maxZoom?: number;
    radius?: number;
    steps: readonly ClusterStep[];
    unclusteredColor?: string;
    unclusteredRadius?: number;
}

Hierarchy (view full)

Properties

countField? kind maxZoom? radius? steps unclusteredColor? unclusteredRadius?

Properties

Optional Readonly ExperimentalcountField

countField?: string

Numeric property summed per cluster instead of the raw point count. Adds a <countField>_sum cluster property and drives the step/count expressions from it.

Readonly Experimentalkind

kind

Optional Readonly ExperimentalmaxZoom

maxZoom?: number

Max zoom to cluster at (GeoJSON source clusterMaxZoom).

Default

14

Optional Readonly Experimentalradius

radius?: number

Cluster radius in pixels (GeoJSON source clusterRadius).

Default

50

Readonly Experimentalsteps

steps: readonly ClusterStep[]

Ascending count classes driving cluster color/size.

Optional Readonly ExperimentalunclusteredColor

unclusteredColor?: string

Style for unclustered points.

Default

"#16735b"

Optional Readonly ExperimentalunclusteredRadius

unclusteredRadius?: number

Default

5

Settings

Member Visibility

On This Page

Properties