Class: Cluster

ol/source/Cluster~Cluster 


import Cluster from 'ol/source/Cluster';

Layer source to cluster vector data. Works out of the box with point geometries. For other geometry types, or if not all geometries should be considered for clustering, a custom geometryFunction can be defined.

If the instance is disposed without also disposing the underlying source setSource(null) has to be called to remove the listener reference from the wrapped source.

new Cluster(options)

source/Cluster.js, line 70
Name Type Description
options

Cluster options.

Name Type Description
attributions module:ol/source/Source~AttributionLike

Attributions.
distance number (defaults to 20)

Distance in pixels within which features will be clustered together.
minDistance number (defaults to 0)

Minimum distance in pixels between clusters. Will be capped at the configured distance. By default no minimum distance is guaranteed. This config can be used to avoid overlapping icons. As a tradoff, the cluster feature's position will no longer be the center of all its features.
geometryFunction function

Function that takes an module:ol/Feature as argument and returns an module:ol/geom/Point as cluster calculation point for the feature. When a feature should not be considered for clustering, the function should return null. The default, which works when the underlying source contains point features only, is

function(feature) {
  return feature.getGeometry();
}

See module:ol/geom/Polygon~Polygon#getInteriorPoint for a way to get a cluster calculation point for polygons.
createCluster function

Function that takes the cluster's center module:ol/geom/Point and an array of module:ol/Feature included in this cluster. Must return a module:ol/Feature that will be used to render. Default implementation is:

function(point, features) {
  return new Feature({
    geometry: point,
    features: features
  });
}
source module:ol/source/Vector~VectorSource

Source.
wrapX boolean (defaults to true)

Whether to wrap the world horizontally.
Fires:

Extends

Methods

addFeature(feature) inherited

source/Vector.js, line 329

Add a single feature to the source. If you want to add a batch of features at once, call #addFeatures() instead. A feature will not be added to the source if feature with the same id is already there. The reason for this behavior is to avoid feature duplication when using bbox or tile loading strategies. Note: this also applies if an module:ol/Collection is used for features, meaning that if a feature with a duplicate id is added in the collection, it will be removed from it right away.

Name Type Description
feature module:ol/Feature~Feature.<Geometry>

Feature to add.

addFeatures(features) inherited

source/Vector.js, line 412

Add a batch of features to the source.

Name Type Description
features Array.<module:ol/Feature~Feature.<Geometry>>

Features to add.

changed() inherited

Observable.js, line 70

Increases the revision counter and dispatches a 'change' event.

clear(opt_fast)

source/Cluster.js, line 146

Remove all features from the source.

Name Type Description
fast boolean

Skip dispatching of module:ol/source/Vector.VectorSourceEvent#removefeature events.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

forEachFeature(callback){T|undefined} inherited

source/Vector.js, line 579

Iterate through all features on the source, calling the provided callback with each one. If the callback returns any "truthy" value, iteration will stop and the function will return the same value. Note: this function only iterate through the feature that have a defined geometry.

Name Type Description
callback function

Called with each feature on the source. Return a truthy value to stop iteration.
Returns:
The return value from the last call to the callback.

forEachFeatureInExtent(extent, callback){T|undefined} inherited

source/Vector.js, line 630

Iterate through all features whose bounding box intersects the provided extent (note that the feature's geometry may not intersect the extent), calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

If you are interested in features whose geometry intersects an extent, call the #forEachFeatureIntersectingExtent() method instead.

When useSpatialIndex is set to false, this method will loop through all features, equivalent to #forEachFeature().

Name Type Description
extent module:ol/extent~Extent

Extent.
callback function

Called with each feature whose bounding box intersects the provided extent.
Returns:
The return value from the last call to the callback.

forEachFeatureIntersectingExtent(extent, callback){T|undefined} inherited

source/Vector.js, line 653

Iterate through all features whose geometry intersects the provided extent, calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

If you only want to test for bounding box intersection, call the #forEachFeatureInExtent() method instead.

Name Type Description
extent module:ol/extent~Extent

Extent.
callback function

Called with each feature whose geometry intersects the provided extent.
Returns:
The return value from the last call to the callback.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){module:ol/source/Source~Attribution} inherited

source/Source.js, line 100

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 108
Returns:
Attributions are collapsible.

getClosestFeatureToCoordinate(coordinate, opt_filter){module:ol/Feature~Feature.<Geometry>} inherited

source/Vector.js, line 752

Get the closest feature to the provided coordinate.

This method is not available when the source is configured with useSpatialIndex set to false.

Name Type Description
coordinate module:ol/coordinate~Coordinate

Coordinate.
filter function

Feature filter function. The filter function will receive one argument, the feature and it should return a boolean value. By default, no filtering is made.
Returns:
Closest feature.

getDistance(){number}

