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.
-
Copy the following code, paste it into your favorite text editor, and save it as a
.html
file. -
Replace
YOUR_MAPTILER_API_KEY_HERE
with your actual MapTiler API key. -
The next it’s up to you. You can start the map in a different place by modifying the
starting position
andstarting zoom
, and you can change the look of the map to any of our styles, or yours, by updating thestyle
. See what’s available here. -
Install the npm package.
-
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 -
Include the following code in your JavaScript file (Example: app.js).
-
Create the
minimapControl
. Create a file calledminimap-control.js
next to your.html
file. Copy the following code, paste it into theminimap-control.js
file. This code is an adaptation of the mapboxgl-minimap to work with MapTiler SDK JS. -
Include the
minimap-control.js
JavaScript file in the<head>
of your HTML file. -
Add event handler for map
load
event. You will add code to create a vector source and a vector layer in this handler. -
Add the
minimapControl
to the map. -
Change the minimapcontrol’s css style. Add the minimapcontrol style to your stylesheet.
View complete source code on GitHub
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.