Places UI Kit :A ready-to-use library that provides room for customization and low-code development. Try it out, and share your input on your UI Kit experience.

Overlaying an Image Map Type

AI-generated Key Takeaways

This example demonstrates how to overlay an image representing a building's interior onto a Google Map using image tiles.
It utilizes the google.maps.ImageMapType class to define the image overlay and its tile coordinates.
The code provides functionality to fetch and display image tiles within specified zoom levels and bounds.
A predefined set of image tiles is used, and the example showcases how to integrate them with the map.
Users can explore the interactive example via provided links to JSFiddle and Google Cloud Shell, or clone the sample code for local execution.

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 
 ); 
 } 
 declare 
  
 global 
  
 { 
  
 interface 
  
 Window 
  
 { 
  
 initMap 
 : 
  
 () 
  
 = 
>  
 void 
 ; 
  
 } 
 } 
 window 
 . 
 initMap 
  
 = 
  
 initMap 
 ; 
   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 
 ); 
 } 
 window 
 . 
 initMap 
  
 = 
  
 initMap 
 ; 
   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

<html>
  <head>
    <title>Overlaying an Image Map Type</title>

    <link rel="stylesheet" type="text/css" href="./style.css" />
    <script type="module" src="./index.js"></script>
  </head>
  <body>
    <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>  index.html

Try Sample

JSFiddle.net Google Cloud Shell

Clone Sample

Git and Node.js are required to run this sample locally. Follow these instructions to install Node.js and NPM. The following commands clone, install dependencies and start the sample application.

  
  git 
  
 clone 
  
 - 
 b 
  
 sample 
 - 
 maptype 
 - 
 image 
 - 
 overlay 
  
 https 
 : 
 //github.com/googlemaps/js-samples.git 
 
  
  cd 
  
 js 
 - 
 samples 
 
  
  npm 
  
 i 
 
  
  npm 
  
 start

Other samples can be tried by switching to any branch beginning with sample- SAMPLE_NAME .

  
  git 
  
 checkout 
  
 sample 
 - 
  SAMPLE_NAME 
 
 
  
  npm 
  
 i 
 
  
  npm 
  
 start