source/Cluster.js, line 156

Get the distance in pixels between clusters.

Returns:
Distance.

getExtent(opt_extent){module:ol/extent~Extent} inherited

source/Vector.js, line 810

Get the extent of the features currently in the source.

This method is not available when the source is configured with useSpatialIndex set to false.

Name Type Description
extent module:ol/extent~Extent

Destination extent. If provided, no new extent will be created. Instead, that extent's coordinates will be overwritten.
Returns:
Extent.

getFeatureById(id){module:ol/Feature~Feature.<Geometry>} inherited

source/Vector.js, line 823

Get a feature by its identifier (the value returned by feature.getId()). Note that the index treats string and numeric identifiers as the same. So source.getFeatureById(2) will return a feature with id '2' or 2.

Name Type Description
id string | number

Feature identifier.
Returns:
The feature (or null if not found).

getFeatures(){Array.<module:ol/Feature~Feature.<Geometry>>} inherited

source/Vector.js, line 689

Get a snapshot of the features currently on the source in random order. The returned array is a copy, the features are references to the features in the source.

Returns:
Features.

getFeaturesAtCoordinate(coordinate){Array.<module:ol/Feature~Feature.<Geometry>>} inherited

source/Vector.js, line 710

Get all features whose geometry intersects the provided coordinate.

Name Type Description
coordinate module:ol/coordinate~Coordinate

Coordinate.
Returns:
Features.

getFeaturesCollection(){module:ol/Collection~Collection.<module:ol/Feature~Feature.<Geometry>>} inherited

source/Vector.js, line 679

Get the features collection associated with this source. Will be null unless the source was configured with useSpatialIndex set to false, or with an module:ol/Collection as features.

Returns:
The collection of features.

getFeaturesInExtent(extent){Array.<module:ol/Feature~Feature.<Geometry>>} inherited

source/Vector.js, line 730

Get all features whose bounding box intersects the provided extent. Note that this returns an array of all features intersecting the given extent in random order (so it may include features whose geometries do not intersect the extent).

When useSpatialIndex is set to false, this method will return all features.

Name Type Description
extent module:ol/extent~Extent

Extent.
Returns:
Features.

getFormat(){module:ol/format/Feature~FeatureFormat|undefined} inherited

source/Vector.js, line 845

Get the format associated with this source.

Returns:
The feature format.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getMinDistance(){number}

source/Cluster.js, line 206

The configured minimum distance between clusters.

Returns:
The minimum distance in pixels.

getProjection(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 117

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 81

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

getSource(){module:ol/source/Vector~VectorSource}

source/Cluster.js, line 165

Get a reference to the wrapped source.

Returns:
Source.

getState(){module:ol/source/State} inherited

source/Source.js, line 134

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:
State.

getUrl(){string|module:ol/featureloader~FeatureUrlFunction|undefined} inherited

source/Vector.js, line 862

Get the url associated with this source.

Returns:
The url.

hasFeature(feature){boolean} inherited

source/Vector.js, line 919

Returns true if the feature is contained within the source.

Name Type Description
feature module:ol/Feature~Feature.<Geometry>

Feature.
Returns:
Has feature.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 155

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 167

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

removeFeature(feature) inherited

source/Vector.js, line 1021

Remove a single feature from the source. If you want to remove all features at once, use the #clear() method instead.

Name Type Description
feature module:ol/Feature~Feature.<Geometry>

Feature to remove.

removeLoadedExtent(extent) inherited

source/Vector.js, line 1000

Remove an extent from the list of loaded extents.

Name Type Description
extent module:ol/extent~Extent

Extent.

set(key, value, opt_silent) inherited

Object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 167

Set the attributions of the source.

Name Type Description
attributions module:ol/source/Source~AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.

setDistance(distance)

source/Cluster.js, line 187

Set the distance within which features will be clusterd together.

Name Type Description
distance number

The distance in pixels.

setLoader(loader) inherited

source/Vector.js, line 1078

Set the new loader of the source. The next render cycle will use the new loader.

Name Type Description
loader module:ol/featureloader~FeatureLoader

The loader to set.

setMinDistance(minDistance)

source/Cluster.js, line 197

Set the minimum distance between clusters. Will be capped at the configured distance.

Name Type Description
minDistance number

The minimum distance in pixels.

setProperties(values, opt_silent) inherited

Object.js, line 223

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean

Update without triggering an event.

setSource(source)

source/Cluster.js, line 215

Replace the wrapped source.

Name Type Description
source module:ol/source/Vector~VectorSource

The new source for this instance.

setUrl(url) inherited

source/Vector.js, line 1087

Points the source to a new url. The next render cycle will use the new url.

Name Type Description
url string | module:ol/featureloader~FeatureUrlFunction

Url.

un(type, listener) inherited

Observable.js, line 176

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 247

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.