Clusterer
A class that provides markers clustering functionality.
new constructor
(map, userOptions)Example:
const clusterer = new mapgl.Clusterer(map, {
radius: 60
});
Parameters
Methods
A class that provides markers clustering functionality.
(map, userOptions)Example:
const clusterer = new mapgl.Clusterer(map, {
radius: 60
});
()Destroys the clusterer.
void(type, data?)Calls all event listeners with event type type
typeKEvent type
data?ClustererEventTable[K]Data transferred to events
this(clusterId)Returns the zoom at which the cluster expands into markers.
clusterIdnumberCluster identifier. Can be obtained from cluster mouse events in ClusterTarget.
any(input)Loads markers to clusterer.
inputInputMarker[]An array of markers.
void(type, listener)Removes event listener registered with on
typeKEvent type
listener(ev: ClustererEventTable[K]) => voidEvent handler
this(type, listener)Registers event listener
typeKEvent type
listener(ev: ClustererEventTable[K]) => voidEvent handler
this(type, listener)Registers event listener which will be called once
typeKEvent type
listener(ev: ClustererEventTable[K]) => voidEvent handler
this(clusterId)Resets the cluster style by its ID to to the one set in the options.
clusterIdnumberCluster identifier. The same parameter as in setClusterStyle method.
void(clusterId, clusterStyle)Changes the cluster style by its ID
clusterIdnumberCluster identifier. Can be obtained from cluster mouse events in ClusterTarget.
clusterStyle(pointsCount: number, target: ClusterTarget) => ClusterStyleClusterStyleAn object or a function that returns style for the cluster.
void