Leaflet-providers

An extension to Leaflet that contains configurations for various free¹ tile providers.

Installation

Download leaflet-providers.js and include it in your page after including Leaflet, e.g.:

<head>
  ...
  <script src="http://unpkg.com/[email protected]/dist/leaflet.js"></script>
  <script src="js/leaflet-providers.js"></script>
</head>

Usage

Leaflet-providers providers are refered to with a provider[.<variant>]-string. Let's say you want to add the nice Watercolor style from Stamen to your map, you pass Stamen.Watercolor to the L.tileLayer.provider-constructor, which will return a L.TileLayer instance for Stamens Watercolor tile layer.

// add Stamen Watercolor to map.
L.tileLayer.provider('Stamen.Watercolor').addTo(map);

Protocol relativity (`https://`-urls)

Leaflet-providers tries to use https:// if the page uses https:// and the provider supports it.

Retina tiles

Some providers have retina tiles for which the URL only needs to be slightly adjusted, e.g. [email protected]. For this, add the retina option in the URL, e.g. -----{retina}.png, and set a retina value in the options, e.g. retina: '@2x'. If Leaflet detects a retina screen (L.Browser.retina), the retina option passed to the tileLayer is set to the value supplied, otherwise it's replaced by an empty string.

Providers

Leaflet-providers provides tile layers from different providers, including OpenStreetMap, Stamen, Esri and OpenWeatherMap. The full listing of free to use layers can be previewed. The page will show you the name to use with leaflet-providers.js and the code to use it without dependencies.

Providers requiring registration

In addition to the providers you are free1 to use, we support some layers which require registration.

HERE (formerly Nokia).

In order to use HERE layers, you must register. Once registered, you can create an app_id and app_code which you have to pass to L.tileLayer.provider in the options:

L.tileLayer.provider('HERE.terrainDay', {
    app_id: '<insert ID here>',
    app_code: '<insert ID here>'
}).addTo(map);

Available HERE layers

Mapbox

In order to use Mapbox maps, you must register. You can get map_ID (i.e mapbox.satellite) and ACCESS_TOKEN from Mapbox projects:

L.tileLayer.provider('MapBox', {
    id: 'ID': '<insert map_ID here>',
    accessToken: '<insert ACCESS_TOKEN here>'
}).addTo(map);

Thunderforest

In order to use Thunderforest maps, you must register. Once registered, you have an api_key which you have to pass to L.tileLayer.provider in the options:

L.tileLayer.provider('Thunderforest.Landscape', {apikey: '<insert api_key here>'}).addTo(map);

Esri/ArcGIS

In order to use ArcGIS maps, you must register and abide by the terms of service. No special syntax is required.

Available Esri layers

Attribution

This work was inspired from https://gist.github.com/1804938, and originally created by Stefan Seelmann.

What do we mean by free?

1 We try to maintain leaflet-providers in such a way that you'll be able to use the layers we include without paying money. This doesn't mean no limits apply, you should always check before using these layers for anything serious.

codiceovvio / leaflet-providers Goto Github PK