From a8743e02cb2a479a66f851c6fca29e64dfc9eeab Mon Sep 17 00:00:00 2001 From: googlemaps-bot Date: Mon, 18 Oct 2021 02:09:27 +0000 Subject: [PATCH] build(deps-dev): bump typedoc from 0.22.5 to 0.22.6 (#321) Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.22.5 to 0.22.6. - [Release notes](https://github.com/TypeStrong/TypeDoc/releases) - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md) - [Commits](https://github.com/TypeStrong/TypeDoc/compare/v0.22.5...v0.22.6) --- updated-dependencies: - dependency-name: typedoc dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> 72d3c72d4710bd1eb60ed38bbf802a062e5a9f16 --- classes/default.html | 98 +++++++++++++------------- index.html | 2 +- interfaces/ClusterIconInfo.html | 10 +-- interfaces/ClusterIconStyle.html | 28 ++++---- interfaces/MarkerClustererOptions.html | 38 +++++----- modules.html | 2 +- 6 files changed, 89 insertions(+), 89 deletions(-) diff --git a/classes/default.html b/classes/default.html index 804424b..99d4e88 100644 --- a/classes/default.html +++ b/classes/default.html @@ -1,4 +1,4 @@ -default | @googlemaps/js-markerclustererplus
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • OverlayViewSafe
    • default

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

ariaLabelFn

ariaLabelFn: AriaLabelFn = ...

Static BATCH_SIZE

BATCH_SIZE: number = 2000

The number of markers to process in one batch.

-

Static BATCH_SIZE_IE

BATCH_SIZE_IE: number = 500
+

Static BATCH_SIZE_IE

BATCH_SIZE_IE: number = 500

The number of markers to process in one batch (IE only).

-

Static IMAGE_EXTENSION

IMAGE_EXTENSION: string = "png"
+

Static IMAGE_EXTENSION

IMAGE_EXTENSION: string = "png"

The default extension name for the marker cluster images.

-

Static IMAGE_PATH

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

Static IMAGE_PATH

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

The default root name for the marker cluster images.

-

Static IMAGE_SIZES

IMAGE_SIZES: number[] = ...
+

Static IMAGE_SIZES

IMAGE_SIZES: number[] = ...

The default array of sizes for the marker cluster images.

-

Methods

addMarker

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

Methods

addMarker

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

  • Adds a marker to the clusterer. The clusters are redrawn unless nodraw is set to true.

    Parameters

    • marker: Marker

      The marker to add.

    • Optional nodraw: boolean

      Set to true to prevent redrawing.

      -

    Returns void

addMarkers

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

Returns void

addMarkers

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

  • Adds an array of markers to the clusterer. The clusters are redrawn unless nodraw is set to true.

    Parameters

    • markers: Marker[]

      The markers to add.

    • Optional nodraw: boolean

      Set to true to prevent redrawing.

      -

    Returns void

clearMarkers

  • clearMarkers(): void

Returns void

clearMarkers

  • clearMarkers(): void

  • Removes all clusters and markers from the map and also removes all markers managed by the clusterer.

    -

    Returns void

fitMapToMarkers

  • fitMapToMarkers(padding: number | Padding): void

fitMapToMarkers

  • fitMapToMarkers(padding: number | Padding): void

  • Fits the map to the bounds of the markers managed by the clusterer.

    -

    Parameters

    • padding: number | Padding

    Returns void

getAverageCenter

  • getAverageCenter(): boolean

getAverageCenter

  • getAverageCenter(): boolean

  • Returns the value of the averageCenter property.

    Returns boolean

    True if averageCenter property is set.

    -

getBatchSizeIE

  • getBatchSizeIE(): number

getBatchSizeIE

  • getBatchSizeIE(): number

  • Returns the value of the batchSizeIE property.

    Returns number

    the value of the batchSizeIE property.

    -

getCalculator

  • getCalculator(): Calculator

getCalculator

  • getCalculator(): Calculator

  • Returns the value of the calculator property.

    Returns Calculator

    the value of the calculator property.

    -

getClusterClass

  • getClusterClass(): string

getClusterClass

  • getClusterClass(): string

  • Returns the value of the clusterClass property.

    Returns string

    the value of the clusterClass property.

    -

getClusters

  • getClusters(): Cluster[]

getClusters

  • getClusters(): Cluster[]

  • Returns the current array of clusters formed by the clusterer.

    Returns Cluster[]

    The array of clusters formed by the clusterer.

    -

getEnableRetinaIcons

  • getEnableRetinaIcons(): boolean

getEnableRetinaIcons

  • getEnableRetinaIcons(): boolean

  • Returns the value of the enableRetinaIcons property.

    Returns boolean

    True if enableRetinaIcons property is set.

    -

getGridSize

  • getGridSize(): number

getGridSize

  • getGridSize(): number

getIgnoreHidden

  • getIgnoreHidden(): boolean

getIgnoreHidden

  • getIgnoreHidden(): boolean

  • Returns the value of the ignoreHidden property.

    Returns boolean

    True if ignoreHidden property is set.

    -

getImageExtension

  • getImageExtension(): string

getImageExtension

  • getImageExtension(): string

  • Returns the value of the imageExtension property.

    Returns string

    The value of the imageExtension property.

    -

getImagePath

  • getImagePath(): string

getImagePath

  • getImagePath(): string

  • Returns the value of the imagePath property.

    Returns string

    The value of the imagePath property.

    -

getImageSizes

  • getImageSizes(): number[]

getImageSizes

  • getImageSizes(): number[]

  • Returns the value of the imageSizes property.

    Returns number[]

    The value of the imageSizes property.

    -

getMarkers

  • getMarkers(): Marker[]

getMarkers

  • getMarkers(): Marker[]

  • Returns the array of markers managed by the clusterer.

    Returns Marker[]

    The array of markers managed by the clusterer.

    -

getMaxZoom

  • getMaxZoom(): number

getMaxZoom

  • getMaxZoom(): number

  • Returns the value of the maxZoom property.

    Returns number

    The maximum zoom level.

    -

getMinimumClusterSize

  • getMinimumClusterSize(): number

getMinimumClusterSize

  • getMinimumClusterSize(): number

  • Returns the value of the minimumClusterSize property.

    Returns number

    The minimum cluster size.

    -

getStyles

getStyles

getTitle

  • getTitle(): string

getTitle

  • getTitle(): string

  • Returns the value of the title property.

    Returns string

    The content of the title text.

    -

getTotalClusters

  • getTotalClusters(): number

getTotalClusters

  • getTotalClusters(): number

  • Returns the number of clusters formed by the clusterer.

    Returns number

    The number of clusters formed by the clusterer.

    -

getTotalMarkers

  • getTotalMarkers(): number

getTotalMarkers

  • getTotalMarkers(): number

  • Returns the number of markers managed by the clusterer.

    Returns number

    The number of markers.

    -

getZIndex

  • getZIndex(): number

getZoomOnClick

  • getZoomOnClick(): boolean

getZIndex

  • getZIndex(): number

getZoomOnClick

  • getZoomOnClick(): boolean

  • Returns the value of the zoomOnClick property.

    Returns boolean

    True if zoomOnClick property is set.

    -

removeMarker

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

removeMarker

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

  • Removes a marker from the cluster. The clusters are redrawn unless nodraw is set to true. Returns true if the marker was removed from the clusterer.

    @@ -101,7 +101,7 @@
  • Optional nodraw: boolean

    Set to true to prevent redrawing.

Returns boolean

True if the marker was removed from the clusterer.

-

removeMarkers

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

removeMarkers

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

  • Removes an array of markers from the cluster. The clusters are redrawn unless nodraw is set to true. Returns true if markers were removed from the clusterer.

    Parameters

    • markers: Marker[]
      @@ -109,70 +109,70 @@
    • Optional nodraw: boolean

      Set to true to prevent redrawing.

    Returns boolean

    True if markers were removed from the clusterer.

    -

repaint

  • repaint(): void

repaint

  • repaint(): void

  • Recalculates and redraws all the marker clusters from scratch. Call this after changing any properties.

    -

    Returns void

setAverageCenter

  • setAverageCenter(averageCenter: boolean): void

setAverageCenter

  • setAverageCenter(averageCenter: boolean): void

  • Sets the value of the averageCenter property.

    Parameters

    • averageCenter: boolean

      The value of the averageCenter property.

      -

    Returns void

setBatchSizeIE

  • setBatchSizeIE(batchSizeIE: number): void

Returns void

setBatchSizeIE

  • setBatchSizeIE(batchSizeIE: number): void

  • Sets the value of the batchSizeIE property.

    Parameters

    • batchSizeIE: number

      The value of the batchSizeIE property.

      -

    Returns void

setCalculator

  • setCalculator(calculator: Calculator): void

Returns void

setCalculator

  • setCalculator(calculator: Calculator): void

  • Sets the value of the calculator property.

    Parameters

    • calculator: Calculator

      The value of the calculator property.

      -

    Returns void

setClusterClass

  • setClusterClass(clusterClass: string): void

Returns void

setClusterClass

  • setClusterClass(clusterClass: string): void

  • Sets the value of the clusterClass property.

    Parameters

    • clusterClass: string

      The value of the clusterClass property.

      -

    Returns void

setEnableRetinaIcons

  • setEnableRetinaIcons(enableRetinaIcons: boolean): void

Returns void

setEnableRetinaIcons

  • setEnableRetinaIcons(enableRetinaIcons: boolean): void

  • Sets the value of the enableRetinaIcons property.

    Parameters

    • enableRetinaIcons: boolean

      The value of the enableRetinaIcons property.

      -

    Returns void

setGridSize

  • setGridSize(gridSize: number): void

Returns void

setGridSize

  • setGridSize(gridSize: number): void

  • Sets the value of the gridSize property.

    Parameters

    • gridSize: number

      The grid size.

      -

    Returns void

setIgnoreHidden

  • setIgnoreHidden(ignoreHidden: boolean): void

Returns void

setIgnoreHidden

  • setIgnoreHidden(ignoreHidden: boolean): void

  • Sets the value of the ignoreHidden property.

    Parameters

    • ignoreHidden: boolean

      The value of the ignoreHidden property.

      -

    Returns void

setImageExtension

  • setImageExtension(imageExtension: string): void

Returns void

setImageExtension

  • setImageExtension(imageExtension: string): void

  • Sets the value of the imageExtension property.

    Parameters

    • imageExtension: string

      The value of the imageExtension property.

      -

    Returns void

setImagePath

  • setImagePath(imagePath: string): void

Returns void

setImagePath

  • setImagePath(imagePath: string): void

  • Sets the value of the imagePath property.

    Parameters

    • imagePath: string

      The value of the imagePath property.

      -

    Returns void

setImageSizes

  • setImageSizes(imageSizes: number[]): void

Returns void

setImageSizes

  • setImageSizes(imageSizes: number[]): void

  • Sets the value of the imageSizes property.

    Parameters

    • imageSizes: number[]

      The value of the imageSizes property.

      -

    Returns void

setMaxZoom

  • setMaxZoom(maxZoom: number): void

Returns void

setMaxZoom

  • setMaxZoom(maxZoom: number): void

  • Sets the value of the maxZoom property.

    Parameters

    • maxZoom: number

      The maximum zoom level.

      -

    Returns void

setMinimumClusterSize

  • setMinimumClusterSize(minimumClusterSize: number): void

Returns void

setMinimumClusterSize

  • setMinimumClusterSize(minimumClusterSize: number): void

  • Sets the value of the minimumClusterSize property.

    Parameters

    • minimumClusterSize: number

      The minimum cluster size.

      -

    Returns void

setStyles

Returns void

setStyles

setTitle

  • setTitle(title: string): void

Returns void

setTitle

  • setTitle(title: string): void

  • Sets the value of the title property.

    Parameters

    • title: string

      The value of the title property.

      -

    Returns void

setZIndex

  • setZIndex(zIndex: number): void

setZoomOnClick

  • setZoomOnClick(zoomOnClick: boolean): void

Returns void

setZIndex

  • setZIndex(zIndex: number): void

setZoomOnClick

  • setZoomOnClick(zoomOnClick: boolean): void

  • Sets the value of the zoomOnClick property.

    Parameters

    • zoomOnClick: boolean

      The value of the zoomOnClick property.

      -

    Returns void

Static CALCULATOR

Returns void

Static CALCULATOR

  • The default function for determining the label text and style for a cluster icon.

    Parameters

    • markers: Marker[]
      @@ -180,7 +180,7 @@
    • numStyles: number

      The number of marker styles available.

    Returns ClusterIconInfo

    The information resource for the cluster.

    -

Static withDefaultStyle

Static withDefaultStyle

  • Generates default styles augmented with user passed values. Useful when you want to override some default values but keep untouched

    Parameters

    • overrides: ClusterIconStyle
      diff --git a/index.html b/index.html index 85b813b..091cd5c 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -@googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      @googlemaps/js-markerclustererplus

      +@googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      @googlemaps/js-markerclustererplus

      Google Maps JavaScript MarkerClustererPlus

       diff --git a/interfaces/ClusterIconInfo.html b/interfaces/ClusterIconInfo.html index 00eedec..f76da10 100644 --- a/interfaces/ClusterIconInfo.html +++ b/interfaces/ClusterIconInfo.html @@ -1,13 +1,13 @@ -ClusterIconInfo | @googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface ClusterIconInfo

      description

      This is an object containing general information about a cluster icon. This is +ClusterIconInfo | @googlemaps/js-markerclustererplus

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface ClusterIconInfo

      description

      This is an object containing general information about a cluster icon. This is the object that a calculator function returns.

      -

      Hierarchy

      • ClusterIconInfo

      Index

      Properties

      Properties

      index

      index: number
      +

      Hierarchy

      • ClusterIconInfo

      Index

      Properties

      Properties

      index

      index: number

      The index plus 1 of the element in the styles

      -

      text

      text: string
      +

      text

      text: string

      The text of the label to be shown on the cluster icon.

      -

      title

      title: string
      +

      title

      title: string

      The tooltip to display when the mouse moves over the cluster icon. If this value is undefined or "", title is set to the value of the title property passed to the MarkerClusterer.

      -

      Optional url

      url?: string
      +

      Optional url

      url?: string

      An override for dynamic cluster icon url (if not provided, the component will use the default style icon)

      Legend

      • Constructor
      • Property
      • Method
      • Static property
      • Static method
      • Property

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/ClusterIconStyle.html b/interfaces/ClusterIconStyle.html index d00b8df..fa84b98 100644 --- a/interfaces/ClusterIconStyle.html +++ b/interfaces/ClusterIconStyle.html @@ -1,52 +1,52 @@ -ClusterIconStyle | @googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface ClusterIconStyle

      Hierarchy

      • ClusterIconStyle

      Index

      Properties

      Properties

      Optional anchorIcon

      anchorIcon?: [number, number]
      +ClusterIconStyle | @googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface ClusterIconStyle

      Hierarchy

      • ClusterIconStyle

      Index

      Properties

      Properties

      Optional anchorIcon

      anchorIcon?: [number, number]

      The anchor position (in pixels) of the cluster icon. This is the spot on the cluster icon that is to be aligned with the cluster position. The format is [yoffset, xoffset] where yoffset increases as you go down and xoffset increases to the right of the top-left corner of the icon. The default anchor position is the center of the cluster icon.

      -

      Optional anchorText

      anchorText?: [number, number]
      +

      Optional anchorText

      anchorText?: [number, number]

      The position (in pixels) from the center of the cluster icon to where the text label is to be centered and drawn. The format is [yoffset, xoffset] where yoffset increases as you go down from center and xoffset increases to the right of center. The default is [0, 0].

      -

      Optional backgroundPosition

      backgroundPosition?: string
      +

      Optional backgroundPosition

      backgroundPosition?: string

      The position of the cluster icon image within the image defined by url. The format is "xpos ypos" (the same format as for the CSS background-position property). You must set this property appropriately when the image defined by url represents a sprite containing multiple images. Note that the position must be specified in px units.

      default

      "0 0"

      -

      Optional className

      className?: string
      +

      Optional className

      className?: string

      The name of the CSS class defining styles for the cluster markers.

      -

      Optional fontFamily

      fontFamily?: string
      +

      Optional fontFamily

      fontFamily?: string

      The value of the CSS font-family property for the label text shown on the cluster icon.

      default

      "Arial,sans-serif"

      -

      Optional fontStyle

      fontStyle?: string
      +

      Optional fontStyle

      fontStyle?: string

      The value of the CSS font-style property for the label text shown on the cluster icon.

      default

      "normal"

      -

      Optional fontWeight

      fontWeight?: string
      +

      Optional fontWeight

      fontWeight?: string

      The value of the CSS font-weight property for the label text shown on the cluster icon.

      default

      "bold"

      -

      height

      height: number
      +

      height

      height: number

      Height The display height (in pixels) of the cluster icon. Required.

      -

      Optional textColor

      textColor?: string
      +

      Optional textColor

      textColor?: string

      The color of the label text shown on the cluster icon.

      default

      "black"

      -

      Optional textDecoration

      textDecoration?: string
      +

      Optional textDecoration

      textDecoration?: string

      The value of the CSS text-decoration property for the label text shown on the cluster icon.

      default

      "none"

      -

      Optional textLineHeight

      textLineHeight?: number
      +

      Optional textLineHeight

      textLineHeight?: number

      The line height (in pixels) of the label text shown on the cluster icon.

      default

      the same as cluster icon height

      -

      Optional textSize

      textSize?: number
      +

      Optional textSize

      textSize?: number

      The size (in pixels) of the label text shown on the cluster icon.

      default

      11

      -

      Optional url

      url?: string
      +

      Optional url

      url?: string

      The URL of the cluster icon image file. If not set, img element will not be created

      -

      width

      width: number
      +

      width

      width: number

      Width The display width (in pixels) of the cluster icon. Required.

      Legend

      • Constructor
      • Property
      • Method
      • Static property
      • Static method
      • Property

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/interfaces/MarkerClustererOptions.html b/interfaces/MarkerClustererOptions.html index 039600e..6d7eea9 100644 --- a/interfaces/MarkerClustererOptions.html +++ b/interfaces/MarkerClustererOptions.html @@ -1,18 +1,18 @@ -MarkerClustererOptions | @googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface MarkerClustererOptions

      +MarkerClustererOptions | @googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface MarkerClustererOptions

      Optional parameter passed to the {@link MarkerClusterer} constructor.

      -

      Hierarchy

      • MarkerClustererOptions

      Index

      Properties

      Properties

      Optional ariaLabelFn

      ariaLabelFn?: AriaLabelFn
      +

      Hierarchy

      • MarkerClustererOptions

      Index

      Properties

      Properties

      Optional ariaLabelFn

      ariaLabelFn?: AriaLabelFn

      A function to take the text attribute associated with the cluster and output a string to attach an ariaLabel to the cluster

      -

      Optional averageCenter

      averageCenter?: boolean
      +

      Optional averageCenter

      averageCenter?: boolean

      Whether the position of a cluster marker should be the average position of all markers in the cluster. If set to false, the cluster marker is positioned at the location of the first marker added to the cluster.

      default

      false

      -

      Optional batchSize

      batchSize?: number
      +

      Optional batchSize

      batchSize?: number

      Set this property to the number of markers to be processed in a single batch when using a browser other than Internet Explorer (for Internet Explorer, use the batchSizeIE property instead).

      default

      MarkerClusterer.BATCH_SIZE

      -

      Optional batchSizeIE

      batchSizeIE?: number
      +

      Optional batchSizeIE

      batchSizeIE?: number

      When Internet Explorer is being used, markers are processed in several batches with a small delay inserted between each batch in an attempt to avoid Javascript timeout errors. Set this property to the @@ -20,7 +20,7 @@ without causing a timeout error in the browser. This number might need to be as low as 100 if 15,000 markers are being managed, for example.

      default

      MarkerClusterer.BATCH_SIZE_IE

      -

      Optional calculator

      calculator?: Calculator
      +

      Optional calculator

      calculator?: Calculator

      The function used to determine the text to be displayed on a cluster marker and the index indicating which style to use for the cluster marker. The input parameters for the function are (1) the array of markers @@ -38,21 +38,21 @@ title is not defined, the tooltip is set to the value of the title property for the MarkerClusterer.

      default

      {@link MarkerClusterer.CALCULATOR}

      -

      Optional clusterClass

      clusterClass?: string
      +

      Optional clusterClass

      clusterClass?: string

      The name of the CSS class defining general styles for the cluster markers. Use this class to define CSS styles that are not set up by the code that processes the styles array.

      default

      "cluster"

      -

      Optional enableRetinaIcons

      enableRetinaIcons?: boolean
      +

      Optional enableRetinaIcons

      enableRetinaIcons?: boolean

      Whether to allow the use of cluster icons that have sizes that are some multiple (typically double) of their actual display size. Icons such as these look better when viewed on high-resolution monitors such as Apple's Retina displays. Note: if this property is true, sprites cannot be used as cluster icons.

      default

      false

      -

      Optional gridSize

      gridSize?: number
      +

      Optional gridSize

      gridSize?: number

      The grid size of a cluster in pixels. The grid is a square.

      default

      60

      -

      Optional ignoreHidden

      ignoreHidden?: boolean
      +

      Optional ignoreHidden

      ignoreHidden?: boolean

      Whether to ignore hidden markers in clusters. You may want to set this to true to ensure that hidden markers are not included in the marker count that appears on a cluster marker (this count is the value of the @@ -60,44 +60,44 @@ If set to true and you change the visibility of a marker being clustered, be sure to also call {@link MarkerClusterer#repaint()}.

      default

      false

      -

      Optional imageExtension

      imageExtension?: string
      +

      Optional imageExtension

      imageExtension?: string

      The extension name for the cluster icon image files (e.g., "png" or "jpg").

      default

      MarkerClusterer.IMAGE_EXTENSION

      -

      Optional imagePath

      imagePath?: string
      +

      Optional imagePath

      imagePath?: string

      The full URL of the root name of the group of image files to use for cluster icons. The complete file name is of the form imagePathn.imageExtension where n is the image file number (1, 2, etc.).

      default

      MarkerClusterer.IMAGE_PATH

      -

      Optional imageSizes

      imageSizes?: number[]
      +

      Optional imageSizes

      imageSizes?: number[]

      An array of numbers containing the widths of the group of imagePathn.imageExtension image files. (The images are assumed to be square.)

      default

      MarkerClusterer.IMAGE_SIZES

      -

      Optional maxZoom

      maxZoom?: number
      +

      Optional maxZoom

      maxZoom?: number

      The maximum zoom level at which clustering is enabled or null if clustering is to be enabled at all zoom levels.

      default

      null

      -

      Optional minimumClusterSize

      minimumClusterSize?: number
      +

      Optional minimumClusterSize

      minimumClusterSize?: number

      The minimum number of markers needed in a cluster before the markers are hidden and a cluster marker appears.

      default

      2

      -

      Optional styles

      styles?: ClusterIconStyle[]
      +

      Optional styles

      styles?: ClusterIconStyle[]

      An array of ClusterIconStyle elements defining the styles of the cluster markers to be used. The element to be used to style a given cluster marker is determined by the function defined by the calculator property. The default is an array of ClusterIconStyle elements whose properties are derived from the values for imagePath, imageExtension, and imageSizes.

      default

      styles

      -

      Optional title

      title?: string
      +

      Optional title

      title?: string

      The tooltip to display when the mouse moves over a cluster marker. (Alternatively, you can use a custom calculator function to specify a different tooltip for each cluster marker.)

      default

      ""

      -

      Optional zIndex

      zIndex?: number
      +

      Optional zIndex

      zIndex?: number

      the z-index of a cluster.

      default

      google.maps.Marker.MAX_ZINDEX + 1

      -

      Optional zoomOnClick

      zoomOnClick?: boolean
      +

      Optional zoomOnClick

      zoomOnClick?: boolean

      Whether to zoom the map when a cluster marker is clicked. You may want to set this to false if you have installed a handler for the click event and it deals with zooming on its own.

      diff --git a/modules.html b/modules.html index a154b99..979ee05 100644 --- a/modules.html +++ b/modules.html @@ -1 +1 @@ -@googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      @googlemaps/js-markerclustererplus

      Index

      Classes

      Interfaces

      Legend

      • Constructor
      • Property
      • Method
      • Static property
      • Static method
      • Property

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file +@googlemaps/js-markerclustererplus
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      @googlemaps/js-markerclustererplus

      Index

      Classes

      Interfaces

      Legend

      • Constructor
      • Property
      • Method
      • Static property
      • Static method
      • Property

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file