How to display a map legend control to toggle layers visualization

This tutorial shows how to display a map legend control to toggle layers visualization.

  1. Copy the following code, paste it into your favorite text editor, and save it as a .html file.

  2. Replace YOUR_MAPTILER_API_KEY_HERE with your actual MapTiler API key.

  3. The next it’s up to you. You can start the map in a different place by modifying the starting position and starting zoom, and you can change the look of the map to any of our styles, or yours, by updating the style URL. See what’s available here.</li>

  4. Install the npm package.

  5. Include the CSS file in the <head> of your HTML file.

    Including it with a <link> in the head of the document via the CDN is the simplest and easiest way to provide the CSS, but it is also bundled in the MapLibre module, meaning that if you have a bundler that can handle CSS, you can import the CSS from maplibre-gl/dist/maplibre-gl.css.
  6. Include the following code in your JavaScript file (Example: app.js).

  7. Include the maplibre-gl-legend JavaScript and CSS files in the <head> of your HTML file. To create the legend we will use the maplibre-gl-legend plugin.

  8. Add event handler for map load event. You will add code to create a vector source and a vector layer in this handler.

  9. Create the list of layers that we want to show in the legend. For each layer we must create a key:value pair where the key is the ID of the layer in the map style and the value is text that is displayed in the legend.

  10. Add the maplibre-gl-legend control to the map.

Learn more

Check out the MapTiler Planet schema to know how it is organized into different thematic layers and which attribute and values each layer contains.

Visit the JavaScript Maps API reference to learn how to create your custom control.

JavaScript Maps API

Examples