L.esri.Static.staticBasemapTileLayer

Extends L.TileLayer.

L.esri.Static.staticBasemapTileLayer displays static basemap tiles from the . It is included in the esri-leaflet-static-basemap-tile plugin. Basemaps from the are rendered as raster tiles that are returned as PNG files.

Constructor

ConstructorDescription
L.esri.Static.staticBasemapTileLayer(<String> style, <Object> options)style refers to a basemap style enumeration such as arcgis/streets.

Basemap style enumerations

Basemap style enumerations represent predefined basemap styles provided by ArcGIS. Set the style parameter to a valid style enumeration to load a basemap into your application.

Style enumerations from the Static basemap tiles service contain multiple parts separated by a forward slash (/). The general format is:

  • {provider}/{style-name}
  • {provider}/{style-name}/{component}

Options

L.esri.Static.staticBasemapTileLayer accepts all L.TileLayer options.

OptionTypeDescription
tokenString

An ArcGIS with permissions to access the . Required.

languageString

Sets the language of the place labels on the map. Input must be a language code supported by the specified basemap style.

Default panes

L.esri.Static.staticBasemapTileLayer is added to Leaflet maps using the following panes by default. Panes specified using the pane option will override these values.

Basemap typeLeaflet PanezIndex

Label enumeration ending in /labels

esri-labels300

Default (all other basemaps)

tilePane200

Methods

L.esri.Static.staticBasemapTileLayer inherits all methods from L.TileLayer.

Examples

Display a basemap style

This example loads the ArcGIS Outdoor basemap style.

1
2
3
4
5
const map = L.map("map").setView([40.706, -73.926], 4);

L.esri.Static.staticBasemapTileLayer("arcgis/outdoor", {
token: "YOUR_ACCESS_TOKEN"
}).addTo(map);

Change the place label language

This example loads the ArcGIS Navigation basemap style with place labels in French.

1
2
3
4
5
6
const map = L.map("map").setView([40.706, -73.926], 4);

L.esri.Static.staticBasemapTileLayer("arcgis/navigation", {
  token: "YOUR_ACCESS_TOKEN",
  language: "fr"
}).addTo(map);

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close