A plugin for Esri Leaflet to visualize static basemap tiles from the static basemap tile service.
The Esri Leaflet Static Basemap Tile package provides a class to load static basemap tiles from the ArcGIS static basemap tile service. Basemaps are rendered as image tiles that adhere to the OpenAPI specification.
Check out the live demo.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Esri Leaflet Static Basemap Tiles</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<!-- Load Leaflet from CDN -->
<link rel="stylesheet" href="https://unpkg.com/leaflet/dist/leaflet.css" />
<script src="https://unpkg.com/leaflet/dist/leaflet.js"></script>
<!-- Load Esri Leaflet -->
<script src="https://unpkg.com/esri-leaflet/dist/esri-leaflet.js"></script>
<!-- Load Esri Leaflet Static Basemap Tile -->
<script src="https://unpkg.com/esri-leaflet-static-basemap-tile/dist/esri-leaflet-static-basemap-tile.js"></script>
<style>
body {
margin: 0;
padding: 0;
}
#map {
position: absolute;
top: 0;
bottom: 0;
right: 0;
left: 0;
}
</style>
</head>
<body>
<div id="map"></div>
<script>
var map = L.map("map").setView([40.706, -73.926], 4);
L.esri.Static.staticBasemapTileLayer("beta/arcgis/outdoor", {
token: "< YOUR ARCGIS ACCESS TOKEN HERE >"
}).addTo(map);
</script>
</body>
</html>L.esri.Static.staticBasemapTileLayer(<String> style, <Object> options)
Displays a basemap layer using tiles from the ArcGIS Static basemap tiles service (currently in beta). Extends L.TileLayer.
L.esri.Static.staticBasemapTileLayer("beta/arcgis/streets", {
token: "< YOUR ARCGIS ACCESS TOKEN HERE >"
}).addTo(map);L.esri.Static.staticBasemapTileLayer("beta/arcgis/newspaper", {
token: "< YOUR ARCGIS ACCESS TOKEN HERE >",
language: "fr"
}).addTo(map);-
The
styleparameter must be a valid basemap style code. -
The
tokenparameter must be a valid ArcGIS access token.
For a full list of parameters, go to the Esri Leaflet API reference.
staticBasemapTileLayer accepts a basemap style code as a string in the format beta/<provider>/<style>. For example, beta/arcgis/outdoor will load the ArcGIS Outdoor basemap style.
For a full list of supported basemap styles, go to the static basemap tiles service documentation.
L.esri.Static.Util.getSelf(<String> token)
Utility method that makes a request to the /self endpoint of the ArcGIS static basemap tiles service. Requires a valid ArcGIS access token.
This endpoint returns a list of all supported basemap styles and language parameters, which can be useful in creating maps that support multiple styles or languages.
- Fork and clone this repo.
cdinto theesri-leaflet-static-basemap-tilefolder.- Install the dependencies with
npm install. - Run
npm run devto compile the raw source inside a newly createddistfolder and start up a development web server.- Alternatively, run
npm run startto compile raw source code into both "debug" and "production" versions. This process will take longer to compile when saving your local changes to source code. Recommended only when building for production.
- Alternatively, run
- Open
examples/quickstart-dev.htmlto see local changes in action.
- Fork and clone this repo.
cdinto theesri-leaflet-static-basemap-tilefolder.- Install the dependencies with
npm install. - Run
npm run buildto compile the raw source inside a newly createddistfolder. - Run
npm testfrom the command line to execute tests. - Open
examples/quickstart-dev.htmlorexamples/quickstart-prod.htmlto see local changes in action. - Create a pull request if you'd like to share your work.
Find a bug or want to request a new feature? Please let us know by submitting an issue.
Please take a look at previous issues on Esri Leaflet that resolve common problems.
You can also post questions on the GIS Stack Exchange, as well as the Open Source Mapping community on Esri forums.
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
Copyright © 2016-2024 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's LICENSE file.