L.esri.BasemapLayer (Deprecated)

Extends L.TileLayer

L.esri.basemapLayer is used to display classic raster tiled Esri hosted basemaps and attributes data providers appropriately. The Terms of Use for Esri hosted services apply to all Leaflet applications.

DEPRECIATION NOTICE: This class references the old ArcGIS tiled basemap services that are no longer updated and could be deactivated without notice. Please update your application to use the Vector Basemap Layer Plugin that references the new ArcGIS Platform basemap layer service. To do so, you will need an ArcGIS account and an API key. See the following example.


Constructor Description
L.esri.basemapLayer(<String> key, <Object> options) key refers to the specific basemap you'd like to add. The options parameter can accept the same options as L.TileLayer.

These maps have worldwide coverage at a variety of zoom levels.

  • Streets
  • Topographic
  • NationalGeographic
  • Oceans
  • Gray
  • DarkGray
  • Imagery
  • ImageryClarity (added in 2.1.3)
  • ImageryFirefly (added in 2.2.0)
  • ShadedRelief
  • Terrain
  • USATopo (added in 2.0.0)
  • Physical (added in 2.2.0)
Optional Labels

These are optional layers that add extra text labels to the basemaps.

  • OceansLabels - Labels to pair with the Oceans basemap
  • GrayLabels - Labels to pair with the Gray basemap
  • DarkGrayLabels - Labels to pair with the DarkGray basemap
  • ImageryLabels - Labels including political boundaries to pair with any Imagery basemap
  • ImageryTransportation - Street map labels for pairing with any Imagery basemap
  • ShadedReliefLabels - Labels for pairing with the ShadedRelief basemap
  • TerrainLabels - Labels for pairing with the Terrain or Physical basemap


L.esri.basemapLayer also accepts all L.TileLayer options.

Option Type Default Description
token String null Will use this token to authenticate all calls to the service.
ignoreDeprecationWarning boolean null When true, will not show the deprecation warning in the developer console.


L.esri.BasemapLayer inherits all methods from L.TileLayer.


L.esri.TiledMapLayer fires all L.TileLayer events.


var map = L.map('map').setView([37.75, -122.45], 12);


Edit this page on GitHub