Esri Leaflet is maintained with ❤️ by folks spanning multiple teams within Esri, but we provide no guarantee of individual features, nor a traditional product lifecycle to support planning.
We are proud to facilitate a project which requires participation from our diverse user community in order to thrive and we welcome contributions from those just getting their feet wet in open-source.
We've shared lots of sample code showing off many of the features of Esri Leaflet.
The easiest way to get started is to load Esri Leaflet via CDN. Here is an example you can copy/paste into your own
<!-- Load Leaflet from CDN --><!-- Load Esri Leaflet from CDN -->
A full API Reference can be found in the Esri Leaflet website.
The source code for the documentation site can be found in the repository below. If you notice a typo or other problem, please let us know!
Many folks have written plugins to customize and extend Leaflet.
You can also pick and choose additional Esri Leaflet plugins.
If something isn't working the way you expected, please take a look at previously logged issues that resolve common problems first. Have you found a new bug? Want to request a new feature? We'd love to hear from you. Please let us know by submitting an issue.
If you'd like to inspect and modify the source of Esri Leaflet, follow the instructions below to set up a local development environment.
package.jsondependencies by running
npm startfrom the command line. This will compile minified source in a brand new
distdirectory, launch a tiny webserver and begin watching the raw source for changes.
npm testto make sure you haven't introduced a new 'feature' accidentally.
master branch of this repository is only compatible with Leaflet 1.x.
For transparency into the release cycle and in striving to maintain backward compatibility, Esri Leaflet is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
For more information on SemVer, please visit http://semver.org/.
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
If your app is for public, non-revenue generating, non-government, non-commercial use, the free Essentials Developer Plan is sufficient. If you're going to generate revenue or are using the app for government or business purposes, you'll have to purchase a paid ArcGIS Online Deployment Plan when you're ready to deploy your app to production.
If you display an ArcGIS Online service in any Leaflet application, we require that you display Esri attribution and recognize data providers. Using this plugin, it couldn't be easier to follow the terms. Just select your basemap and the appropriate credits will be displayed in Leaflet's own Attribution control as users pan/zoom automatically.
If you need more than 1 million map transactions per month, please let us know.
L.esri.DynamicMapLayeroriginally used code from AGS.Layer.Dynamic.js
L.esri.TiledMapLayeradapts some code from arcgis-level-fixer
Copyright 2017 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.