A lightweight set of tools for working with ArcGIS services in Leaflet.
JavaScript Other
Latest commit 5e1bc02 Sep 28, 2016 @jgravois jgravois committed on GitHub lint code in test suite (#859)
* start linting test directory too

* a few more tweaks

* jj

README.md

Esri Leaflet

npm version build status apache licensed

Leaflet plugins for working with a handful of the most popular ArcGIS Service types. This includes Esri basemaps and feature services, as well as tiled map, dynamic map and image services.

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.

The goal of this project is not to replace the ArcGIS API for JavaScript but rather to provide small components for only some aspects of the ArcGIS platform for developers who prefer to build mapping applications with Leaflet.

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.

Support for Geocoding services and Geoprocessing services, as well as service defined rendering are available as well (via additional plugins).

If you'd like to display Esri services in any Leaflet application, we ask that you adhere to our Terms of Use and attribution requirements.

Table of Contents

Demos

We've shared lots of sample code showing off many of the features of Esri Leaflet.

http://esri.github.io/esri-leaflet/examples/

Example

The easiest way to get started is to load Esri Leaflet via CDN. Here is an example you can copy/paste into your own .html file.

App

<!DOCTYPE html>
<html>
  <head>
    <!-- Load Leaflet from CDN-->
    <link rel="stylesheet" href="https://unpkg.com/leaflet@1.0.0/dist/leaflet.css" />
    <script src="https://unpkg.com/leaflet@1.0.0/dist/leaflet-src.js"></script>

    <!-- Load Esri Leaflet locally, after cloning this repository -->
    <script src="https://unpkg.com/esri-leaflet@2.0.3"></script>

    <style>
      html, body, #map {
        margin:0; padding:0;  width : 100%; height : 100%;
      }
    </style>
  </head>
  <body>
    <div id="map"></div>
    <script>
      var map = L.map('map').setView([45.528, -122.680], 13);
      L.esri.basemapLayer("Gray").addTo(map);

      var parks = L.esri.featureLayer({
        url: "https://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Portland_Parks/FeatureServer/0",
        style: function () {
          return { color: "#70ca49", weight: 2 };
        }
      }).addTo(map);

      var popupTemplate = "<h3>{NAME}</h3>{ACRES} Acres<br><small>Property ID: {PROPERTYID}<small>";

      parks.bindPopup(function(e){
        return L.Util.template(popupTemplate, e.feature.properties)
      });
    </script>
  </body>
</html>

API Reference

A full API Reference can be found in the Esri Leaflet website.

http://esri.github.io/esri-leaflet/api-reference/

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!

https://github.com/Esri/esri-leaflet-doc

Additional Plugins

Many folks have written plugins to customize and extend Leaflet.

http://leafletjs.com/plugins.html

You can also pick and choose additional Esri Leaflet plugins.

http://esri.github.io/esri-leaflet/plugins/)

Frequently Asked Questions

Issues

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're looking for help you can also post issues on GIS Stackexchange and/or the Esri Leaflet place on GeoNet.

Going Deeper

Development Instructions

If you'd like to inspect and modify the source of Esri Leaflet, follow the instructions below to set up a local development environment.

  1. Fork and clone Esri Leaflet
  2. cd into the esri-leaflet folder
  3. Install the package.json dependencies by running npm install
  4. Run npm start from the command line. This will compile minified source in a brand new dist directory, launch a tiny webserver and begin watching the raw source for changes.
  5. Run npm test to make sure you haven't introduced a new 'feature' accidentally.
  6. Make your changes and create a pull request

Dependencies

  • Esri Leaflet 1.x (available on CDN) can be used in apps alongside:

  • Esri Leaflet 2.x (available on CDN) can be used in apps alongside:

The master branch of this repository is only compatible with Leaflet 1.0.x.

Versioning

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/.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Terms

If you display an ArcGIS Online service in any Leaflet application, we require that you:

  1. Sign up for a free developer account.
  2. 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 always be displayed in Leaflet's own Attribution control as users pan/zoom automatically.

L.esri.basemapLayer('Topographic').addTo(map);

attribution

If you need more than 1 million map transactions per month, please let us know.

https://developers.arcgis.com/terms/attribution/ https://developers.arcgis.com/terms/

Credit

Licensing

Copyright 2016 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

http://www.apache.org/licenses/LICENSE-2.0

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.