esri-leaflet
Advanced tools
Leaflet plugins for ArcGIS Services. Currently Esri Leaflet supports loading Esri basemaps and feature services, as well as tiled map, dynamic map and image 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.
We've written loads of demos showing many of the features of Esri Leaflet.
Here is a quick example to get you started. Just copy/paste into your own .html file and run.
<!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>
<!-- we encourage you to replace 'latest' with a hardcode version number (like '1.0.0-rc.7') in production applications -->
<script src="//cdn.jsdelivr.net/leaflet.esri/latest/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>
A full API Reference and plenty of sample code can be found at the Esri Leaflet website.
If you are interested in contributing to Esri Leaflet or seeing what is coming up next check out the development roadmap.
Find a bug or want to request a new feature? Please let us know by submitting an issue.
Please take a look at previously logged issues that resolve common problems.
You can also post issues on GIS Stackexchange an/or the Esri Leaflet place on GeoNet.
Feel free to add your own project to this list!
In order to compile the API yourself and/or run the tests, make sure you have the Grunt CLI installed.
cd into the esri-leaflet foldernpm installgrunt 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.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:
For more information on SemVer, please visit http://semver.org/.
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
L.esri.Layers.DynamicMapLayer originally used code from https://github.com/sanborn/leaflet-ags/blob/master/src/AGS.Layer.Dynamic.jsL.esri.Layers.TiledMapLayer adapts some code from https://github.com/gisinc/arcgis-level-fixerCopyright 2015 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.
[](Esri Tags: ArcGIS Web Mapping Leaflet) [](Esri Language: JavaScript)
[1.0.0]
This represents the stable release of Esri Leaflet compatible with Leaflet 0.7.3. All future 1.0.X releases will be compatible with Leaflet 0.7.3 and contain only bug fixes. New features will only be added in Esri Leaflet 2.0.0 which will require Leaflet 1.0.0.
As this is a major release there are a number of breaking changes.
Also see the Esri Leaflet 1.0 announcement.
L.esri.Services.FeatureLayer has been renamed to L.esri.Services.FeatureLayerService. It should be initialized with L.esri.Services.featureLayerService(options).url in their options. E.x. L.esri.featureLayer(url) should now L.esri.featureLayer({url: url}}). This does not affect L.esri.baseMapLayer which still accepts the key as it's first parameter.error.authenticate(newToken) as opposed to listening to authenticationrequired event and calling e.target.authenticate(newToken). This means that your callbacks may be called multiple times, once with an authentication failure and once with an authentication success. To avoid any side affects of this you should return as early as possible after handling errors. It is recommended you adapt techniques from http://blog.timoxley.com/post/47041269194/avoid-else-return-early to handle these cases.L.esri.Services.service({
url: "http://logistics.arcgis.com/arcgis/rest/services/World/ServiceAreas/GPServer/GenerateServiceAreas",
token: "badtoken",
}).metadata(function (error, response) {
if (error && error.authenticate) {
// handle an authentication error, returning to stop execution of the rest of the function
error.authenticate("good token");
return;
}
if (error) {
// handle any other errors, returning to stop execution of the rest of the function
return;
}
// if you get here you are successful!
console.log(metadata);
});
dynamicLayers option to L.esri.DynamicMapLayer https://github.com/Esri/esri-leaflet/issues/566bringToBack and bringToFront to L.esri.FeatureLayer https://github.com/Esri/esri-leaflet/issues/479load event on L.esri.FeatureLayer now fires at the proper time https://github.com/Esri/esri-leaflet/issues/545L.esri.DynamicMapLayer and L.esri.ImageMapLayer will now automatically use POST for large requests. https://github.com/Esri/esri-leaflet/issues/574L.esri.ImageMapLayer now defaults to requesting json as opposed to an image to better handle authentication and large requests https://github.com/Esri/esri-leaflet/issues/574. If your Image Service does not support CORS you should set {f:'image'} in your options.load event is now fired after all features are created, rather than when they are all received from the server https://github.com/Esri/esri-leaflet/issues/545L.CircleMarker with L.esri.Layers.FeatureLayer https://github.com/Esri/esri-leaflet/issues/534redraw method on L.esri.Layers.FeatureLayer for programmatically redrawing features with their latest symbology. https://github.com/Esri/esri-leaflet/pull/550json by default to better expose the authentication process. If you are using ArcGIS Server 10.0 or have disabled CORS on your server you will need to add useCors: false to your options.FeatureLayer.resetStyle() behavior. https://github.com/Esri/esri-leaflet/issues/488DynamicMapLayer image loading logic. https://github.com/Esri/esri-leaflet/issues/498alt tag to the Esri logo https://github.com/Esri/esri-leaflet/issues/490identifyFeatures.run() doesn't return any results. https://github.com/Esri/esri-leaflet/issues/512deleteFeatures() method to both L.esri.Layers.FeatureLayer and L.esri.Services.FeatureLayer for dropping records in bulk. https://github.com/Esri/esri-leaflet/pull/510L.esri.FeatureLayer. https://github.com/Esri/esri-leaflet/issues/320 and https://github.com/Esri/esri-leaflet/pull/518json by default to better expose authentication helpersNone
f:'json' will now be used automatically when a proxy is set for L.esri.DynamicMapLayer. https://github.com/Esri/esri-leaflet/issues/464identify() and L.esri.Tasks.Identify. https://github.com/Esri/esri-leaflet/issues/443Task and Service constructors now accept url as a value within options, rather than as a separate parameter. #420url string to be supplied as the first parameter, but afterwards, the property is now accessible via Layer.options.url instead of Layer.urlminZoom, maxZoom, #413 and cacheLayers were added as new FeatureLayer constructor optionsL.esri.Controls.Logo #383L.esri.TiledMapLayer now accepts a token option for secured tiles. #384DynamicMapLayer still rendering after being removed from the map. #386L.esri.Tasks.Find #379bower install esri-leaflet now works properly.contains, overlaps and intersects to L.esri.Tasks.Query.L.esri.Tasks.Query can now accept the following Leaflet types, L.Marker, L.Polygon, L.Polyline, L.LatLng, L.LatLngBounds and L.GeoJSON. It can also accept valid GeoJSON Point, Polyline, Polygon and GeoJSON Feature objects containing Point, Polyline, Polygon.L.LatLng and L.LatLngBounds now accept the simple [lat,lng] or [[lat,lng], [lat,lng]] forms.L.esri.Task now accepts proxy and useCors like L.esri.Service. https://github.com/Esri/esri-leaflet/pull/359L.esri.ClusteredFeatureLayer has been moved to its own repository. https://github.com/Esri/esri-leaflet-clustered-feature-layerL.esri.HeatmapFeatureLayer has been moved to its own repository. https://github.com/Esri/esri-leaflet-heatmap-feature-layerpopupOptions are now properly persevered https://github.com/Esri/esri-leaflet/pull/348setStyle now permanently overrides the style in options.style. https://github.com/Esri/esri-leaflet/pull/349setWhere and setTimeRange now take callbacks. https://github.com/Esri/esri-leaflet/pull/354XMLHttpRequest. https://github.com/Esri/esri-leaflet/pull/354returnGeometry can now be set on L.esri.Tasks.Query. https://github.com/Esri/esri-leaflet/pull/358run or bounds) now return an instance of XMLHttpRequest as opposed to the task or service.bindPopup on L.esri.DynamicMapLayer now identifies only visible features by default rather then all features.where clauses or long lists of IDs) you may need to setup an instance of https://github.com/Esri/resource-proxy and use the proxy option.L.esri.Tasks.Identify has been renamed to L.esri.Tasks.IdentifyFeatures. This is to reduce confusion with L.esri.Tasks.IdentifyImage and to clearly delineate what these 2 classes do.logoPosition option on L.esri.BasemapLayer https://github.com/Esri/esri-leaflet/issues/210L.esri.Controls.Logo class. If you use Esri map tiles you must display the Esri Logo!addFeature, removeFeature, updateFeature methods will no longer throw errors when callbacks are omitted. https://github.com/Esri/esri-leaflet/issues/285deleteFeature now properly removes the feature from the map so it will now appear after zooming or panning. https://github.com/Esri/esri-leaflet/issues/284createfeature, addfeature and removefeature events on L.esri.FeatureLayer. https://github.com/Esri/esri-leaflet/issues/282L.esri.Tasks.Query now supports Map Services and Image Services with the new query.layer(id) and query.pixelSize(point) params respectivelyL.esri.Tasks.Find task for searching feature text in Map Services https://github.com/Esri/esri-leaflet/pull/287. Thanks @rdjurasaj-usgs!L.esri.Layers.ImageMapLayer. Thanks @rdjurasaj-usgs and @tomwaysonL.esri.Tasks.IdentifyImage for identifying images. Thanks @tomwayson./dist folder. https://github.com/Esri/esri-leaflet/pull/307Oceans no longer contains map labels, labels have been added as another key OceansLabels.L.esri.FeatureLayer no longer inherits from L.GeoJSON and as a result no longer has getBounds, bringToBack or bringToFront or addData methods.L.GeoJSON.L.esri.Util namespace please check that they exist.metadata event. They now have a metadata method that can be used to get layer metadata. If you need to convert extents into L.LatLngBounds you can use L.esri.Util.extentToBounds.L.esri.DynamicMapLayer no longer inherits from L.ImageOverlay as a result the setUrl method no longer exists.cluster object to L.esri.ClusteredFeatureLayer, instead pass any options you want to pass to L.MarkerClusterGroup directly to L.esri.ClusteredFeatureLayer.layerDefs option on L.esri.DynamicMapLayer. Layer definitions should now be passed as an object like {'0':'STATE_NAME='Kansas' and POP2007>25000'}layers option on L.esri.DynamicMapLayer you can now only pass an array of layer ids that will be shown like [0,1,2].createMarker method on L.esri.ClusteredFeatureLayer has been renamed to pointToLayer.OceansLabels to L.esri.BasemapLayer.Oceans has switched to the new Ocean basemap with out labels.L.esri.FeatureLayer has been refactored into several classes. L.esri.FeatureGrid and L.esri.FeatureManager now handle loading and querying features from the service.L.esri.ClusteredFeatureLayer and L.esri.HeatMapFeatureLayer now inherit from L.esri.FeatureManager so they share many new methods and options.L.esri.FeatureLayer, L.esri.ClusteredFeatureLayer and L.esri.HeatMapFeatureLayer now support time enabled service via from, to, timeFields and timeFilterMode options and setTimeRange(from, to) and getTimeRange() methods.L.esri.FeatureLayer, L.esri.ClusteredFeatureLayer and L.esri.HeatMapFeatureLayer now support where options and have new methods for setWhere() and getWhere() to perform filtering.L.esri.FeatureLayer now supports generalizing polygon and polyline features on the service side for performance using the new simplifyFactor option.L.esri.BasemapLayer is added to maps without an attribution control. If you do not add attribution you must handle adding attribution your self to the map.L.esri.Util.geojsonBounds as it was only being used to create bounds and envelopes for rbush.bindPopup method to L.esri.DynamicMapLayer.getTimeRange and setTimeRange methods L.esri.DynamicMapLayer.L.esri.Services namespace to handle generic abstraction of interacting with ArcGIS Online and ArcGIS server services.L.esri.Services.Service base class that can be used for interacting with any service. All L.esri.Layers classes now uses L.esri.Services.Service internally for their API requests. This class also abstracts authentication and proxying.L.esri.Services.FeatureLayer class for interacting with the Feature Layer API.L.esri.Services.MapService class for interacting with the Map Server API.L.esri.Tasks namespace for tasks that map to individual API methods.L.esri.Tasks.Query class for interacting with the Feature Layer query API.L.esri.Tasks.Identify class for interacting with Map Servers that support identify.authenticationrequired event when they encounter a need for a token. Thanks to @aaronpk for the Oauth demos. #139FAQs
Leaflet plugins for consuming ArcGIS Online and ArcGIS Server services.
The npm package esri-leaflet receives a total of 36,511 weekly downloads. As such, esri-leaflet popularity was classified as popular.
We found that esri-leaflet demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.