Class: Cluster

ol.source.Cluster

new ol.source.Cluster(options) experimental

Name Type Description
options
Name Type Description
attributions Array.<ol.Attribution> | undefined experimental

Attributions.

distance number | undefined experimental

Minimum distance in pixels between clusters. Default is 20.

extent ol.Extent | undefined experimental

Extent.

format ol.format.Feature | undefined experimental

Format.

logo string | undefined experimental

Logo.

projection ol.proj.ProjectionLike experimental

Projection.

source ol.source.Vector experimental

Source.

Fires:

Extends

Methods

Name Type Description
feature ol.Feature

Feature.

Name Type Description
features Array.<ol.Feature>

Features.

Remove all features.

dispatchChangeEvent() inherited experimental

Dispatches a change event.

Fires:
  • change experimental

forEachFeature(f, opt_this){S|undefined} inherited

Name Type Description
f function

Callback.

this T

The object to use as this in f.

forEachFeatureInExtent(extent, f, opt_this){S|undefined} inherited experimental

Name Type Description
extent ol.Extent

Extent.

f function

Callback.

this T

The object to use as this in f.

Returns:
Attributions.

getClosestFeatureToCoordinate(coordinate){ol.Feature} inherited

Name Type Description
coordinate ol.Coordinate

Coordinate.

Returns:
Closest feature.

Get the extent of the features currently in the source.

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' or 2.

Name Type Description
id string | number

Feature identifier.

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

getFeaturesAtCoordinate(coordinate){Array.<ol.Feature>} inherited

Name Type Description
coordinate ol.Coordinate

Coordinate.

Returns:
Features.
Returns:
Logo.
Returns:
Projection.

getRevision(){number} inherited experimental

Returns:
Revision.
Returns:
State.

on(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.
Name Type Description
feature ol.Feature

Feature.

un(type, listener, opt_this) inherited

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.

this Object

The object which was used as this by the listener.

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.