new Cluster(options)
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Cluster options.
|
Fires:
-
addfeature
(module:ol/source/Vector.VectorSourceEvent) - Triggered when a feature is added to the source. -
change
(module:ol/events/Event~BaseEvent) - Generic change event. Triggered when the revision counter is increased. -
changefeature
(module:ol/source/Vector.VectorSourceEvent) - Triggered when a feature is updated. -
clear
(module:ol/source/Vector.VectorSourceEvent) - Triggered when the clear method is called on the source. -
error
(module:ol/events/Event~BaseEvent) - Generic error event. Triggered when an error occurs. -
propertychange
(module:ol/Object.ObjectEvent) - Triggered when a property is changed. -
removefeature
(module:ol/source/Vector.VectorSourceEvent) - Triggered when a feature is removed from the source. Seesource.clear()
for exceptions.
Extends
Methods
-
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 anmodule: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.
-
Add a batch of features to the source.
Name Type Description features
Array.<module:ol/Feature~Feature.<Geometry>> Features to add.
-
Increases the revision counter and dispatches a 'change' event.
-
Remove all features from the source.
Name Type Description fast
boolean Skip dispatching of
module:ol/source/Vector.VectorSourceEvent#removefeature
events. -
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
Object | 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.
-
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.
-
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 607 -
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.
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getClosestFeatureToCoordinate(coordinate, opt_filter){module:ol/Feature~Feature.<Geometry>} inherited
source/Vector.js, line 708 -
Get the closest feature to the provided coordinate.
This method is not available when the source is configured with
useSpatialIndex
set tofalse
.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 98 -
Get the distance in pixels between clusters.
Returns:
Distance.
-
Get the extent of the features currently in the source.
This method is not available when the source is configured with
useSpatialIndex
set tofalse
.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.
-
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'
or2
.Name Type Description id
string | number Feature identifier.
Returns:
The feature (ornull
if not found).
-
Get all features on the source in random order.
Returns:
Features.
-
getFeaturesAtCoordinate(coordinate){Array.<module:ol/Feature~Feature.<Geometry>>} inherited
source/Vector.js, line 664 -
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 632 -
Get the features collection associated with this source. Will be
null
unless the source was configured withuseSpatialIndex
set tofalse
, or with anmodule:ol/Collection
asfeatures
.Returns:
The collection of features.
-
getFeaturesInExtent(extent){Array.<module:ol/Feature~Feature.<Geometry>>} inherited
source/Vector.js, line 685 -
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.
-
Get the format associated with this source.
Returns:
The feature format.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the projection of the source.
Returns:
Projection.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
Get a reference to the wrapped source.
Returns:
Source.
-
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 818 -
Get the url associated with this source.
Returns:
The url.
-
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 60 -
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 82 -
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.
-
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.
-
Remove an extent from the list of loaded extents.
Name Type Description extent
module:ol/extent~Extent Extent.
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
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
, orundefined
. -
setDistance(distance)
source/Cluster.js, line 129 -
Set the distance in pixels between clusters.
Name Type Description distance
number The distance in pixels.
-
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.
-
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.
-
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.
-
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.
-
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.