Bicycle Layer

  • This example demonstrates how to display a map with a BicyclingLayer showing bike paths and suggested routes.

  • The code uses the Google Maps JavaScript API and can be implemented using either JavaScript or TypeScript.

  • The HTML, CSS, and JavaScript/TypeScript code snippets are provided for easy integration into your project.

  • Users can explore the sample interactively on JSFiddle or Google Cloud Shell and can also clone the sample code for local execution using Git and Node.js.

This example creates a map that displays bike paths, suggested bike routes, and other overlays specific to bicycle use.

Read the documentation.

TypeScript

async function init(): Promise<void> {
    const { BicyclingLayer } = await google.maps.importLibrary('maps');

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

    const bikeLayer = new BicyclingLayer();

    bikeLayer.setMap(innerMap);
}

void init();

JavaScript

async function init() {
    const { BicyclingLayer } = await google.maps.importLibrary('maps');

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

    const bikeLayer = new BicyclingLayer();

    bikeLayer.setMap(innerMap);
}

void init();

CSS

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

HTML

<html>
    <head>
        <title>Bicycle Layer</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="42.3726399,-71.1096528"
            zoom="14"
            map-id="DEMO_MAP_ID"></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/layer-bicycling
  npm start