Clusterer

A class that provides markers clustering functionality.

Extends: EventedEventedClustererEventTable

new constructor(map, userOptions)

Example:

const clusterer = new mapgl.Clusterer(map, {
    radius: 60
});

Parameters

map

mapgl.Map

The map instance.

userOptions

ClustererOptions

Clusterer initialization options.

Returns

Clusterer

Methods

destroy()

Destroys the clusterer.

Returns

void

emit(type, data?)

Calls all event listeners with event type type

Parameters

type

K

Event type

data?

ClustererEventTable[K]

Data transferred to events

Returns

this

getClusterExpansionZoom(clusterId)

Returns the zoom at which the cluster expands into markers.

Parameters

clusterId

number

Cluster identifier. Can be obtained from cluster mouse events in ClusterTarget.

Returns

number

load(input)

Loads markers to clusterer.

Parameters

input

InputMarker[]

An array of markers.

Returns

void

off(type, listener)

Removes event listener registered with on

Parameters

type

K

Event type

listener

(ev: ClustererEventTable[K]) => void

Event handler

Returns

this

on(type, listener)

Registers event listener

Parameters

type

K

Event type

listener

(ev: ClustererEventTable[K]) => void

Event handler

Returns

this

once(type, listener)

Registers event listener which will be called once

Parameters

type

K

Event type

listener

(ev: ClustererEventTable[K]) => void

Event handler

Returns

this

resetClusterStyle(clusterId)

Resets the cluster style by its ID to to the one set in the options.

Parameters

clusterId

number

Cluster identifier. The same parameter as in setClusterStyle method.

Returns

void

setClusterStyle(clusterId, clusterStyle)

Changes the cluster style by its ID

Parameters

clusterId

number

Cluster identifier. Can be obtained from cluster mouse events in ClusterTarget.

clusterStyle

(pointsCount: number, target: ClusterTarget) => ClusterStyleClusterStyle

An object or a function that returns style for the cluster.

Returns

void