[WebGIS之Leaflet全面解析][郭明强][配套资料]

Leaflet.markercluster ===================== Provides Beautiful Animated Marker Clustering functionality for [Leaflet](http://leafletjs.com), a JS library for interactive maps. *Requires Leaflet 1.0.0*  For a Leaflet 0.7 compatible version, [use the leaflet-0.7 branch](https://github.com/Leaflet/Leaflet.markercluster/tree/leaflet-0.7)<br> For a Leaflet 0.5 compatible version, [Download b128e950](https://github.com/Leaflet/Leaflet.markercluster/archive/b128e950d8f5d7da5b60bd0aa9a88f6d3dd17c98.zip)<br> For a Leaflet 0.4 compatible version, [Download the 0.2 release](https://github.com/Leaflet/Leaflet.markercluster/archive/0.2.zip) <!--- TOC created with gh-md-toc https://github.com/ekalinin/github-markdown-toc removed link to h1 and indented back 2 spaces all links. --> ## Table of Contents * [Using the plugin](#using-the-plugin) * [Building, testing and linting scripts](#building-testing-and-linting-scripts) * [Examples](#examples) * [Usage](#usage) * [Options](#options) * [Defaults](#defaults) * [Customising the Clustered Markers](#customising-the-clustered-markers) * [All Options](#all-options) * [Enabled by default (boolean options)](#enabled-by-default-boolean-options) * [Other options](#other-options) * [Chunked addLayers options](#chunked-addlayers-options) * [Events](#events) * [Additional MarkerClusterGroup Events](#additional-markerclustergroup-events) * [Methods](#methods) * [Group methods](#group-methods) * [Adding and removing Markers](#adding-and-removing-markers) * [Bulk adding and removing Markers](#bulk-adding-and-removing-markers) * [Getting the visible parent of a marker](#getting-the-visible-parent-of-a-marker) * [Refreshing the clusters icon](#refreshing-the-clusters-icon) * [Other Group Methods](#other-group-methods) * [Clusters methods](#clusters-methods) * [Getting the bounds of a cluster](#getting-the-bounds-of-a-cluster) * [Zooming to the bounds of a cluster](#zooming-to-the-bounds-of-a-cluster) * [Other clusters methods](#other-clusters-methods) * [Handling LOTS of markers](#handling-lots-of-markers) * [License](#license) * [Sub-plugins](#sub-plugins) ## Using the plugin Include the plugin CSS and JS files on your page after Leaflet files, using your method of choice: * [Download the `v1.3.0` release](https://github.com/Leaflet/Leaflet.markercluster/archive/v1.3.0.zip) * Use unpkg CDN: `https://unpkg.com/leaflet.markercluster@1.3.0/dist/` * Install with npm: `npm install leaflet.markercluster` In each case, use files in the `dist` folder: * `MarkerCluster.css` * `MarkerCluster.Default.css` (not needed if you use your own `iconCreateFunction` instead of the default one) * `leaflet.markercluster.js` (or `leaflet.markercluster-src.js` for the non-minified version) ### Building, testing and linting scripts Install jake `npm install -g jake` then run `npm install` * To check the code for errors and build Leaflet from source, run `jake`. * To run the tests, run `jake test`. ### Examples See the included examples for usage. The [realworld example](https://leaflet.github.io/Leaflet.markercluster/example/marker-clustering-realworld.388.html) is a good place to start, it uses all of the defaults of the clusterer. Or check out the [custom example](https://leaflet.github.io/Leaflet.markercluster/example/marker-clustering-custom.html) for how to customise the behaviour and appearance of the clusterer ### Usage Create a new MarkerClusterGroup, add your markers to it, then add it to the map ```javascript var markers = L.markerClusterGroup(); markers.addLayer(L.marker(getRandomLatLng(map))); ... Add more layers ... map.addLayer(markers); ``` ## Options ### Defaults By default the Clusterer enables some nice defaults for you: * **showCoverageOnHover**: When you mouse over a cluster it shows the bounds of its markers. * **zoomToBoundsOnClick**: When you click a cluster we zoom to its bounds. * **spiderfyOnMaxZoom**: When you click a cluster at the bottom zoom level we spiderfy it so you can see all of its markers. (*Note: the spiderfy occurs at the current zoom level if all items within the cluster are still clustered at the maximum zoom level or at zoom specified by `disableClusteringAtZoom` option*) * **removeOutsideVisibleBounds**: Clusters and markers too far from the viewport are removed from the map for performance. * **spiderLegPolylineOptions**: Allows you to specify [PolylineOptions](http://leafletjs.com/reference.html#polyline-options) to style spider legs. By default, they are `{ weight: 1.5, color: '#222', opacity: 0.5 }`. You can disable any of these as you want in the options when you create the MarkerClusterGroup: ```javascript var markers = L.markerClusterGroup({ spiderfyOnMaxZoom: false, showCoverageOnHover: false, zoomToBoundsOnClick: false }); ``` ### Customising the Clustered Markers As an option to MarkerClusterGroup you can provide your own function for creating the Icon for the clustered markers. The default implementation changes color at bounds of 10 and 100, but more advanced uses may require customising this. You do not need to include the .Default css if you go this way. You are passed a MarkerCluster object, you'll probably want to use `getChildCount()` or `getAllChildMarkers()` to work out the icon to show. ```javascript var markers = L.markerClusterGroup({ iconCreateFunction: function(cluster) { return L.divIcon({ html: '<b>' + cluster.getChildCount() + '</b>' }); } }); ``` Check out the [custom example](https://leaflet.github.io/Leaflet.markercluster/example/marker-clustering-custom.html) for an example of this. If you need to update the clusters icon (e.g. they are based on markers real-time data), use the method [refreshClusters()](#refreshing-the-clusters-icon). ### All Options #### Enabled by default (boolean options) * **showCoverageOnHover**: When you mouse over a cluster it shows the bounds of its markers. * **zoomToBoundsOnClick**: When you click a cluster we zoom to its bounds. * **spiderfyOnMaxZoom**: When you click a cluster at the bottom zoom level we spiderfy it so you can see all of its markers. (*Note: the spiderfy occurs at the current zoom level if all items within the cluster are still clustered at the maximum zoom level or at zoom specified by `disableClusteringAtZoom` option*). * **removeOutsideVisibleBounds**: Clusters and markers too far from the viewport are removed from the map for performance. * **animate**: Smoothly split / merge cluster children when zooming and spiderfying. If `L.DomUtil.TRANSITION` is false, this option has no effect (no animation is possible). #### Other options * **animateAddingMarkers**: If set to true (and `animate` option is also true) then adding individual markers to the MarkerClusterGroup after it has been added to the map will add the marker and animate it into the cluster. Defaults to false as this gives better performance when bulk adding markers. addLayers does not support this, only addLayer with individual Markers. * **disableClusteringAtZoom**: If set, at this zoom level and below, markers will not be clustered. This defaults to disabled. [See Example](https://leaflet.github.io/Leaflet.markercluster/example/marker-clustering-realworld-maxzoom.388.html). Note: you may be interested in disabling `spiderfyOnMaxZoom` option when using `disableClusteringAtZoom`. * **maxClusterRadius**: The maximum radius that a cluster will cover from the central marker (in pixels). Default 80. Decreasing will make more, smaller clusters. You can also use a function that accepts the current map zoom and returns the maximum cluster radius in pixels. * **polygonOptions**: Options to pass when creating the L.Polygon(points, options) to show the bounds of a cluster. Defaults to empty, which lets Leaflet use the [default Path options](http://leafletjs.com/reference.html#path-options). * **singleMarke