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: MarkerClustererOptions): MarkerClusterer
Parameters
- __namedParameters: MarkerClustererOptions
Returns MarkerClusterer
Overrides OverlayViewSafe.constructor
- Defined in markerclusterer.ts:77

Properties

`Protected` algorithm

algorithm: Algorithm

See

`Protected` clusters

clusters: Cluster[]

`Protected` idleListener

idleListener: MapsEventListener

See

MarkerClustererOptions.maxZoom

`Protected` map

map: Map

See

`Protected` markers

markers: Marker[]

onClusterClick

onClusterClick: onClusterClickHandler

See

`Protected` renderer

renderer: Renderer

See

Methods

addMarker

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

addMarkers

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

clearMarkers

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

onAdd

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

onRemove

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

removeMarker

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

removeMarkers

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

render

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

Returns void
- Defined in markerclusterer.ts:165

`Protected` renderClusters

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

`Protected` reset

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

Generated using TypeDoc