H3 Cluster Layer

This example shows how to use the H3ClusterLayer to render regions represented by hexagon sets from the H3 geospatial indexing system.

 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
<html>
  <head>
    <!-- FONT -->
    <link
      href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600&display=swap"
      rel="stylesheet"
    />
    <!-- h3-js is required -->
    <script src="https://unpkg.com/h3-js"></script>
    <script src="https://unpkg.com/deck.gl@^8.4.0/dist.min.js"></script>
    <script src="https://unpkg.com/@deck.gl/carto@^8.4.0/dist.min.js"></script>
    
    <script src="https://libs.cartocdn.com/mapbox-gl/v1.13.0/mapbox-gl.js"></script>
    <link href="https://libs.cartocdn.com/mapbox-gl/v1.13.0/mapbox-gl.css" rel="stylesheet" />
  </head>

  <body style="margin: 0; padding: 0; overflow: hidden; font-family: 'Open Sans', sans-serif">
    <div id="map" style="width: 100vw; height: 100vh"></div>
  </body>

  <script type="text/javascript">
    async function initialize() {
      deck.carto.setDefaultCredentials({
        username: 'public',
        apiKey: 'default_public',
      });

      // Fetch Data from CARTO
      const url = 'https://public.carto.com/api/v2/sql?q=SELECT mean, count, hexids FROM sf_h3_clusters&format=json';
      const jsonData = await fetch(url).then(response => response.json());

      // Create Deck.GL map
      const deckgl = new deck.DeckGL({
        container: 'map',
        mapStyle: 'https://basemaps.cartocdn.com/gl/dark-matter-gl-style/style.json',
        initialViewState: {
          longitude: -122.43,
          latitude: 37.76,
          zoom: 10.5
        },
        controller: true,
        layers: [
          new deck.H3ClusterLayer({
            id: 'h3-cluster-layer',
            data: jsonData.rows,
            pickable: true,
            stroked: true,
            filled: true,
            extruded: false,  
            getHexagons: d => d.hexids,
            getFillColor: d => [255, (1 - d.mean / 500) * 255, 0],
            getLineColor: [255, 255, 255, 120],
            lineWidthMinPixels: 2
          })
        ],
        getTooltip: ({object}) => object && `density: ${object.mean}`
      });
    }

    initialize();    
  </script>
</html>