It's the 15th anniversary of Google Maps Platform - Check out the latest news and announcements

Overlaying an Image Map Type

This example uses image tiles to overlay an image that represents the interior of a building onto the map.

Read the documentation.

TypeScript

function initMap(): void {
  const map = new google.maps.Map(
    document.getElementById("map") as HTMLElement,
    {
      zoom: 18,
      center: { lat: 37.783, lng: -122.403 }
    }
  );

  const bounds: Record<number, [[number, number], [number, number]]> = {
    17: [
      [20969, 20970],
      [50657, 50658]
    ],
    18: [
      [41939, 41940],
      [101315, 101317]
    ],
    19: [
      [83878, 83881],
      [202631, 202634]
    ],
    20: [
      [167757, 167763],
      [405263, 405269]
    ]
  };

  const imageMapType = new google.maps.ImageMapType({
    getTileUrl: function(coord, zoom) {
      if (
        zoom < 17 ||
        zoom > 20 ||
        bounds[zoom][0][0] > coord.x ||
        coord.x > bounds[zoom][0][1] ||
        bounds[zoom][1][0] > coord.y ||
        coord.y > bounds[zoom][1][1]
      ) {
        return "";
      }

      return [
        "https://www.gstatic.com/io2010maps/tiles/5/L2_",
        zoom,
        "_",
        coord.x,
        "_",
        coord.y,
        ".png"
      ].join("");
    },
    tileSize: new google.maps.Size(256, 256)
  });

  map.overlayMapTypes.push(imageMapType);
}
index.ts

JavaScript

function initMap() {
  const map = new google.maps.Map(document.getElementById("map"), {
    zoom: 18,
    center: { lat: 37.783, lng: -122.403 }
  });
  const bounds = {
    17: [
      [20969, 20970],
      [50657, 50658]
    ],
    18: [
      [41939, 41940],
      [101315, 101317]
    ],
    19: [
      [83878, 83881],
      [202631, 202634]
    ],
    20: [
      [167757, 167763],
      [405263, 405269]
    ]
  };
  const imageMapType = new google.maps.ImageMapType({
    getTileUrl: function(coord, zoom) {
      if (
        zoom < 17 ||
        zoom > 20 ||
        bounds[zoom][0][0] > coord.x ||
        coord.x > bounds[zoom][0][1] ||
        bounds[zoom][1][0] > coord.y ||
        coord.y > bounds[zoom][1][1]
      ) {
        return "";
      }
      return [
        "https://www.gstatic.com/io2010maps/tiles/5/L2_",
        zoom,
        "_",
        coord.x,
        "_",
        coord.y,
        ".png"
      ].join("");
    },
    tileSize: new google.maps.Size(256, 256)
  });
  map.overlayMapTypes.push(imageMapType);
}

index.js

CSS

/* Always set the map height explicitly to define the size of the div
       * element that contains the map. */
#map {
  height: 100%;
}

/* Optional: Makes the sample page fill the window. */
html,
body {
  height: 100%;
  margin: 0;
  padding: 0;
}

style.css

HTML

<!DOCTYPE html>
<html>
  <head>
    <title>Overlaying an Image Map Type</title>
    <script src="https://polyfill.io/v3/polyfill.min.js?features=default"></script>
    <script
      src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=&v=weekly"
      defer
    ></script>
    <link rel="stylesheet" type="text/css" href="./style.css" />
    <script src="./app.js"></script>
  </head>
  <body>
    <div id="map"></div>
  </body>
</html>
sample.html

All

<!DOCTYPE html>
<html>
  <head>
    <title>Overlaying an Image Map Type</title>
    <script src="https://polyfill.io/v3/polyfill.min.js?features=default"></script>
    <script
      src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=&v=weekly"
      defer
    ></script>
    <style type="text/css">
      /* Always set the map height explicitly to define the size of the div
       * element that contains the map. */
      #map {
        height: 100%;
      }

      /* Optional: Makes the sample page fill the window. */
      html,
      body {
        height: 100%;
        margin: 0;
        padding: 0;
      }
    </style>
    <script>
      "use strict";

      function initMap() {
        const map = new google.maps.Map(document.getElementById("map"), {
          zoom: 18,
          center: {
            lat: 37.783,
            lng: -122.403
          }
        });
        const bounds = {
          17: [
            [20969, 20970],
            [50657, 50658]
          ],
          18: [
            [41939, 41940],
            [101315, 101317]
          ],
          19: [
            [83878, 83881],
            [202631, 202634]
          ],
          20: [
            [167757, 167763],
            [405263, 405269]
          ]
        };
        const imageMapType = new google.maps.ImageMapType({
          getTileUrl: function(coord, zoom) {
            if (
              zoom < 17 ||
              zoom > 20 ||
              bounds[zoom][0][0] > coord.x ||
              coord.x > bounds[zoom][0][1] ||
              bounds[zoom][1][0] > coord.y ||
              coord.y > bounds[zoom][1][1]
            ) {
              return "";
            }

            return [
              "https://www.gstatic.com/io2010maps/tiles/5/L2_",
              zoom,
              "_",
              coord.x,
              "_",
              coord.y,
              ".png"
            ].join("");
          },
          tileSize: new google.maps.Size(256, 256)
        });
        map.overlayMapTypes.push(imageMapType);
      }
    </script>
  </head>
  <body>
    <div id="map"></div>
  </body>
</html>

inline.html
"use strict"; function initMap() { const map = new google.maps.Map(document.getElementById("map"), { zoom: 18, center: { lat: 37.783, lng: -122.403 } }); const bounds = { 17: [ [20969, 20970], [50657, 50658] ], 18: [ [41939, 41940], [101315, 101317] ], 19: [ [83878, 83881], [202631, 202634] ], 20: [ [167757, 167763], [405263, 405269] ] }; const imageMapType = new google.maps.ImageMapType({ getTileUrl: function(coord, zoom) { if ( zoom < 17 || zoom > 20 || bounds[zoom][0][0] > coord.x || coord.x > bounds[zoom][0][1] || bounds[zoom][1][0] > coord.y || coord.y > bounds[zoom][1][1] ) { return ""; } return [ "https://www.gstatic.com/io2010maps/tiles/5/L2_", zoom, "_", coord.x, "_", coord.y, ".png" ].join(""); }, tileSize: new google.maps.Size(256, 256) }); map.overlayMapTypes.push(imageMapType); }
/* Always set the map height explicitly to define the size of the div * element that contains the map. */ #map { height: 100%; } /* Optional: Makes the sample page fill the window. */ html, body { height: 100%; margin: 0; padding: 0; }
<!DOCTYPE html> <html> <head> <title>Overlaying an Image Map Type</title> <script src="https://polyfill.io/v3/polyfill.min.js?features=default"></script> <script src="https://maps.googleapis.com/maps/api/js?key=AIzaSyBIwzALxUPNbatRBj3Xi1Uhp0fFzwWNBkE&callback=initMap&libraries=&v=weekly" defer ></script> <!-- jsFiddle will insert css and js --> </head> <body> <div id="map"></div> </body> </html>

Create a starter application from sample

A skeleton starter application using TypeScript, Webpack, and Babel can be generated from this sample using one of the methods below.

Run Locally

Node.js is required to run this sample locally. Follow these instructions to install Node.js and NPM. 

npm i -g '@googlemaps/js-samples'
googlemaps-js-samples init maptype-image-overlay DESTINATION_FOLDER

Run in Google Cloud Shell

Google Cloud Shell is an interactive shell environment for Google Cloud Platform that makes it easy for you to learn and experiment with GCP and manage your projects and resources from your web browser.

Run in Cloud Shell