GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface ClusterConfig

    The full modules.cluster config block.

    interface ClusterConfig {
        enabled: boolean;
        clustering?: boolean;
        clusterRadius?: number;
        disableClusteringAtZoom?: number;
        clusterStrategy?: string;
        clusterStrategies?: Record<string, ClusterStrategyEntry>;
    }
    Index

    Properties

    enabled clustering? clusterRadius? disableClusteringAtZoom? clusterStrategy? clusterStrategies?

    Properties

    enabled: boolean

    Capability gate — clustering is inert when false. Opt-out (enableWhenAbsent: true): absent → active, preserving the pre-migration default-on behaviour.

    clustering?: boolean

    Global cluster default for GeoJSON point layers (was poiConfig.clustering).

    false — a per-layer clustering:{enabled:true} override still clusters regardless (roadmap nettoyage Sprint 3, PA-3 — this doc previously said true, which never matched the runtime default).

    clusterRadius?: number

    Default cluster radius (px) for GeoJSON point layers; a per-layer clusterRadius overrides it (was poiConfig.clusterRadius). Falls back to DEFAULT_CLUSTER_RADIUS (see constants.ts).

    80
    disableClusteringAtZoom?: number

    Default zoom at/above which GeoJSON point clustering stops (clusterMaxZoom); a per-layer disableClusteringAtZoom overrides it (was poiConfig.disableClusteringAtZoom). Falls back to DEFAULT_CLUSTER_MAX_ZOOM.

    14
    clusterStrategy?: string

    GeoJSON clustering strategy (was poiConfig.clusterStrategy).

    "unified"
    clusterStrategies?: Record<string, ClusterStrategyEntry>

    Per-strategy config (was poiConfig.clusterStrategies).

    Settings

    Member Visibility

    On This Page

    Properties