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.
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)
\ 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
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.
\ 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
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.
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.
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplusClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Creates a MarkerClusterer object with the options specified in MarkerClustererOptions.
Parameters
map: Map
The Google map to attach to.
@@ -6,93 +6,93 @@The markers to be added to the cluster.
options: MarkerClustererOptions = {}
The optional parameters.
-Returns default
Properties
aria
Static BATCH_
Returns default
Properties
aria
Static BATCH_
The number of markers to process in one batch.
-Static BATCH_
Static BATCH_
The number of markers to process in one batch (IE only).
-Static IMAGE_
Static IMAGE_
The default extension name for the marker cluster images.
-Static IMAGE_
Static IMAGE_
The default root name for the marker cluster images.
-Static IMAGE_
Static IMAGE_
The default array of sizes for the marker cluster images.
-Methods
add
Methods
add
Adds a marker to the clusterer. The clusters are redrawn unless
nodrawis set totrue.Parameters
marker: Marker
The marker to add.
Optional nodraw: boolean
Set to
-trueto prevent redrawing.Returns void
add
Returns void
add
Adds an array of markers to the clusterer. The clusters are redrawn unless
nodrawis set totrue.Parameters
markers: Marker[]
The markers to add.
Optional nodraw: boolean
Set to
-trueto prevent redrawing.Returns void
clear
Returns void
clear
Removes all clusters and markers from the map and also removes all markers managed by the clusterer.
-Returns void
fit
Returns void
fit
Fits the map to the bounds of the markers managed by the clusterer.
-Parameters
padding: number | Padding
Returns void
get
Parameters
padding: number | Padding
Returns void
get
Returns the value of the
averageCenterproperty.Returns boolean
True if averageCenter property is set.
-get
get
Returns the value of the
batchSizeIEproperty.Returns number
the value of the batchSizeIE property.
-get
get
Returns the value of the
calculatorproperty.Returns Calculator
the value of the calculator property.
-get
get
Returns the value of the
clusterClassproperty.Returns string
the value of the clusterClass property.
-get
get
Returns the current array of clusters formed by the clusterer.
Returns Cluster[]
The array of clusters formed by the clusterer.
-get
get
Returns the value of the
enableRetinaIconsproperty.Returns boolean
True if enableRetinaIcons property is set.
-get
get
Returns the value of the
gridSizeproperty.Returns number
The grid size.
-get
get
Returns the value of the
ignoreHiddenproperty.Returns boolean
True if ignoreHidden property is set.
-get
get
Returns the value of the
imageExtensionproperty.Returns string
The value of the imageExtension property.
-get
get
Returns the value of the
imagePathproperty.Returns string
The value of the imagePath property.
-get
get
Returns the value of the
imageSizesproperty.Returns number[]
The value of the imageSizes property.
-get
get
Returns the array of markers managed by the clusterer.
Returns Marker[]
The array of markers managed by the clusterer.
-get
get
Returns the value of the
maxZoomproperty.Returns number
The maximum zoom level.
-get
get
Returns the value of the
minimumClusterSizeproperty.Returns number
The minimum cluster size.
-get
get
Returns the value of the
stylesproperty.Returns ClusterIconStyle[]
The array of styles defining the cluster markers to be used.
-get
get
Returns the value of the
titleproperty.Returns string
The content of the title text.
-get
get
Returns the number of clusters formed by the clusterer.
Returns number
The number of clusters formed by the clusterer.
-get
get
Returns the number of markers managed by the clusterer.
Returns number
The number of markers.
-getZIndex
Returns number
get
getZIndex
Returns number
get
Returns the value of the
zoomOnClickproperty.Returns boolean
True if zoomOnClick property is set.
-remove
remove
Removes a marker from the cluster. The clusters are redrawn unless
@@ -101,7 +101,7 @@nodrawis set totrue. Returnstrueif the marker was removed from the clusterer.Optional nodraw: boolean
Set to
trueto prevent redrawing.Returns boolean
True if the marker was removed from the clusterer.
-remove
remove
Removes an array of markers from the cluster. The clusters are redrawn unless
nodrawis set totrue. Returnstrueif markers were removed from the clusterer.Parameters
markers: Marker[]
Optional nodraw: boolean
Set to
trueto prevent redrawing.Returns boolean
True if markers were removed from the clusterer.
-repaint
repaint
Recalculates and redraws all the marker clusters from scratch. Call this after changing any properties.
-Returns void
set
Returns void
set
Sets the value of the
averageCenterproperty.Parameters
averageCenter: boolean
The value of the averageCenter property.
-Returns void
set
Returns void
set
Sets the value of the
batchSizeIEproperty.Parameters
batchSizeIE: number
The value of the batchSizeIE property.
-Returns void
set
Returns void
set
Sets the value of the
calculatorproperty.Parameters
calculator: Calculator
The value of the calculator property.
-Returns void
set
Returns void
set
Sets the value of the
clusterClassproperty.Parameters
clusterClass: string
The value of the clusterClass property.
-Returns void
set
Returns void
set
Sets the value of the
enableRetinaIconsproperty.Parameters
enableRetinaIcons: boolean
The value of the enableRetinaIcons property.
-Returns void
set
Returns void
set
Sets the value of the
gridSizeproperty.Parameters
gridSize: number
The grid size.
-Returns void
set
Returns void
set
Sets the value of the
ignoreHiddenproperty.Parameters
ignoreHidden: boolean
The value of the ignoreHidden property.
-Returns void
set
Returns void
set
Sets the value of the
imageExtensionproperty.Parameters
imageExtension: string
The value of the imageExtension property.
-Returns void
set
Returns void
set
Sets the value of the
imagePathproperty.Parameters
imagePath: string
The value of the imagePath property.
-Returns void
set
Returns void
set
Sets the value of the
imageSizesproperty.Parameters
imageSizes: number[]
The value of the imageSizes property.
-Returns void
set
Returns void
set
Sets the value of the
maxZoomproperty.Parameters
maxZoom: number
The maximum zoom level.
-Returns void
set
Returns void
set
Sets the value of the
minimumClusterSizeproperty.Parameters
minimumClusterSize: number
The minimum cluster size.
-Returns void
set
Returns void
set
Sets the value of the
stylesproperty.Parameters
styles: ClusterIconStyle[]
The array of styles to use.
-Returns void
set
Returns void
set
Sets the value of the
titleproperty.Parameters
title: string
The value of the title property.
-Returns void
setZIndex
Parameters
zIndex: number
Returns void
set
Returns void
setZIndex
Parameters
zIndex: number
Returns void
set
Sets the value of the
zoomOnClickproperty.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[]
numStyles: number
The number of marker styles available.
Returns ClusterIconInfo
The information resource for the cluster.
-Static with
Static with
Generates default styles augmented with user passed values. Useful when you want to override some default values but keep untouched
Parameters
overrides: ClusterIconStyle
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplus@googlemaps/js-markerclustererplus
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplus@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 @@ -- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplusInterface ClusterIconInfo
This is an object containing general information about a cluster icon. This is +
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplusInterface ClusterIconInfo
This is an object containing general information about a cluster icon. This is the object that a
-calculatorfunction returns.Hierarchy
Index
Properties
Properties
index
Hierarchy
Index
Properties
Properties
index
The index plus 1 of the element in the
-stylestext
text
The text of the label to be shown on the cluster icon.
-title
title
The tooltip to display when the mouse moves over the cluster icon. If this value is
-undefinedor"",titleis set to the value of thetitleproperty passed to the MarkerClusterer.Optional url
Optional url
An override for dynamic cluster icon url (if not provided, the component will use the default style icon)
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplusInterface ClusterIconStyle
Hierarchy
Index
Properties
Properties
Optional anchor
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplusInterface ClusterIconStyle
Hierarchy
Index
Properties
Properties
Optional anchor
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]whereyoffsetincreases as you go down andxoffsetincreases to the right of the top-left corner of the icon. The default anchor position is the center of the cluster icon.Optional anchor
Optional anchor
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]whereyoffsetincreases as you go down from center andxoffsetincreases to the right of center. The default is[0, 0].Optional background
Optional background
The position of the cluster icon image within the image defined by
url. The format is"xpos ypos"(the same format as for the CSSbackground-positionproperty). You must set this property appropriately when the image defined byurlrepresents a sprite containing multiple images. Note that the position must be specified in px units.
-"0 0"Optional class
Optional class
The name of the CSS class defining styles for the cluster markers.
-Optional font
Optional font
The value of the CSS
font-familyproperty for the label text shown on the cluster icon.
-"Arial,sans-serif"Optional font
Optional font
The value of the CSS
font-styleproperty for the label text shown on the cluster icon.
-"normal"Optional font
Optional font
The value of the CSS
font-weightproperty for the label text shown on the cluster icon.
-"bold"height
height
Height The display height (in pixels) of the cluster icon. Required.
-Optional text
Optional text
The color of the label text shown on the cluster icon.
-"black"Optional text
Optional text
The value of the CSS
text-decorationproperty for the label text shown on the cluster icon.
-"none"Optional text
Optional text
The line height (in pixels) of the label text shown on the cluster icon.
the same as cluster icon height
-Optional text
Optional text
The size (in pixels) of the label text shown on the cluster icon.
-11Optional url
Optional url
The URL of the cluster icon image file. If not set, img element will not be created
-width
width
Width The display width (in pixels) of the cluster icon. Required.
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplusInterface MarkerClustererOptions
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplusInterface MarkerClustererOptions
Optional parameter passed to the {@link MarkerClusterer} constructor.
-Hierarchy
Index
Properties
Properties
Optional aria
Hierarchy
Index
Properties
Properties
Optional aria
A function to take the text attribute associated with the cluster and output a string to attach an ariaLabel to the cluster
-Optional average
Optional average
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.
-falseOptional batch
Optional batch
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).
-MarkerClusterer.BATCH_SIZEOptional batch
Optional batch
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.
-MarkerClusterer.BATCH_SIZE_IEOptional calculator
Optional 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 @@
titleis not defined, the tooltip is set to the value of thetitleproperty for the MarkerClusterer.{@link MarkerClusterer.CALCULATOR}
-Optional cluster
Optional cluster
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
stylesarray.
-"cluster"Optional enable
Optional enable
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.
-falseOptional grid
Optional grid
The grid size of a cluster in pixels. The grid is a square.
-60Optional ignore
Optional ignore
Whether to ignore hidden markers in clusters. You may want to set this to
trueto 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 totrueand you change the visibility of a marker being clustered, be sure to also call {@link MarkerClusterer#repaint()}.
-falseOptional image
Optional image
The extension name for the cluster icon image files (e.g.,
"png"or"jpg").
-MarkerClusterer.IMAGE_EXTENSIONOptional image
Optional image
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.imageExtensionwhere n is the image file number (1, 2, etc.).
-MarkerClusterer.IMAGE_PATHOptional image
Optional image
An array of numbers containing the widths of the group of
imagePathn.imageExtensionimage files. (The images are assumed to be square.)
-MarkerClusterer.IMAGE_SIZESOptional max
Optional max
The maximum zoom level at which clustering is enabled or
nullif clustering is to be enabled at all zoom levels.
-nullOptional minimum
Optional minimum
The minimum number of markers needed in a cluster before the markers are hidden and a cluster marker appears.
-2Optional styles
Optional styles
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
calculatorproperty. The default is an array of ClusterIconStyle elements whose properties are derived from the values forimagePath,imageExtension, andimageSizes.
-stylesOptional title
Optional title
The tooltip to display when the mouse moves over a cluster marker. (Alternatively, you can use a custom
calculatorfunction to specify a different tooltip for each cluster marker.)
-""Optional z
Optional z
the z-index of a cluster.
-google.maps.Marker.MAX_ZINDEX + 1Optional zoom
Optional zoom
Whether to zoom the map when a cluster marker is clicked. You may want to set this to
diff --git a/modules.html b/modules.html index a154b99..979ee05 100644 --- a/modules.html +++ b/modules.html @@ -1 +1 @@ -falseif you have installed a handler for theclickevent and it deals with zooming on its own.- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplus@googlemaps/js-markerclustererplus
Index
Classes
Interfaces
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@googlemaps/js-markerclustererplus@googlemaps/js-markerclustererplus
Index
Classes
Interfaces
Generated using TypeDoc