Class MarkerClusterer

MarkerClusterer creates and manages per-zoom-level clusters for large amounts of markers. See MarkerClustererOptions for more details.

Hierarchy

OverlayViewSafe
- MarkerClusterer

Index

Constructors

Properties

algorithm clusters idleListener map markers onClusterClick renderer

Methods

addMarker addMarkers clearMarkers onAdd onRemove removeMarker removeMarkers render renderClusters reset

Constructors

constructor

new MarkerClusterer(__namedParameters): MarkerClusterer
Parameters
- __namedParameters: MarkerClustererOptions
Returns MarkerClusterer
Overrides OverlayViewSafe.constructor
- Defined in markerclusterer.ts:81

Properties

`Protected` algorithm

algorithm: Algorithm

See

MarkerClustererOptions.algorithm

`Protected` clusters

clusters: Cluster[]

`Protected` idleListener

idleListener: MapsEventListener

`Protected` map

map: Map

See

MarkerClustererOptions.map

`Protected` markers

markers: Marker[]

onClusterClick

onClusterClick: onClusterClickHandler

See

MarkerClustererOptions.onClusterClick

`Protected` renderer

renderer: Renderer

See

MarkerClustererOptions.renderer

Methods

addMarker

addMarker(marker, noDraw?): void
Parameters
- marker: Marker
- Optional noDraw: boolean
Returns void
- Defined in markerclusterer.ts:103

addMarkers

addMarkers(markers, noDraw?): void
Parameters
- markers: Marker[]
- Optional noDraw: boolean
Returns void
- Defined in markerclusterer.ts:114

clearMarkers

clearMarkers(noDraw?): void
Parameters
- Optional noDraw: boolean
Returns void
- Defined in markerclusterer.ts:156

onAdd

onAdd(): void
Returns void
Overrides OverlayViewSafe.onAdd
- Defined in markerclusterer.ts:228

onRemove

onRemove(): void
Returns void
Overrides OverlayViewSafe.onRemove
- Defined in markerclusterer.ts:236

removeMarker

removeMarker(marker, noDraw?): boolean
Parameters
- marker: Marker
- Optional noDraw: boolean
Returns boolean
- Defined in markerclusterer.ts:124

removeMarkers

removeMarkers(markers, noDraw?): boolean
Parameters
- markers: Marker[]
- Optional noDraw: boolean
Returns boolean
- Defined in markerclusterer.ts:142

render

render(): void
Recalculates and draws all the marker clusters.

Returns void
- Defined in markerclusterer.ts:167

`Protected` renderClusters

renderClusters(): void
Returns void
- Defined in markerclusterer.ts:247

`Protected` reset

reset(): void
Returns void
- Defined in markerclusterer.ts:241

Generated using TypeDoc