https://github.com/maptalks/maptalks.markercluster
A layer of maptalks to cluster markers.
https://github.com/maptalks/maptalks.markercluster
clustered-markers map mapping maptalks maptalks-layer maptalks-plugins
Last synced: about 1 year ago
JSON representation
A layer of maptalks to cluster markers.
- Host: GitHub
- URL: https://github.com/maptalks/maptalks.markercluster
- Owner: maptalks
- License: mit
- Created: 2016-06-27T09:32:10.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-17T02:58:53.000Z (about 2 years ago)
- Last Synced: 2024-12-12T14:12:02.366Z (over 1 year ago)
- Topics: clustered-markers, map, mapping, maptalks, maptalks-layer, maptalks-plugins
- Language: JavaScript
- Homepage:
- Size: 962 KB
- Stars: 49
- Watchers: 9
- Forks: 18
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# maptalks.markercluster
[](https://circleci.com/gh/MapTalks/maptalks.markercluster)
[](https://github.com/maptalks/maptalks.markercluster)
A plugin of [maptalks.js](https://github.com/maptalks/maptalks.js) to draw markers as clusters.
## Examples
* marker clusters of [50000 points](https://maptalks.github.io/maptalks.markercluster/demo/). (data from [Leaflet.Heat](https://github.com/Leaflet/Leaflet.heat))
## Install
* Install with npm: ```npm install maptalks.markercluster```.
* Download from [dist directory](https://github.com/maptalks/maptalks.markercluster/tree/gh-pages/dist).
* Use unpkg CDN: ```https://unpkg.com/maptalks.markercluster/dist/maptalks.markercluster.min.js```
## Usage
As a plugin, ```maptalks.markercluster``` must be loaded after ```maptalks.js``` in browsers.
```html
var data = [marker1, marker2, marker3];
var clusterLayer = new maptalks.ClusterLayer('cluster', data).addTo(map);
```
## Supported Browsers
IE 9-11, Chrome, Firefox, other modern and mobile browsers.
## API Reference
```ClusterLayer``` is a subclass of [maptalks.VectorLayer](https://maptalks.github.io/docs/api/VectorLayer.html) and inherits all the methods of its parent.
### `Constructor`
```javascript
new maptalks.ClusterLayer(id, data, options)
```
* id **String** layer id
* data **Marker[]** layer data, an array of maptalks.Marker
* options **Object** options
* maxClusterRadius **Number** max cluster radius (160 by default)
* symbol **Object** symbol of clusters
* textSymbol **Object** symbol of cluster texts
* drawClusterText **Boolean** whether to draw cluster texts (true by default)
* textSumProperty **String** property name to sum up to display as the cluster text
* maxClusterZoom **Number** the max zoom to draw as clusters (null by default)
* animation **Boolean** whether animate the clusters when zooming (true by default)
* animationDuration **Number** the animation duration
* noClusterWithOneMarker **Boolean** whether display cluster with only one marker (false by default)
* Other options defined in [maptalks.VectorLayer](https://maptalks.org/maptalks.js/api/0.x/VectorLayer.html)
### `config(key, value)`
config layer's options and redraw the layer if necessary
```javascript
clusterLayer.config('maxClusterRadius', 100);
clusterLayer.config({
'textSymbol' : {
'textFaceName' : 'monospace',
'textSize' : 16
}
});
```
**Returns** `this`
### `addMarker(marker)`
add more markers
* marker **Marker[]** markers to add
**Returns** `this`
### `toJSON()`
export the layer's JSON.
```javascript
var json = clusterLayer.toJSON();
```
**Returns** `Object`
## Contributing
We welcome any kind of contributions including issue reportings, pull requests, documentation corrections, feature requests and any other helps.
## Develop
The only source file is ```index.js```.
It is written in ES6, transpiled by [babel](https://babeljs.io/) and tested with [mocha](https://mochajs.org) and [expect.js](https://github.com/Automattic/expect.js).
### Scripts
* Install dependencies
```shell
$ npm install
```
* Watch source changes and generate runnable bundle repeatedly
```shell
$ gulp watch
```
* Tests
```shell
$ npm test
```
* Watch source changes and run tests repeatedly
```shell
$ gulp tdd
```
* Package and generate minified bundles to dist directory
```shell
$ gulp minify
```
* Lint
```shell
$ npm run lint
```