Esri Leaflet Cluster

enables visualization of ArcGIS Feature Services as clusters using the L.MarkerCluster Leaflet Plugin.

Demos

A live demo is available on the Esri Leaflet website.

Example

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

<html>
<head>
  <meta charset=utf-8 />
  <title>Clustering points</title>
  <meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />

  <!-- Load Leaflet from CDN-->
  <link rel="stylesheet" href="https://unpkg.com/leaflet@1.1.0/dist/leaflet.css"
    integrity="sha512-wcw6ts8Anuw10Mzh9Ytw4pylW8+NAD4ch3lqm9lzAsTxg0GFeJgoAtxuCLREZSC5lUXdVyo/7yfsqFjQ4S+aKw=="
    crossorigin=""/>
  <script src="https://unpkg.com/leaflet@1.1.0/dist/leaflet.js"
    integrity="sha512-mNqn2Wg7tSToJhvHcqfzLMU6J4mkOImSPTxVZAdo+lcPlk+GhZmYgACEe0x35K7YzW1zJ7XyJV/TT1MrdXvMcA=="
    crossorigin=""></script>

  <!-- Load Esri Leaflet from CDN -->
  <script src="https://unpkg.com/esri-leaflet@2.1.0/dist/esri-leaflet.js"
    integrity="sha512-Tojl3UMd387f6DdAJlo+fKfJZiP55fYT+6Y58yKbHydnueOdSFOxrgLPuUxm7VW1szEt3hZVwv3V2sSUCuT35w=="
    crossorigin=""></script>

  <link rel="stylesheet" type="text/css" href="https://unpkg.com/leaflet.markercluster@1.0.4/dist/MarkerCluster.Default.css">
  <link rel="stylesheet" type="text/css" href="https://unpkg.com/leaflet.markercluster@1.0.4/dist/MarkerCluster.css">
  <script src="https://unpkg.com/leaflet.markercluster@1.0.4/dist/leaflet.markercluster.js"></script>

  <!-- Load Esri Leaflet Cluster from CDN -->
  <script src="https://unpkg.com/esri-leaflet-cluster"></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([45.526, -122.667], 6);

  L.esri.basemapLayer('Streets').addTo(map);
  L.esri.Cluster.featureLayer({
    url: 'https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0'
  }).addTo(map);
</script>

</body>
</html>

Documentation & Examples

A full API Reference and examples can be found on the Esri Leaflet website.

Development Instructions

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

Fork and clone Esri Leaflet Cluster
cd into the esri-leaflet-cluster folder
Install the package.json dependencies by running npm install
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.
Run npm test to make sure you haven't introduced a new 'feature' accidentally.
Make your changes and create a pull request

Dependencies

version 1.0.2 (available on CDN) can be used in apps alongside:
- Leaflet version 0.7.x.
- Esri Leaflet version 1.x
- Leaflet.markercluster version 0.4
version 2.0.0 (available on CDN) can be used in apps alongside:
- Leaflet version 1.x.
- Esri Leaflet version 2.x
- Leaflet.markercluster version 1.x

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 Esri Leaflet issues and previous Esri Leaflet Cluster issues that resolve common problems.

You can also post issues on the GIS Stack Exchange an/or the Esri Leaflet Community.

Contributing

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

Licensing

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.