How to display a minimap or overview map control to aid the map navigation

This tutorial shows how to display a minimap or overview map control in MapTiler SDK JS to aid the map navigation.

  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. See what’s available here.

  4. Install the npm package.

  5. Include the CSS file.

    If you have a bundler that can handle CSS, you can import the CSS or include it with a <link> in the head of the document via the CDN

  6. Include the following code in your JavaScript file (Example: app.js).

  7. Create the minimapControl. Create a file called minimap-control.js next to your .html file. Copy the following code, paste it into the minimap-control.js file. This code is an adaptation of the mapboxgl-minimap to work with MapTiler SDK JS.

  8. Include the minimap-control.js JavaScript file in the <head> of your HTML file.

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

  10. Add the minimapControl to the map.

  11. Change the minimapcontrol’s css style. Add the minimapcontrol style to your stylesheet.

Learn more

By default the control uses the same style as the map but we can use a different style on the minimapControl. Example of the control using the Satellite Hybrid Map and changing the size of the map.

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

An extension of MapLibre GL JS