A plugin for LeafletJS to use Google maps basemaps.
A LeafletJS plugin to use Google maps basemaps.
Using Leaflet 1.9.4: https://ivansanchez.gitlab.io/Leaflet.GridLayer.GoogleMutant/demo.html
Using Leaflet 2.0.0-alpha1: https://ivansanchez.gitlab.io/Leaflet.GridLayer.GoogleMutant/demo.v2.html
- This plugin doesn't work on IE10 or lower, as that browser doesn't implement DOM mutation observers. Chrome, Firefox, Safari, IE11 and Edge are fine.
- Starting with v0.11.0, the code relies on Symbol and Map. IE11 and browsers that don't support Symbol or don't support Map also need polyfills to work.
- The maxNativeZoom functionality introduced in v0.5.0 (thanks, @luiscamacho!) requires Leaflet >1.0.3.
Include the GMaps JS API in your HTML, plus Leaflet:
``html`
href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css"
integrity="sha256-p4NxAoJBhIIN+hmNHrzRCf9tD/miZyoHS5obTRR9BMY="
crossorigin=""
/>
integrity="sha256-20nQCchB9co0qIjJZRGuk2/Z9VM+kNiyxNV1lvTlZBo="
crossorigin=""
>
Include the GoogleMutant javascript file:
`html`
Then, you can create an instance of L.GridLayer.GoogleMutant on your JS code:
`javascript`
var roads = L.gridLayer
.googleMutant({
type: "roadmap", // valid values are 'roadmap', 'satellite', 'terrain' and 'hybrid'
})
.addTo(map);
It's also possible to use custom styling
by passing a value to the styles option, e.g.:
`javascript`
var styled = L.gridLayer
.googleMutant({
type: "roadmap",
styles: [
{ elementType: "labels", stylers: [{ visibility: "off" }] },
{ featureType: "water", stylers: [{ color: "#444444" }] },
],
})
.addTo(map);
If you're using Leaflet v2, then you should be doing something like the following, instead. Note the /src/ instead of /dist/ in the file path for GoogleMutant:
`html`
If you don't want to rely on a CDN to load GoogleMutant, you can:
- Fetch it with NPM by running npm install --save leaflet.gridlayer.googlemutant.yarn add leaflet.gridlayer.googlemutant
- Fetch it with Yarn by running .bower install https://gitlab.com/IvanSanchez/Leaflet.GridLayer.GoogleMutant.git
- We discourage using Bower but, if you must, .
You can also download a static copy from the CDN, or clone this git repo.
- hybrid mode prunes tiles before needed for no apparent reason, so the map flickers when there is a zoom change.
- Even though imagery exists at zoom levels up to 23, GoogleMutant caps the max zoom level at 21.
This is to prevent scenarios where detecting imagery at those zooms levels is hard and creates problems (e.g. when zooming in/out close to a the boundary of such hi-res imagery).
You can override this (at your own risk!) by using the maxZoom option with a value larger than 21.
- GoogleMutant is meant to provide a reliable (and ToC-compliant) way of loading Google Map's tiles into Leaflet, nothing more.
This means that route finding, geocoding, POI info, streetview, KML support, and in general anything that depends on calls to the Google Maps API are not implemented and are not a priority.
Before GoogleMutant, it was already possible to display Google Maps in Leaflet, but unfortunately the state of the art was far from perfect:
- Shramov's Leaflet plugin implementation (as well as an old, not recommended OpenLayers technique) suffer from a big drawback: the basemap and whatever overlays are on top are _off sync_. This is very noticeable when dragging or zooming.
- MapGear's implementation with OpenLayers uses a different technique (decorate OL3 with GMaps methods), but has a different set of limitations.
- Avin Mathew's implementation uses a clever timer-based technique, but it requires jQuery and still feels jittery due to the timers.
Before, an instance of the Google Maps JS API was displayed behind the Leaflet container, and synchronized as best as it could be done.
Now, in order to provide the best Leaflet experience, GoogleMutant uses both DOM mutation observers and L.GridLayer` from Leaflet 1.0.0. The basemap tiles are still requested _through_ the Google maps JavaScript API, but they switch places to use Leaflet drag and zoom.
---
"THE BEER-WARE LICENSE":
can do whatever you want with this stuff. If we meet some day, and you think
this stuff is worth it, you can buy me a beer in return.
---