Map Events

This example shows which events are triggered as you interact with the map.

Read the documentation.

TypeScript

const events = [
    'bounds_changed',
    'center_changed',
    'click',
    'contextmenu',
    'dblclick',
    'drag',
    'dragend',
    'dragstart',
    'heading_changed',
    'idle',
    'maptypeid_changed',
    'mousemove',
    'mouseout',
    'mouseover',
    'projection_changed',
    'resize',
    'rightclick', // use contextmenu
    'tilesloaded',
    'tilt_changed',
    'zoom_changed',
];

function setupListener(map: google.maps.Map, name: string) {
    const eventRow = document.getElementById(name)!;
    map.addListener(name, () => {
        eventRow.className = 'event active';
        setTimeout(() => {
            eventRow.className = 'event inactive';
        }, 1000);
    });
}

async function init() {
    // Request needed libraries.
    await google.maps.importLibrary('maps');

    const mapElement = document.querySelector('gmp-map')!;

    populateTable();

    // Get the inner map.
    const innerMap = mapElement.innerMap;
    innerMap.setOptions({
        mapTypeControl: false,
    });

    for (const event of events) {
        setupListener(innerMap, event);
    }
}

// Dynamically create the table of events from the defined hashmap
function populateTable() {
    const eventsTable = document.getElementById('sidebar')!;

    for (const event of events) {
        const eventDiv = document.createElement('div');
        eventDiv.className = 'event';
        eventDiv.id = event;
        eventDiv.innerText = event;
        eventsTable.appendChild(eventDiv);
    }
}

void init();

JavaScript

const events = [
    'bounds_changed',
    'center_changed',
    'click',
    'contextmenu',
    'dblclick',
    'drag',
    'dragend',
    'dragstart',
    'heading_changed',
    'idle',
    'maptypeid_changed',
    'mousemove',
    'mouseout',
    'mouseover',
    'projection_changed',
    'resize',
    'rightclick', // use contextmenu
    'tilesloaded',
    'tilt_changed',
    'zoom_changed',
];

function setupListener(map, name) {
    const eventRow = document.getElementById(name);
    map.addListener(name, () => {
        eventRow.className = 'event active';
        setTimeout(() => {
            eventRow.className = 'event inactive';
        }, 1000);
    });
}

async function init() {
    // Request needed libraries.
    await google.maps.importLibrary('maps');

    const mapElement = document.querySelector('gmp-map');

    populateTable();

    // Get the inner map.
    const innerMap = mapElement.innerMap;
    innerMap.setOptions({
        mapTypeControl: false,
    });

    for (const event of events) {
        setupListener(innerMap, event);
    }
}

// Dynamically create the table of events from the defined hashmap
function populateTable() {
    const eventsTable = document.getElementById('sidebar');

    for (const event of events) {
        const eventDiv = document.createElement('div');
        eventDiv.className = 'event';
        eventDiv.id = event;
        eventDiv.innerText = event;
        eventsTable.appendChild(eventDiv);
    }
}

void init();

CSS

/* Optional: Makes the sample page fill the window. */
html,
body {
    height: 100%;
    margin: 0;
    padding: 0;
}

#container {
    height: 100%;
}

#sidebar {
    width: 280px;
    padding: 2px;
    margin-left: 10px;
    margin-top: 10px;
    overflow: hidden;
    font-size: 15px;
    font-family: 'Droid Sans Mono', monospace;
    max-width: 300px;
    background-color: white;
}

.active {
    background-color: #99ccff;
}

.inactive {
    background-color: white;
}

HTML

<html>
    <head>
        <title>Map Events</title>

        <link rel="stylesheet" type="text/css" href="./style.css" />
        <script type="module" src="./index.js"></script>
        <script>
            // prettier-ignore
            (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: "GOOGLE_MAPS_API_KEY"
            });
        </script>
    </head>
    <body>
        <gmp-map center="37.4419, -122.1419" zoom="13">
            <div id="container" slot="control-inline-start-block-start">
                <div id="sidebar"></div>
            </div>
        </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. You will also need a Google Maps API key.

The following commands clone the repository, install dependencies, and copy the environment file.

  git clone https://github.com/googlemaps-samples/js-api-samples.git
  cd js-api-samples
  npm i
  cp .env.template .env

Once you copy the environment file, make sure to open the .env file and replace <Insert your own development API key here> with your actual API key before starting the sample.

In the sample code, GOOGLE_MAPS_API_KEY is a placeholder. When you run the sample, the API key from your .env file replaces it. In your own app, read the key only from an environment variable, with no literal key as a fallback value in source code.

  cd samples/map-events
  npm start