How to download a map screenshot as a PNG file (screenshot helper)

This example shows how to download the current map view as a PNG file. The screenshot helper is the most convenient way to save map snapshots.

Getting a file directly is a nice option that can be useful to share some debugging context with colleagues, compare multiple styles, or share your creation on social media.

^{Click on the Take screenshot button to download a image for the current map view}


npm install --save @maptiler/sdk

main.js

import { Map, MapStyle, config, helpers } from '@maptiler/sdk';
import '@maptiler/sdk/dist/maptiler-sdk.css';

config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
const map = new Map({
    container: 'map',
    zoom: 11,
    center: [0.66016, 42.62845],
    style: MapStyle.OUTDOOR
});

map.on('ready', () => {
  document.getElementById('screenshot').addEventListener('click', function () {
    helpers.takeScreenshot(map, {
      download: true,
      filename: "maptiler_map_screenshot.png"
    });
  });
});

index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="robots" content="noindex">
  <title>How to download a map screenshot as a PNG file (screenshot helper) | NPM example</title>
  <link rel="stylesheet" href="./style.css">
</head>
<body>
  <div id="map"></div>
  <button id="screenshot">Download screenshot</button>
  <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%;}
#screenshot {
  display: block;
  position: relative;
  margin: 0px auto;
  width: 50%;
  height: 40px;
  padding: 10px;
  border: none;
  border-radius: 3px;
  font-size: 12px;
  text-align: center;
  color: #fff;
  background:#ee8a65;
  cursor: pointer;
}

<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>Point helper</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" />
<style>
  body {margin: 0; padding: 0;}
  #map {position: absolute; top: 0; bottom: 0; width: 100%;}
  #screenshot {
    display: block;
    position: relative;
    margin: 0px auto;
    width: 50%;
    height: 40px;
    padding: 10px;
    border: none;
    border-radius: 3px;
    font-size: 12px;
    text-align: center;
    color: #fff;
    background:#ee8a65;
    cursor: pointer;
  }
</style>
</head>
<body>
<div id="map"></div>
<button id="screenshot">Download screenshot</button>

<script>
  maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE';
  const map = new maptilersdk.Map({
      container: 'map',
      zoom: 11,
      center: [0.66016, 42.62845],
      style: maptilersdk.MapStyle.OUTDOOR
  });

  map.on('ready', () => {
    document.getElementById('screenshot').addEventListener('click', function () {
      maptilersdk.helpers.takeScreenshot(map, {
        download: true,
        filename: "maptiler_map_screenshot.png"
      });
    });
  });
</script>
</body>
</html>