Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

esri-leaflet-cluster

Esri27.7kApache-2.03.0.1

Esri Leaflet plugin for visualizing Feature Layers as clusters with L.markercluster.

arcgis, esri, esri leaflet, gis, leaflet plugin, mapping

readme

Esri Leaflet Cluster

npm version apache licensed

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.

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

  1. Fork and clone Esri Leaflet Cluster
  2. cd into the esri-leaflet-cluster 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

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

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

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.

changelog

Changelog

Unreleased

3.0.1 - 2023-02-23

Fixed

  • Popup/tooltip issue (#65)

Changed

  • Package maintenance - updated dependencies, unit testing, etc. (#63)

3.0.0 - 2022-02-25

Breaking Changes

  • Leaflet, Esri Leaflet, and leaflet.markercluster are now peerDependencies so that consumers can install whichever version they want.

Fixed

Changed

  • Updated dependencies (#51)

2.1.0 - 2020-06-22

Changed

  • Updated dependencies (#33)
  • port createNewLayer from L.esri.featureLayer for renderer plugin (#31)

2.0.1

Changed

  • Updated dependencies (#20)

2.0.0

Breaking Changes

  • Namespace change (L.esri.Cluster.clusteredFeatureLayer is now L.esri.Cluster.featureLayer )
  • repository and npm package have been renamed esri-leaflet-clustered-feature-layer for brevity's sake

Added

  • The build system has been refactored to use latest Rollup and Rollup plugins.
  • Reworked bundling directives for various modules systems to resolve and simplify various issues
    • WebPack users no longer have to use the Babel loader.
    • Babelify with Babel 6 now works

Removed

  • bindPopup and unbindPopup logic have been removed from this plugin. Equivalent functionality is available via L.Layer in Leaflet itself.
clusterLayer.bindPopup(function (layer) {
  return "attribute value is: " + layer.feature.properties.ATTRIBUTENAME;
});

2.0.0-beta.1

Breaking Changes

  • Namespace change (L.esri.clusteredFeatureLayer is now L.esri.Cluster.clusteredFeatureLayer )
  • Requires the 2.0.0-beta.6 release of Esri Leaflet.
  • Requires the 1.0.0-beta.2 release of Leaflet.

Added

  • Better build/test/release automation.
  • Support for JSPM in package.json. Now you can import cluster from 'esri-leaflet-clustered-feature-layer/src/ClusteredFeatureLayer'; for more compact builds but, be aware of caveats
  • Support for browserify in the package.json. Now you can var cluster = require('esri-leaflet-clustered-feature-layer/src/ClusteredFeatureLayer'); for more compact builds, but be aware of caveats

1.0.2

Fixed

  • Fix build system error. Ensure that tag contains built files.

1.0.0

Changed

Release Candidate 4

Changed

  • bower install esri-leaflet-clustered-feature-layer should now work without bower cache clean
  • Update Esri Leaflet dependency to RC 4

Release Candidate 3

Changed

  • fixed bower install esri-leaflet-clustered-feature-layer
  • Update Esri Leaflet dependency to RC 3

Release Candidate 2

Release Candidate 1