Class MarkerClusterer

Hierarchy

OverlayViewSafe
- MarkerClusterer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MarkerClusterer(map: Map, markers?: Marker[], options?: MarkerClustererOptions): MarkerClusterer

Overrides MVCObject.__constructor
- Defined in packages/markerclustererplus/src/markerclusterer.ts:324
Parameters
- map: Map
- Default value markers: Marker[] = []
- Default value options: MarkerClustererOptions = {}
Returns MarkerClusterer

Properties

ariaLabelFn

ariaLabelFn: function = this.options.ariaLabelFn || ((): string => "")

Type declaration

- (text: string): string
- Parameters
  - text: string
  Returns string

Static BATCH_SIZE

BATCH_SIZE: number = 2000

Static BATCH_SIZE_IE

BATCH_SIZE_IE: number = 500

Static IMAGE_EXTENSION

IMAGE_EXTENSION: string = "png"

Static IMAGE_PATH

IMAGE_PATH: string = "../images/m"

Static IMAGE_SIZES

IMAGE_SIZES: number[] = [53, 56, 66, 78, 90]

Methods

addListener

addListener(eventName: string, handler: function): MapsEventListener

Inherited from MVCObject.addListener
- Defined in node_modules/@types/googlemaps/index.d.ts:2935
Parameters
- eventName: string
- handler: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns MapsEventListener

addMarker

addMarker(marker: Marker, nodraw: boolean): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:787
Parameters
- marker: Marker
- Optional nodraw: boolean
Returns void

addMarkers

addMarkers(markers: Marker[], nodraw: boolean): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:801
Parameters
- markers: Marker[]
- Optional nodraw: boolean
Returns void

bindTo

bindTo(key: string, target: MVCObject, targetKey: string, noNotify: boolean): void

Inherited from MVCObject.bindTo
- Defined in node_modules/@types/googlemaps/index.d.ts:2937
Parameters
- key: string
- target: MVCObject
- Optional targetKey: string
- Optional noNotify: boolean
Returns void

changed

changed(key: string): void

Inherited from MVCObject.changed
- Defined in node_modules/@types/googlemaps/index.d.ts:2938
Parameters
- key: string
Returns void

clearMarkers

clearMarkers(): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:908
Returns void

fitMapToMarkers

fitMapToMarkers(padding: number | Padding): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:453
Parameters
- padding: number | Padding
Returns void

get

get(key: string): any

Inherited from MVCObject.get
- Defined in node_modules/@types/googlemaps/index.d.ts:2940
Parameters
- key: string
Returns any

getAverageCenter

getAverageCenter(): boolean

- Defined in packages/markerclustererplus/src/markerclusterer.ts:587
Returns boolean

True if averageCenter property is set.

getBatchSizeIE

getBatchSizeIE(): number

- Defined in packages/markerclustererplus/src/markerclusterer.ts:713
Returns number

the value of the batchSizeIE property.

getCalculator

getCalculator(): Calculator

- Defined in packages/markerclustererplus/src/markerclusterer.ts:695
Returns Calculator

the value of the calculator property.

getClusterClass

getClusterClass(): string

- Defined in packages/markerclustererplus/src/markerclusterer.ts:731
Returns string

the value of the clusterClass property.

getClusters

getClusters(): Cluster[]

- Defined in packages/markerclustererplus/src/markerclusterer.ts:767
Returns Cluster[]

The array of clusters formed by the clusterer.

getEnableRetinaIcons

getEnableRetinaIcons(): boolean

- Defined in packages/markerclustererplus/src/markerclusterer.ts:623
Returns boolean

True if enableRetinaIcons property is set.

getGridSize

getGridSize(): number

- Defined in packages/markerclustererplus/src/markerclusterer.ts:471
Returns number

The grid size.

getIgnoreHidden

getIgnoreHidden(): boolean

- Defined in packages/markerclustererplus/src/markerclusterer.ts:605
Returns boolean

True if ignoreHidden property is set.

getImageExtension

getImageExtension(): string

- Defined in packages/markerclustererplus/src/markerclusterer.ts:641
Returns string

The value of the imageExtension property.

getImagePath

getImagePath(): string

- Defined in packages/markerclustererplus/src/markerclusterer.ts:659
Returns string

The value of the imagePath property.

getImageSizes

getImageSizes(): number[]

- Defined in packages/markerclustererplus/src/markerclusterer.ts:677
Returns number[]

The value of the imageSizes property.

getMap

getMap(): Map | StreetViewPanorama

Inherited from OverlayView.getMap
- Defined in node_modules/@types/googlemaps/index.d.ts:1603
Returns Map | StreetViewPanorama

getMarkers

getMarkers(): Marker[]

- Defined in packages/markerclustererplus/src/markerclusterer.ts:749
Returns Marker[]

getMaxZoom

getMaxZoom(): number

- Defined in packages/markerclustererplus/src/markerclusterer.ts:507
Returns number

getMinimumClusterSize

getMinimumClusterSize(): number

- Defined in packages/markerclustererplus/src/markerclusterer.ts:489
Returns number

The minimum cluster size.

getPanes

getPanes(): MapPanes

Inherited from OverlayView.getPanes
- Defined in node_modules/@types/googlemaps/index.d.ts:1604
Returns MapPanes

getProjection

getProjection(): MapCanvasProjection

Inherited from OverlayView.getProjection
- Defined in node_modules/@types/googlemaps/index.d.ts:1605
Returns MapCanvasProjection

