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

Removing Overlays

This example creates a ground overlay on top of a map, and adds a UI control allowing users to remove the ground overlay from the map.

Read the documentation.

TypeScript

// This example adds a UI control allowing users to remove the
// ground overlay from the map.

let historicalOverlay: google.maps.GroundOverlay;
let map: google.maps.Map;

function initMap(): void {
  map = new google.maps.Map(document.getElementById("map") as HTMLElement, {
    zoom: 13,
    center: { lat: 40.74, lng: -74.18 }
  });

  const imageBounds = {
    north: 40.773941,
    south: 40.712216,
    east: -74.12544,
    west: -74.22655
  };

  historicalOverlay = new google.maps.GroundOverlay(
    "https://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg",
    imageBounds
  );

  addOverlay();
}

function addOverlay() {
  historicalOverlay.setMap(map);
}

function removeOverlay() {
  historicalOverlay.setMap(null);
}

JavaScript

// This example adds a UI control allowing users to remove the
// ground overlay from the map.
let historicalOverlay;
let map;

function initMap() {
  map = new google.maps.Map(document.getElementById("map"), {
    zoom: 13,
    center: { lat: 40.74, lng: -74.18 }
  });
  const imageBounds = {
    north: 40.773941,
    south: 40.712216,
    east: -74.12544,
    west: -74.22655
  };
  historicalOverlay = new google.maps.GroundOverlay(
    "https://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg",
    imageBounds
  );
  addOverlay();
}

function addOverlay() {
  historicalOverlay.setMap(map);
}

function removeOverlay() {
  historicalOverlay.setMap(null);
}

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;
}

#floating-panel {
  position: absolute;
  top: 10px;
  left: 25%;
  z-index: 5;
  background-color: #fff;
  padding: 5px;
  border: 1px solid #999;
  text-align: center;
  font-family: "Roboto", "sans-serif";
  line-height: 30px;
  padding-left: 10px;
}

HTML

<!DOCTYPE html>
<html>
  <head>
    <title>Removing Overlays</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="floating-panel">
      <input onclick="removeOverlay();" type="button" value="Remove overlay" />
      <input onclick="addOverlay();" type="button" value="Restore overlay" />
    </div>
    <div id="map"></div>
  </body>
</html>

All

<!DOCTYPE html>
<html>
  <head>
    <title>Removing Overlays</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;
      }

      #floating-panel {
        position: absolute;
        top: 10px;
        left: 25%;
        z-index: 5;
        background-color: #fff;
        padding: 5px;
        border: 1px solid #999;
        text-align: center;
        font-family: "Roboto", "sans-serif";
        line-height: 30px;
        padding-left: 10px;
      }
    </style>
    <script>
      "use strict";

      // This example adds a UI control allowing users to remove the
      // ground overlay from the map.
      let historicalOverlay;
      let map;

      function initMap() {
        map = new google.maps.Map(document.getElementById("map"), {
          zoom: 13,
          center: {
            lat: 40.74,
            lng: -74.18
          }
        });
        const imageBounds = {
          north: 40.773941,
          south: 40.712216,
          east: -74.12544,
          west: -74.22655
        };
        historicalOverlay = new google.maps.GroundOverlay(
          "https://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg",
          imageBounds
        );
        addOverlay();
      }

      function addOverlay() {
        historicalOverlay.setMap(map);
      }

      function removeOverlay() {
        historicalOverlay.setMap(null);
      }
    </script>
  </head>
  <body>
    <div id="floating-panel">
      <input onclick="removeOverlay();" type="button" value="Remove overlay" />
      <input onclick="addOverlay();" type="button" value="Restore overlay" />
    </div>
    <div id="map"></div>
  </body>
</html>
"use strict"; // This example adds a UI control allowing users to remove the // ground overlay from the map. let historicalOverlay; let map; function initMap() { map = new google.maps.Map(document.getElementById("map"), { zoom: 13, center: { lat: 40.74, lng: -74.18 } }); const imageBounds = { north: 40.773941, south: 40.712216, east: -74.12544, west: -74.22655 }; historicalOverlay = new google.maps.GroundOverlay( "https://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg", imageBounds ); addOverlay(); } function addOverlay() { historicalOverlay.setMap(map); } function removeOverlay() { historicalOverlay.setMap(null); }
/* 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; } #floating-panel { position: absolute; top: 10px; left: 25%; z-index: 5; background-color: #fff; padding: 5px; border: 1px solid #999; text-align: center; font-family: "Roboto", "sans-serif"; line-height: 30px; padding-left: 10px; }
<!DOCTYPE html> <html> <head> <title>Removing Overlays</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="floating-panel"> <input onclick="removeOverlay();" type="button" value="Remove overlay" /> <input onclick="addOverlay();" type="button" value="Restore overlay" /> </div> <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 overlay-remove 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