Control Options

  • This code demonstrates how to customize the Map Type control in Google Maps to display as a dropdown menu.

  • It utilizes the MapTypeControlOptions and specifically the style property set to DROPDOWN_MENU to achieve this.

  • The example also shows how to limit the map types displayed in the dropdown to "roadmap" and "terrain" using the mapTypeIds property.

  • The sample provides both TypeScript and JavaScript implementations along with the necessary HTML and CSS for rendering.

This example sets the Map Type control to use the dropdown style.

Read the documentation.

TypeScript

// You can set control options to change the default position or style of many
// of the map controls.

async function init() {
    //  Request the needed libraries.
    const [{ MapTypeControlStyle, MapTypeId }, { ControlPosition }] =
        await Promise.all([
            google.maps.importLibrary('maps'),
            google.maps.importLibrary('core'),
        ]);

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

    const innerMap = mapElement.innerMap;

    innerMap.setOptions({
        mapTypeControl: true,
        mapTypeControlOptions: {
            style: MapTypeControlStyle.DROPDOWN_MENU,
            mapTypeIds: [MapTypeId.ROADMAP, MapTypeId.TERRAIN],
            position: ControlPosition.TOP_CENTER,
        },
    });
}

void init();

JavaScript

// You can set control options to change the default position or style of many
// of the map controls.

async function init() {
    //  Request the needed libraries.
    const [{ MapTypeControlStyle, MapTypeId }, { ControlPosition }] =
        await Promise.all([
            google.maps.importLibrary('maps'),
            google.maps.importLibrary('core'),
        ]);

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

    const innerMap = mapElement.innerMap;

    innerMap.setOptions({
        mapTypeControl: true,
        mapTypeControlOptions: {
            style: MapTypeControlStyle.DROPDOWN_MENU,
            mapTypeIds: [MapTypeId.ROADMAP, MapTypeId.TERRAIN],
            position: ControlPosition.TOP_CENTER,
        },
    });
}

void init();

CSS

/* 
 * Always set the map height explicitly to define the size of the div element
 * that contains the map. 
 */
gmp-map {
    height: 100%;
}

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

HTML

<html>
    <head>
        <title>Control Options</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="-44.03416970075901, 170.4710062642279"
            zoom="8"></gmp-map>
    </body>
</html>

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. 

  cd samples/control-options
  npm start