Create deck.gl layer using REST API

This example shows how to create a deck.gl layer as an overlay from a REST API using MapTiler SDK JS.


npm install --save @maptiler/sdk deck.gl

main.js

import { Map, MapStyle, config } from '@maptiler/sdk';
import '@maptiler/sdk/dist/maptiler-sdk.css';
import { ScatterplotLayer, MapboxOverlay } from 'deck.gl';

config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
const map = new Map({
  container: 'map',
  style: MapStyle.DATAVIZ.LIGHT,
  center: [2.345885, 48.860412],
  zoom: 12,
});

// 20 + 1 random colors for all the districts of Paris and outside of the districts
const colorPalette = [
  [255, 102, 51],
  [255, 179, 153],
  [255, 51, 255],
  [255, 255, 153],
  [0, 179, 230],
  [230, 179, 51],
  [51, 102, 230],
  [153, 153, 102],
  [153, 255, 153],
  [179, 77, 77],
  [128, 179, 0],
  [128, 153, 0],
  [230, 179, 179],
  [102, 128, 179],
  [102, 153, 26],
  [255, 153, 230],
  [204, 255, 26],
  [255, 26, 102],
  [230, 51, 26],
  [51, 255, 204],
  [102, 153, 77],
];

const limit = 100;
// Sample data source = https://data.iledefrance.fr
const parisSights = `https://data.iledefrance.fr/api/explore/v2.1/catalog/datasets/principaux-sites-touristiques-en-ile-de-france0/records?limit=${limit}`;

let layerControl;

// Add the overlay as a control
map.on('load', async () => {
  // Fetch the data
  const response = await fetch(parisSights);
  const responseJSON = await response.json();

  const layer = new ScatterplotLayer({
    id: 'scatterplot-layer',
    data: responseJSON.results,
    pickable: true,
    autoHighlight: true,
    opacity: 0.7,
    stroked: true,
    filled: true,
    radiusMinPixels: 14,
    radiusMaxPixels: 100,
    lineWidthMinPixels: 5,
    // Using appropriate fields for coordinates from the dataset
    getPosition: (d) => [d.geo_point_2d.lon, d.geo_point_2d.lat],
    getFillColor: (d) => {
      // Filtering by postal code
      if ('insee' in d && d.insee.startsWith('75')) {
        // Districts in Paris
        return colorPalette[parseInt(d.insee.substring(3))];
      } else {
        // Out of Paris
        return colorPalette[20];
      }
    },
    getLineColor: (d) => [14, 16, 255],
    onClick: (info) => {
      const { coordinate, object } = info;
      const description = `<p>${object.nom_carto || 'Unknown'}</p>`;

      new maptilersdk.Popup()
        .setLngLat(coordinate)
        .setHTML(description)
        .addTo(map);
    },
  });

  // Create the overlay
  const overlay = new MapboxOverlay({
    layers: [layer],
  });
  map.addControl(overlay);
});

index.html

<!doctype html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <meta name="robots" content="noindex" />
  <title>Create deck.gl layer using REST API | NPM example</title>
  <link rel="stylesheet" href="./style.css" />
</head>

<body>
  <div id="map"></div>
  <script type="module" src="./main.js"></script>
</body>

</html>

style.css

body {
  margin: 0;
  padding: 0;
}

#map {
  position: absolute;
  top: 0;
  bottom: 0;
  width: 100%;
}

/* Deck.gl layer is added as an overlay, popup needs to be displayed over it */
.maplibregl-popup {
  z-index: 2;
}

<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Create deck.gl layer using REST API</title>
  <script src="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.umd.min.js"></script>
  <link href="https://cdn.maptiler.com/maptiler-sdk-js/v4.1.0/maptiler-sdk.css" rel="stylesheet" />
  <script src="https://unpkg.com/deck.gl@9.2.5/dist.min.js"></script>
  <style>
    body {
      margin: 0;
      padding: 0;
    }

    #map {
      position: absolute;
      top: 0;
      bottom: 0;
      width: 100%;
    }

    /* Deck.gl layer is added as an overlay, popup needs to be displayed over it */
    .maplibregl-popup {
      z-index: 2;
    }
  </style>
</head>

<body>
  <div id="map"></div>

  <script>
    maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
    const map = new maptilersdk.Map({
      container: 'map',
      style: maptilersdk.MapStyle.DATAVIZ.LIGHT,
      center: [2.345885, 48.860412],
      zoom: 12,
    });

    // 20 + 1 random colors for all the districts of Paris and outside of the districts
    const colorPalette = [
      [255, 102, 51],
      [255, 179, 153],
      [255, 51, 255],
      [255, 255, 153],
      [0, 179, 230],
      [230, 179, 51],
      [51, 102, 230],
      [153, 153, 102],
      [153, 255, 153],
      [179, 77, 77],
      [128, 179, 0],
      [128, 153, 0],
      [230, 179, 179],
      [102, 128, 179],
      [102, 153, 26],
      [255, 153, 230],
      [204, 255, 26],
      [255, 26, 102],
      [230, 51, 26],
      [51, 255, 204],
      [102, 153, 77],
    ];

    const limit = 100;
    // Sample data source = https://data.iledefrance.fr
    const parisSights = `https://data.iledefrance.fr/api/explore/v2.1/catalog/datasets/principaux-sites-touristiques-en-ile-de-france0/records?limit=${limit}`;

    let layerControl;

    // Add the overlay as a control
    map.on('load', async () => {
      // Fetch the data
      const response = await fetch(parisSights);
      const responseJSON = await response.json();

      const layer = new deck.ScatterplotLayer({
        id: 'scatterplot-layer',
        data: responseJSON.results,
        pickable: true,
        autoHighlight: true,
        opacity: 0.7,
        stroked: true,
        filled: true,
        radiusMinPixels: 14,
        radiusMaxPixels: 100,
        lineWidthMinPixels: 5,
        // Using appropriate fields for coordinates from the dataset
        getPosition: (d) => [d.geo_point_2d.lon, d.geo_point_2d.lat],
        getFillColor: (d) => {
          // Filtering by postal code
          if ('insee' in d && d.insee.startsWith('75')) {
            // Districts in Paris
            return colorPalette[parseInt(d.insee.substring(3))];
          } else {
            // Out of Paris
            return colorPalette[20];
          }
        },
        getLineColor: (d) => [14, 16, 255],
        onClick: (info) => {
          const { coordinate, object } = info;
          const description = `<p>${object.nom_carto || 'Unknown'}</p>`;

          new maptilersdk.Popup()
            .setLngLat(coordinate)
            .setHTML(description)
            .addTo(map);
        },
      });

      // Create the overlay
      const overlay = new deck.MapboxOverlay({
        layers: [layer],
      });
      map.addControl(overlay);
    });
  </script>
</body>

</html>