WebGL Overlay (ThreeJS wrapper) Stay organized with collections Save and categorize content based on your preferences.
This example demonstrates using theWebGLOverlayView
to display a 3D imagewith animation on a vector map, using thejs-threelibrary.
Read thedocumentation.
TypeScript
import*asTHREEfrom"three";import{GLTFLoader}from"three/examples/jsm/loaders/GLTFLoader";import{ThreeJSOverlayView}from"@googlemaps/three";letmap:google.maps.Map;constmapOptions={tilt:0,heading:0,zoom:18,center:{lat:35.6594945,lng:139.6999859},mapId:"15431d2b469f209e",// disable interactions due to animation loop and moveCameradisableDefaultUI:true,gestureHandling:"none",keyboardShortcuts:false,};functioninitMap():void{constmapDiv=document.getElementById("map")asHTMLElement;map=newgoogle.maps.Map(mapDiv,mapOptions);constscene=newTHREE.Scene();constambientLight=newTHREE.AmbientLight(0xffffff,0.75);scene.add(ambientLight);constdirectionalLight=newTHREE.DirectionalLight(0xffffff,0.25);directionalLight.position.set(0,10,50);scene.add(directionalLight);// Load the model.constloader=newGLTFLoader();consturl="https://raw.githubusercontent.com/googlemaps/js-samples/main/assets/pin.gltf";loader.load(url,(gltf)=>{gltf.scene.scale.set(10,10,10);gltf.scene.rotation.x=Math.PI/2;scene.add(gltf.scene);let{tilt,heading,zoom}=mapOptions;constanimate=()=>{if(tilt <67.5){tilt+=0.5;}elseif(heading<=360){heading+=0.2;zoom-=0.0005;}else{// exit animation loopreturn;}map.moveCamera({tilt,heading,zoom});requestAnimationFrame(animate);};requestAnimationFrame(animate);});newThreeJSOverlayView({map,scene,anchor:{...mapOptions.center,altitude:100},THREE,});}declareglobal{interfaceWindow{initMap:()=>void;}}window.initMap=initMap;
JavaScript
import*asTHREEfrom"three";import{GLTFLoader}from"three/examples/jsm/loaders/GLTFLoader";import{ThreeJSOverlayView}from"@googlemaps/three";letmap;constmapOptions={tilt:0,heading:0,zoom:18,center:{lat:35.6594945,lng:139.6999859},mapId:"15431d2b469f209e",// disable interactions due to animation loop and moveCameradisableDefaultUI:true,gestureHandling:"none",keyboardShortcuts:false,};functioninitMap(){constmapDiv=document.getElementById("map");map=newgoogle.maps.Map(mapDiv,mapOptions);constscene=newTHREE.Scene();constambientLight=newTHREE.AmbientLight(0xffffff,0.75);scene.add(ambientLight);constdirectionalLight=newTHREE.DirectionalLight(0xffffff,0.25);directionalLight.position.set(0,10,50);scene.add(directionalLight);// Load the model.constloader=newGLTFLoader();consturl="https://raw.githubusercontent.com/googlemaps/js-samples/main/assets/pin.gltf";loader.load(url,(gltf)=>{gltf.scene.scale.set(10,10,10);gltf.scene.rotation.x=Math.PI/2;scene.add(gltf.scene);let{tilt,heading,zoom}=mapOptions;constanimate=()=>{if(tilt <67.5){tilt+=0.5;}elseif(heading<=360){heading+=0.2;zoom-=0.0005;}else{// exit animation loopreturn;}map.moveCamera({tilt,heading,zoom});requestAnimationFrame(animate);};requestAnimationFrame(animate);});newThreeJSOverlayView({map,scene,anchor:{...mapOptions.center,altitude:100},THREE,});}window.initMap=initMap;
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;}#map{pointer-events:none;}
HTML
<html> <head> <title>Simple ThreeJS Overlay View</title> <link rel="stylesheet" type="text/css" href="./style.css" /> <script type="module" src="./index.js"></script> </head> <body> <div></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>
Try Sample
Clone Sample
Git and Node.js are required to run this sample locally. Follow theseinstructions to install Node.js and NPM. The following commands clone, install dependencies and start the sample application.
gitclone-bsample-threejs-overlay-simplehttps://github.com/googlemaps/js-samples.git
cdjs-samples
npmi
npmstart
Other samples can be tried by switching to any branch beginning withsample-SAMPLE_NAME
.
gitcheckoutsample-SAMPLE_NAME
npmi
npmstart
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-18 UTC.