Display clusters

View inMAUIWPFWinUIView on GitHub

Display a web map with a point feature layer that has feature reduction enabled to aggregate points into clusters.

displayclusters

Use case

Feature clustering can be used to dynamically aggregate groups of points that are within proximity of each other in order to represent each group with a single symbol. Such grouping allows you to see patterns in the data that are difficult to visualize when a layer contains hundreds or thousands of points that overlap and cover each other.

How to use the sample

Pan and zoom the map to view how clustering is dynamically updated. Toggle clustering off to view the original point features that make up the clustered elements. When clustering is on, you can tap on a clustered geoelement to view aggregated information and summary statistics for that cluster. When clustering is toggled off and you tap on the original feature you get access to information about individual power plant features.

How it works

  1. Create a map from a web map PortalItem.
  2. Get the cluster enabled layer from the map's operational layers.
  3. Get the FeatureReduction from the feature layer and set the IsEnabled bool to enable or disable clustering on the feature layer.
  4. When the user clicks on the map, call IdentifyFeatureLayerAsync(), passing in the layer, map tap location, tolerance, and returnPopupsOnly as true.
  5. Set the Popup from the resulting IdentifyLayerResult to the PopupViewer.Popup.
  6. Make the PopupViewer visible.

Relevant API

  • AggregateGeoElement
  • FeatureLayer
  • FeatureReduction
  • GeoElement
  • IdentifyLayerResult

About the data

This sample uses a web map that displays the Esri Global Power Plants feature layer with feature reduction enabled. When enabled, the aggregate features symbology shows the color of the most common power plant type, and a size relative to the average plant capacity of the cluster.

Additional information

Graphics in a graphics overlay can also be aggregated into clusters. To do this, set the FeatureReduction property on the GraphicsOverlay to a new ClusteringFeatureReduction.

Tags

aggregate, bin, cluster, group, merge, normalize, reduce, summarize

Sample Code

DisplayClusters.xaml.csDisplayClusters.xaml.csDisplayClusters.xaml
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
// Copyright 2023 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
// You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
// language governing permissions and limitations under the License.

using Esri.ArcGISRuntime.Data;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Mapping.Popups;
using Esri.ArcGISRuntime.Portal;
using Esri.ArcGISRuntime.Reduction;

namespace ArcGIS.Samples.DisplayClusters
{
    [ArcGIS.Samples.Shared.Attributes.Sample(
        name: "Display clusters",
        category: "Layers",
        description: "Display a web map with a point feature layer that has feature reduction enabled to aggregate points into clusters.",
        instructions: "Pan and zoom the map to view how clustering is dynamically updated. Toggle clustering off to view the original point features that make up the clustered elements. When clustering is on, you can tap on a clustered geoelement to view aggregated information and summary statistics for that cluster. When clustering is toggled off and you tap on the original feature you get access to information about individual power plant features.",
        tags: new[] { "aggregate", "bin", "cluster", "group", "merge", "normalize", "reduce", "summarize" })]
    [ArcGIS.Samples.Shared.Attributes.OfflineData()]
    public partial class DisplayClusters
    {
        // Hold a reference to the feature layer.
        private FeatureLayer _layer;

        public DisplayClusters()
        {
            InitializeComponent();
            _ = Initialize();
        }

        private async Task Initialize()
        {
            // Get the power plants web map from the default portal.
            var portal = await ArcGISPortal.CreateAsync();
            PortalItem portalItem = await PortalItem.CreateAsync(portal, "8916d50c44c746c1aafae001552bad23");

            // Create a new map from the web map.
            MyMapView.Map = new Map(portalItem);

            // Get the power plant feature layer once the map has finished loading.
            await MyMapView.Map.LoadAsync();
            _layer = (FeatureLayer)MyMapView.Map.OperationalLayers.First();

            // Hide and nullify an opened popup when user taps screen.
            PopupBackground.GestureRecognizers.Add(new TapGestureRecognizer
            {
                Command = new Command(() =>
                {
                    PopupBackground.IsVisible = false;
                    PopupViewer.Popup = null;
                    GeoElementsGrid.ItemsSource = null;
                    GeoElementsPanel.IsVisible = false;
                })
            });

        }

        private async void MyMapView_GeoViewTapped(object sender, Esri.ArcGISRuntime.Maui.GeoViewInputEventArgs e)
        {
            // Clear any previously selected features or clusters.
            _layer.ClearSelection();

            // Identify the tapped observation.
            var results = await MyMapView.IdentifyLayerAsync(_layer, e.Position, 3, false);

            // Return if no popups are found.
            if (results.GeoElements.Count == 0 || results.Popups.Count == 0) return;

            if (results.Popups.FirstOrDefault() is Popup popup)
            {
                // Set the popup and make it visible.
                PopupViewer.Popup = popup;
                PopupBackground.IsVisible = true;
            }

            // If the tapped observation is an AggregateGeoElement then select it.
            if (results.GeoElements.FirstOrDefault() is AggregateGeoElement aggregateGeoElement)
            {
                // Select the AggregateGeoElement.
                aggregateGeoElement.IsSelected = true;

                // Get the contained GeoElements.
                IReadOnlyList<GeoElement> geoElements = await aggregateGeoElement.GetGeoElementsAsync();

                // Set the geoelements as an items source and set the visibility.
                GeoElementsGrid.ItemsSource = geoElements;
                GeoElementsPanel.IsVisible = true;
            }
            else if (results.GeoElements.FirstOrDefault() is ArcGISFeature feature)
            {
                // If the tapped observation is not an AggregateGeoElement select the feature.
                _layer.SelectFeature(feature);
            }
        }

        // Enable clustering feature reduction if the checkbox has been checked, disable otherwise.
        private void CheckBox_CheckChanged(object sender, CheckedChangedEventArgs e)
        {
            // This event is raised when sample is initially loaded when layer is null.
            if (_layer == null) return;

            _layer.FeatureReduction.IsEnabled = (sender as CheckBox).IsChecked;
        }
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.