getStyles

getStyles(): ClusterIconStyle[]

- Defined in packages/markerclustererplus/src/markerclusterer.ts:533
Returns ClusterIconStyle[]

getTitle

getTitle(): string

- Defined in packages/markerclustererplus/src/markerclusterer.ts:551
Returns string

The content of the title text.

getTotalClusters

getTotalClusters(): number

- Defined in packages/markerclustererplus/src/markerclusterer.ts:776
Returns number

The number of clusters formed by the clusterer.

getTotalMarkers

getTotalMarkers(): number

- Defined in packages/markerclustererplus/src/markerclusterer.ts:758
Returns number

getZIndex

getZIndex(): number

- Defined in packages/markerclustererplus/src/markerclusterer.ts:520
Returns number

getZoomOnClick

getZoomOnClick(): boolean

- Defined in packages/markerclustererplus/src/markerclusterer.ts:569
Returns boolean

True if zoomOnClick property is set.

notify

notify(key: string): void

Inherited from MVCObject.notify
- Defined in node_modules/@types/googlemaps/index.d.ts:2946
Parameters
- key: string
Returns void

removeMarker

removeMarker(marker: Marker, nodraw: boolean): boolean

- Defined in packages/markerclustererplus/src/markerclusterer.ts:842
Parameters
- marker: Marker
- Optional nodraw: boolean
Returns boolean

True if the marker was removed from the clusterer.

removeMarkers

removeMarkers(markers: Marker[], nodraw: boolean): boolean

- Defined in packages/markerclustererplus/src/markerclusterer.ts:860
Parameters
- markers: Marker[]
- Optional nodraw: boolean
Returns boolean

True if markers were removed from the clusterer.

repaint

repaint(): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:917
Returns void

set

set(key: string, value: any): void

Inherited from MVCObject.set
- Defined in node_modules/@types/googlemaps/index.d.ts:2948
Parameters
- key: string
- value: any
Returns void

setAverageCenter

setAverageCenter(averageCenter: boolean): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:596
Parameters
- averageCenter: boolean
Returns void

setBatchSizeIE

setBatchSizeIE(batchSizeIE: number): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:722
Parameters
- batchSizeIE: number
Returns void

setCalculator

setCalculator(calculator: Calculator): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:704
Parameters
- calculator: Calculator
Returns void

setClusterClass

setClusterClass(clusterClass: string): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:740
Parameters
- clusterClass: string
Returns void

setEnableRetinaIcons

setEnableRetinaIcons(enableRetinaIcons: boolean): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:632
Parameters
- enableRetinaIcons: boolean
Returns void

setGridSize

setGridSize(gridSize: number): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:480
Parameters
- gridSize: number
Returns void

setIgnoreHidden

setIgnoreHidden(ignoreHidden: boolean): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:614
Parameters
- ignoreHidden: boolean
Returns void

setImageExtension

setImageExtension(imageExtension: string): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:650
Parameters
- imageExtension: string
Returns void

setImagePath

setImagePath(imagePath: string): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:668
Parameters
- imagePath: string
Returns void

setImageSizes

setImageSizes(imageSizes: number[]): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:686
Parameters
- imageSizes: number[]
Returns void

setMap

setMap(map: Map | StreetViewPanorama | null): void

Inherited from OverlayView.setMap
- Defined in node_modules/@types/googlemaps/index.d.ts:1608
Parameters
- map: Map | StreetViewPanorama | null
Returns void

setMaxZoom

setMaxZoom(maxZoom: number): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:516
Parameters
- maxZoom: number
Returns void

setMinimumClusterSize

setMinimumClusterSize(minimumClusterSize: number): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:498
Parameters
- minimumClusterSize: number
Returns void

setStyles

setStyles(styles: ClusterIconStyle[]): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:542
Parameters
- styles: ClusterIconStyle[]
Returns void

setTitle

setTitle(title: string): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:560
Parameters
- title: string
Returns void

setValues

setValues(values: any): void

Inherited from MVCObject.setValues
- Defined in node_modules/@types/googlemaps/index.d.ts:2950
Parameters
- values: any
Returns void

setZIndex

setZIndex(zIndex: number): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:524
Parameters
- zIndex: number
Returns void

setZoomOnClick

setZoomOnClick(zoomOnClick: boolean): void

- Defined in packages/markerclustererplus/src/markerclusterer.ts:578
Parameters
- zoomOnClick: boolean
Returns void

unbind

unbind(key: string): void

Inherited from MVCObject.unbind
- Defined in node_modules/@types/googlemaps/index.d.ts:2955
Parameters
- key: string
Returns void

unbindAll

unbindAll(): void

Inherited from MVCObject.unbindAll
- Defined in node_modules/@types/googlemaps/index.d.ts:2957
Returns void

Static CALCULATOR

CALCULATOR(markers: Marker[], numStyles: number): ClusterIconInfo

- Defined in packages/markerclustererplus/src/markerclusterer.ts:1149
Parameters
- markers: Marker[]
- numStyles: number
Returns ClusterIconInfo

The information resource for the cluster.

Static withDefaultStyle

withDefaultStyle(overrides: ClusterIconStyle): ClusterIconStyle

- Defined in packages/markerclustererplus/src/markerclusterer.ts:1176
Parameters
- overrides: ClusterIconStyle
Returns ClusterIconStyle

Generated using TypeDoc