Page Summary
-
This example demonstrates how to restrict the panning and zooming boundaries of a Google Map to a specific region, in this case, New Zealand.
-
The map is initialized centered on Auckland, New Zealand, and users can explore other cities within the country.
-
Users are prevented from panning or zooming outside the defined boundaries of New Zealand.
-
The sample code is provided in both TypeScript and JavaScript, along with HTML and CSS for styling and structure.
This example creates a map that starts in Auckland, New Zealand. The map is restricted to New Zealand. The user can pan away from Auckland and explore other New Zealand cities, but the user cannot pan or zoom to beyond the constraints set on the map.
Try panning north, or zooming out, to see what happens when a user tries to move beyond these boundaries.
TypeScript
let innerMap ; const mapElement = document . querySelector ( 'gmp-map' ) as google . maps . MapElement ; const NEW_ZEALAND_BOUNDS = { north : - 34.36 , south : - 47.35 , west : 166.28 , east : - 175.81 , }; async function initMap () { // Import the needed libraries. ( await google . maps . importLibrary ( 'maps' )) as google . maps . MapsLibrary ; innerMap = mapElement . innerMap ; // Restrict the map to the provided bounds. innerMap . setOptions ({ restriction : { latLngBounds : NEW_ZEALAND_BOUNDS , strictBounds : false , } }); } initMap ();
JavaScript
let innerMap ; const mapElement = document . querySelector ( 'gmp-map' ); const NEW_ZEALAND_BOUNDS = { north : - 34.36 , south : - 47.35 , west : 166.28 , east : - 175.81 , }; async function initMap () { // Import the needed libraries. ( await google . maps . importLibrary ( 'maps' )); innerMap = mapElement . innerMap ; // Restrict the map to the provided bounds. innerMap . setOptions ({ restriction : { latLngBounds : NEW_ZEALAND_BOUNDS , strictBounds : false , } }); } initMap ();
CSS
/* * Optional: Makes the sample page fill the window. */ html , body { height : 100 % ; margin : 0 ; padding : 0 ; }
HTML
<html> <head> <title>Map Bounds Restriction</title> <link rel="stylesheet" type="text/css" href="./style.css" /> <script type="module" src="./index.js"></script> <!-- prettier-ignore --> <script>(g=>{var h,a,k,p="The Google Maps JavaScript API",c="google",l="importLibrary",q="__ib__",m=document,b=window;b=b[c]||(b[c]={});var d=b.maps||(b.maps={}),r=new Set,e=new URLSearchParams,u=()=>h||(h=new Promise(async(f,n)=>{await (a=m.createElement("script"));e.set("libraries",[...r]+"");for(k in g)e.set(k.replace(/[A-Z]/g,t=>"_"+t[0].toLowerCase()),g[k]);e.set("callback",c+".maps."+q);a.src=`https://maps.${c}apis.com/maps/api/js?`+e;d[q]=f;a.onerror=()=>h=n(Error(p+" could not load."));a.nonce=m.querySelector("script[nonce]")?.nonce||"";m.head.append(a)}));d[l]?console.warn(p+" only loads once. Ignoring:",g):d[l]=(f,...n)=>r.add(f)&&u().then(()=>d[l](f,...n))}) ({key: "AIzaSyA6myHzS10YXdcazAFalmXvDkrYCp5cLc8", v: "weekly" });</script> </head> <body> <gmp-map center="-37.06, 174.58" zoom="7"></gmp-map> </body> </html>
Try Sample
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 https : //github.com/googlemaps-samples/js-api-samples.gitcd samples / control - bounds - restrictionnpm inpm start
