This sample demonstrates how to enable clustering on a GeoJSONLayer. Clustering is a method of reducing features in a FeatureLayer, CSVLayer, GeoJSONLayer, WFSLayer, or OGCFeatureLayer by grouping them based on their spatial proximity to one another. Typically, clusters are proportionally sized based on the number of features within each cluster.

Clustering is configured in the featureReduction property of the layer. You can enable clustering with a default configuration with minimal code by setting the type to cluster.

layer.featureReduction = {
  type: "cluster",
};

The feature reduction property gives you control over many other cluster properties. The clusterRadius defines area of influence that determines each cluster’s region for including features. You may also define popupTemplates and labels for clusters that summarize the features comprised by the cluster.

1
      const clusterConfig = {
2
        type: "cluster",
3
        clusterRadius: "100px",
4
        // {cluster_count} is an aggregate field containing
5
        // the number of features comprised by the cluster
6
        popupTemplate: {
7
          title: "Cluster summary",
8
          content: "This cluster represents {cluster_count} earthquakes.",
9
          fieldInfos: [
10
            {
11
              fieldName: "cluster_count",
12
              format: {
13
                places: 0,
14
                digitSeparator: true,
15
              },
16
            },
17
          ],
18
        },
19
        clusterMinSize: "24px",
20
        clusterMaxSize: "60px",
21
        labelingInfo: [
22
          {
23
            deconflictionStrategy: "none",
24
            labelExpressionInfo: {
25
              expression: "Text($feature.cluster_count, '#,###')",
26
            },
27
            symbol: {
28
              type: "text",
29
              color: "#004a5d",
30
              font: {
31
                weight: "bold",
32
                family: "Noto Sans",
33
                size: "12px",
34
              },
35
            },
36
            labelPlacement: "center-center",
37
          },
38
        ],
39
      };

Suggestions for basic configuration

• Turn off label deconfliction when labeling clusters with a count in the center of the cluster. If label placement is outside the cluster, keep label deconfliction enabled.
• Increase the clusterMinSize to fit labels inside smaller clusters (16pt is a good starting point).
• For larger layers, format the cluster count in the label with either a rounded value or a meaningful abbreviated value (e.g. 10k instead of 10000). See the Clustering - generate suggested configuration for an example of this.

Clustering can only be configured in a MapView.

Related samples and resources