// This example adds a UI control allowing users to remove the// ground overlay from the map.lethistoricalOverlay:google.maps.GroundOverlay;letmap:google.maps.Map;functioninitMap():void{map=newgoogle.maps.Map(document.getElementById("map")asHTMLElement,{zoom:13,center:{lat:40.74,lng:-74.18},});constimageBounds={north:40.773941,south:40.712216,east:-74.12544,west:-74.22655,};historicalOverlay=newgoogle.maps.GroundOverlay("https://storage.googleapis.com/geo-devrel-public-buckets/newark_nj_1922-661x516.jpeg",imageBounds);// add event listener for click eventdocument.getElementById("restore-overlay")!.addEventListener("click",restoreOverlay);document.getElementById("remove-overlay")!.addEventListener("click",removeOverlay);// restore overlay to maprestoreOverlay();}functionrestoreOverlay(){historicalOverlay.setMap(map);}functionremoveOverlay(){historicalOverlay.setMap(null);}declareglobal{interfaceWindow{initMap:()=>void;}}window.initMap=initMap;
// This example adds a UI control allowing users to remove the// ground overlay from the map.lethistoricalOverlay;letmap;functioninitMap(){map=newgoogle.maps.Map(document.getElementById("map"),{zoom:13,center:{lat:40.74,lng:-74.18},});constimageBounds={north:40.773941,south:40.712216,east:-74.12544,west:-74.22655,};historicalOverlay=newgoogle.maps.GroundOverlay("https://storage.googleapis.com/geo-devrel-public-buckets/newark_nj_1922-661x516.jpeg",imageBounds,);// add event listener for click eventdocument.getElementById("restore-overlay").addEventListener("click",restoreOverlay);document.getElementById("remove-overlay").addEventListener("click",removeOverlay);// restore overlay to maprestoreOverlay();}functionrestoreOverlay(){historicalOverlay.setMap(map);}functionremoveOverlay(){historicalOverlay.setMap(null);}window.initMap=initMap;
/** 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:1pxsolid#999;text-align:center;font-family:"Roboto","sans-serif";line-height:30px;padding-left:10px;}
<html>
<head>
<title>Removing Overlays</title>
<link rel="stylesheet" type="text/css" href="./style.css" />
<script type="module" src="./index.js"></script>
</head>
<body>
<div id="floating-panel">
<input id="remove-overlay" type="button" value="Remove overlay" />
<input id="restore-overlay" type="button" value="Restore overlay" />
</div>
<div id="map"></div>
<!--
The `defer` attribute causes the script to execute after the full HTML
document has been parsed. For non-blocking uses, avoiding race conditions,
and consistent behavior across browsers, consider loading using Promises. See
https://developers.google.com/maps/documentation/javascript/load-maps-js-api
for more information.
-->
<script
src="https://maps.googleapis.com/maps/api/js?key=AIzaSyB41DRUbKWJHPxaFjMAwdrzWzbVKartNGg&callback=initMap&v=weekly"
defer
></script>
</body>
</html>
Git and Node.js are required to run this sample locally. Follow theseinstructionsto install Node.js and NPM. The following commands clone, install dependencies and start the sample application.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis example demonstrates how to overlay an image on a map using the Google Maps JavaScript API.\u003c/p\u003e\n"],["\u003cp\u003eIt provides UI controls (buttons) to dynamically remove and restore the image overlay.\u003c/p\u003e\n"],["\u003cp\u003eThe sample code is available in both JavaScript and TypeScript, allowing developers to choose their preferred language.\u003c/p\u003e\n"],["\u003cp\u003eUsers can interact with the sample via JSFiddle or Google Cloud Shell, or clone the repository to run it locally.\u003c/p\u003e\n"]]],[],null,["This example creates a ground overlay on top of a map, and adds a UI control\nallowing users to remove the ground overlay from the map.\n\nRead the [documentation](/maps/documentation/javascript/groundoverlays#remove). \n\nTypeScript \n\n```typescript\n// This example adds a UI control allowing users to remove the\n// ground overlay from the map.\n\nlet historicalOverlay: google.maps.GroundOverlay;\nlet map: google.maps.Map;\n\nfunction initMap(): void {\n map = new google.maps.Map(document.getElementById(\"map\") as HTMLElement, {\n zoom: 13,\n center: { lat: 40.74, lng: -74.18 },\n });\n\n const imageBounds = {\n north: 40.773941,\n south: 40.712216,\n east: -74.12544,\n west: -74.22655,\n };\n\n historicalOverlay = new google.maps.GroundOverlay(\n \"https://storage.googleapis.com/geo-devrel-public-buckets/newark_nj_1922-661x516.jpeg\",\n imageBounds\n );\n\n // add event listener for click event\n document\n .getElementById(\"restore-overlay\")!\n .addEventListener(\"click\", restoreOverlay);\n document\n .getElementById(\"remove-overlay\")!\n .addEventListener(\"click\", removeOverlay);\n\n // restore overlay to map\n restoreOverlay();\n}\n\nfunction restoreOverlay() {\n historicalOverlay.setMap(map);\n}\n\nfunction removeOverlay() {\n historicalOverlay.setMap(null);\n}\n\ndeclare global {\n interface Window {\n initMap: () =\u003e void;\n }\n}\nwindow.initMap = initMap;https://github.com/googlemaps/js-samples/blob/2683f7366fb27829401945d2a7e27d77ed2df8e5/samples/overlay-remove/index.ts#L8-L59\n```\n| **Note:** Read the [guide](/maps/documentation/javascript/using-typescript) on using TypeScript and Google Maps.\n\nJavaScript \n\n```javascript\n// This example adds a UI control allowing users to remove the\n// ground overlay from the map.\nlet historicalOverlay;\nlet map;\n\nfunction initMap() {\n map = new google.maps.Map(document.getElementById(\"map\"), {\n zoom: 13,\n center: { lat: 40.74, lng: -74.18 },\n });\n\n const imageBounds = {\n north: 40.773941,\n south: 40.712216,\n east: -74.12544,\n west: -74.22655,\n };\n\n historicalOverlay = new google.maps.GroundOverlay(\n \"https://storage.googleapis.com/geo-devrel-public-buckets/newark_nj_1922-661x516.jpeg\",\n imageBounds,\n );\n // add event listener for click event\n document\n .getElementById(\"restore-overlay\")\n .addEventListener(\"click\", restoreOverlay);\n document\n .getElementById(\"remove-overlay\")\n .addEventListener(\"click\", removeOverlay);\n // restore overlay to map\n restoreOverlay();\n}\n\nfunction restoreOverlay() {\n historicalOverlay.setMap(map);\n}\n\nfunction removeOverlay() {\n historicalOverlay.setMap(null);\n}\n\nwindow.initMap = initMap;https://github.com/googlemaps/js-samples/blob/2683f7366fb27829401945d2a7e27d77ed2df8e5/dist/samples/overlay-remove/docs/index.js#L7-L49\n```\n| **Note:** The JavaScript is compiled from the TypeScript snippet.\n\nCSS \n\n```css\n/* \n * Always set the map height explicitly to define the size of the div element\n * that contains the map. \n */\n#map {\n height: 100%;\n}\n\n/* \n * Optional: Makes the sample page fill the window. \n */\nhtml,\nbody {\n height: 100%;\n margin: 0;\n padding: 0;\n}\n\n#floating-panel {\n position: absolute;\n top: 10px;\n left: 25%;\n z-index: 5;\n background-color: #fff;\n padding: 5px;\n border: 1px solid #999;\n text-align: center;\n font-family: \"Roboto\", \"sans-serif\";\n line-height: 30px;\n padding-left: 10px;\n}\nhttps://github.com/googlemaps/js-samples/blob/2683f7366fb27829401945d2a7e27d77ed2df8e5/dist/samples/overlay-remove/docs/style.css#L7-L38\n```\n\nHTML \n\n```html\n\u003chtml\u003e\n \u003chead\u003e\n \u003ctitle\u003eRemoving Overlays\u003c/title\u003e\n\n \u003clink rel=\"stylesheet\" type=\"text/css\" href=\"./style.css\" /\u003e\n \u003cscript type=\"module\" src=\"./index.js\"\u003e\u003c/script\u003e\n \u003c/head\u003e\n \u003cbody\u003e\n \u003cdiv id=\"floating-panel\"\u003e\n \u003cinput id=\"remove-overlay\" type=\"button\" value=\"Remove overlay\" /\u003e\n \u003cinput id=\"restore-overlay\" type=\"button\" value=\"Restore overlay\" /\u003e\n \u003c/div\u003e\n \u003cdiv id=\"map\"\u003e\u003c/div\u003e\n\n \u003c!-- \n The `defer` attribute causes the script to execute after the full HTML\n document has been parsed. For non-blocking uses, avoiding race conditions,\n and consistent behavior across browsers, consider loading using Promises. See\n https://developers.google.com/maps/documentation/javascript/load-maps-js-api\n for more information.\n --\u003e\n \u003cscript\n src=\"https://maps.googleapis.com/maps/api/js?key=AIzaSyB41DRUbKWJHPxaFjMAwdrzWzbVKartNGg&callback=initMap&v=weekly\"\n defer\n \u003e\u003c/script\u003e\n \u003c/body\u003e\n\u003c/html\u003ehttps://github.com/googlemaps/js-samples/blob/2683f7366fb27829401945d2a7e27d77ed2df8e5/dist/samples/overlay-remove/docs/index.html#L8-L34\n```\n\nTry Sample \n[JSFiddle.net](https://jsfiddle.net/gh/get/library/pure/googlemaps/js-samples/tree/master/dist/samples/overlay-remove/jsfiddle) [Google Cloud Shell](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fgooglemaps%2Fjs-samples&cloudshell_git_branch=sample-overlay-remove&cloudshell_tutorial=cloud_shell_instructions.md&cloudshell_workspace=.)\n\nClone Sample\n\n\nGit and Node.js are required to run this sample locally. Follow these [instructions](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to install Node.js and NPM. The following commands clone, install dependencies and start the sample application. \n\n git clone -b sample-overlay-remove https://github.com/googlemaps/js-samples.git\n cd js-samples\n npm i\n npm start\n\n\nOther samples can be tried by switching to any branch beginning with `sample-`\u003cvar translate=\"no\"\u003eSAMPLE_NAME\u003c/var\u003e. \n\n git checkout sample-\u003cvar translate=\"no\"\u003e\u003cspan class=\"devsite-syntax-nx\"\u003eSAMPLE_NAME\u003c/span\u003e\u003c/var\u003e\n npm i\n npm start"]]
