Control marker collision behavior

The following example shows how to change marker collision behavior.

Read the documentation.

JavaScript

const markers = [];

async function init() {
    // Request needed libraries.
    const { Map3DElement, Marker3DElement } =
        await google.maps.importLibrary('maps3d');

    const map = new Map3DElement({
        center: { lat: 47.6094, lng: -122.339, altitude: 0 },
        range: 1000,
        mode: 'HYBRID',
    });

    for (const [lng, lat] of positions) {
        const marker = new Marker3DElement({
            position: { lat, lng },
            // Try setting a different collision behavior here.
            collisionBehavior: 'REQUIRED',
        });

        markers.push(marker);
        map.append(marker);
    }

    document.body.append(map);
}

const positions = [
    [-122.3402, 47.6093],
    [-122.3402, 47.6094],
    [-122.3403, 47.6094],
    [-122.3384, 47.6098],
    [-122.3389, 47.6095],
    [-122.3396, 47.6095],
    [-122.3379, 47.6097],
    [-122.3378, 47.6097],
    [-122.3396, 47.6091],
    [-122.3383, 47.6089],
    [-122.3379, 47.6093],
    [-122.3381, 47.6095],
    [-122.3378, 47.6095],
];

void init();

const dropdown = document.getElementById('selectElementId');
dropdown.addEventListener('change', drawMap);

function drawMap() {
    for (const marker of markers) {
        marker.collisionBehavior = dropdown.value;
    }
}

CSS

/* 
 * Always set the map height explicitly to define the size of the div element
 * that contains the map. 
 */
html,
map {
    height: 100%;
}
body {
    height: 100%;
    margin: 0;
    padding: 0;
}
selector {
    padding: 2px;
    float: right;
}

HTML

<html>
    <head>
        <title>Map</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>
        <div id="map"></div>

        <selector>
            <select id="selectElementId">
                <option value="">Pick a Collision Behavior</option>
                <option value="REQUIRED">Required</option>
                <option value="REQUIRED_AND_HIDES_OPTIONAL">
                    Required and hides optional
                </option>
                <option value="OPTIONAL_AND_HIDES_LOWER_PRIORITY">
                    Optional and hides lower priority
                </option>
            </select>
        </selector>
    </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/3d-marker-collision-behavior
  npm start