Skip to content

Latest commit

 

History

History
171 lines (118 loc) · 8.97 KB

README.md

File metadata and controls

171 lines (118 loc) · 8.97 KB

Esri Leaflet

Build Status

Leaflet plugins for ArcGIS Services. Currently Esri Leaflet supports loading Esri basemaps and feature services, as well as tiled, dynamic and image map services.

The goal of Esri Leaflet is not to replace the ArcGIS API for JavaScript, but rather to provide small components to allow developers to build mapping applications with Leaflet.

Currently Esri Leaflet is in development and should be thought of as a beta or preview.

Demos

There are loads of demos showing many of the features of Esri Leaflet.

Example

Here is a quick example to get you started. Just change the paths to point to the proper libraries and go.

App

<!DOCTYPE html>
<html>
  <head>
     <!-- Load Leaflet from CDN-->
    <link rel="stylesheet" href="http://cdn.leafletjs.com/leaflet-0.7.3/leaflet.css" />
    <script src="http://cdn.leafletjs.com/leaflet-0.7.3/leaflet.js"></script>

    <!-- Load Esri Leaflet from CDN -->
    <script src="http://cdn-geoweb.s3.amazonaws.com/esri-leaflet/1.0.0-rc.3/esri-leaflet.js"></script>

    <style>
      html, body,  #map {
        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 = new L.esri.FeatureLayer("http://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(feature){
        return L.Util.template(popupTemplate, feature.properties)
      });
    </script>
  </body>
</html>

Documentation & Examples

A full API Reference and plenty of sample code can be found at the Esri Leaflet website.

Development Roadmap

If you are interested in contributing to Esri Leaflet or are interested in seeing what is coming up next checkout the development roadmap.

Frequently Asked Questions

Please take a look at previous issues that resolve common problems.

You can also ask questions on GIS Stackexchange an/or the Esri Leaflet place on GeoNet.

Projects Using Esri Leaflet

Feel free to add your projects to this list!

Development Instructions

Make Sure you have the Grunt CLI installed.

  1. Fork and clone Esri Leaflet
  2. cd into the esri-leaflet folder
  3. Install the dependencies with npm install
  4. run grunt from the command line. This will start the web server locally at http://localhost:8001 and start watching the source files and running linting and testing commands.
  5. Make your changes and create a pull request

Dependencies

  • Leaflet version 0.7 or higher is required but the latest version is recommended.

Versioning

For transparency into the release cycle and in striving to maintain backward compatibility, Esri Leaflet is maintained under the Semantic Versioning guidelines and will adhere to these rules whenever possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major while resetting minor and patch
  • New additions without breaking backward compatibility bumps the minor while resetting the patch
  • Bug fixes and misc changes bumps only the patch

For more information on SemVer, please visit http://semver.org/.

Resources

Issues

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 that resolve common problems.

You can also post issues on GIS Stackexchange an/or the Esri Leaflet place on GeoNet.

Contributing

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

Credit

L.esri.Layers.DynamicMapLayer originally used code from https://github.com/sanborn/leaflet-ags/blob/master/src/AGS.Layer.Dynamic.js

Licensing

Copyright 2014 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.

[](Esri Tags: ArcGIS Web Mapping Leaflet) [](Esri Language: JavaScript)