google-react-maps
Version:
A more powerfully custom version of the Google Maps Javascript API built for React. Multiple Datalayer support. GEOJSON Enabled.
4,131 lines (1,251 loc) • 97.8 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Google React Maps Class: MarkerClusterer</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">Google React Maps</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="google.maps.html">google.maps</a></li><li><a href="Utils.html">Utils</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Circle.html">Circle</a></li><li><a href="Cluster.html">Cluster</a></li><li><a href="ClusterIconInfo.html">ClusterIconInfo</a></li><li><a href="ClusterIconStyle.html">ClusterIconStyle</a></li><li><a href="Feature.html">Feature</a></li><li><a href="google.maps.LatLngLiteral.html">google.maps.LatLngLiteral</a></li><li><a href="Map.html">Map</a></li><li><a href="Map.InfoWindow.html">Map.InfoWindow</a></li><li><a href="Map.Marker.html">Map.Marker</a></li><li><a href="Map.MarkerCluster.html">Map.MarkerCluster</a></li><li><a href="MapControl.html">MapControl</a></li><li><a href="MarkerClusterer.html">MarkerClusterer</a></li><li><a href="MarkerClustererOptions.html">MarkerClustererOptions</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="MarkerClusterer.html#event:click">MarkerClusterer#event:click</a></li><li><a href="MarkerClusterer.html#event:clusteringbegin">MarkerClusterer#event:clusteringbegin</a></li><li><a href="MarkerClusterer.html#event:clusteringend">MarkerClusterer#event:clusteringend</a></li><li><a href="MarkerClusterer.html#event:mouseout">MarkerClusterer#event:mouseout</a></li><li><a href="MarkerClusterer.html#event:mouseover">MarkerClusterer#event:mouseover</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="global.html#processPoints">processPoints</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Class: MarkerClusterer</h1>
<section>
<header>
<h2>
MarkerClusterer
</h2>
</header>
<article>
<div class="container-overview">
<hr>
<dt>
<h4 class="name" id="MarkerClusterer"><span class="type-signature"></span>new MarkerClusterer(map [, opt_markers] [, opt_options])</h4>
</dt>
<dd>
<div class="description">
<p>Creates a MarkerClusterer object with the options specified in <a href="MarkerClustererOptions.html">MarkerClustererOptions</a>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>map</code></td>
<td class="type">
<span class="param-type">google.maps.Map</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The Google map to attach to.</p></td>
</tr>
<tr>
<td class="name"><code>opt_markers</code></td>
<td class="type">
<span class="param-type">Array.<google.maps.Marker></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The markers to be added to the cluster.</p></td>
</tr>
<tr>
<td class="name"><code>opt_options</code></td>
<td class="type">
<span class="param-type"><a href="MarkerClustererOptions.html">MarkerClustererOptions</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>The optional parameters.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-625">line 625</a>
</li>
</ul>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>google.maps.OverlayView</li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<hr>
<dt class="name" id=".BATCH_SIZE">
<h4><span class="type-signature"><static, constant> </span>BATCH_SIZE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The number of markers to process in one batch.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1558">line 1558</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".BATCH_SIZE_IE">
<h4><span class="type-signature"><static, constant> </span>BATCH_SIZE_IE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The number of markers to process in one batch (IE only).</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1567">line 1567</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".IMAGE_EXTENSION">
<h4><span class="type-signature"><static, constant> </span>IMAGE_EXTENSION<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The default extension name for the marker cluster images.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1585">line 1585</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".IMAGE_PATH">
<h4><span class="type-signature"><static, constant> </span>IMAGE_PATH<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The default root name for the marker cluster images.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1576">line 1576</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".IMAGE_SIZES">
<h4><span class="type-signature"><static, constant> </span>IMAGE_SIZES<span class="type-signature"> :Array.<number></span></h4>
</dt>
<dd>
<div class="description">
<p>The default array of sizes for the marker cluster images.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<number></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1594">line 1594</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="addMarker"><span class="type-signature"></span>addMarker(marker [, opt_nodraw])</h4>
</dt>
<dd>
<div class="description">
<p>Adds a marker to the clusterer. The clusters are redrawn unless<br> <code>opt_nodraw</code> is set to <code>true</code>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>marker</code></td>
<td class="type">
<span class="param-type">google.maps.Marker</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The marker to add.</p></td>
</tr>
<tr>
<td class="name"><code>opt_nodraw</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Set to <code>true</code> to prevent redrawing.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1137">line 1137</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="addMarkers"><span class="type-signature"></span>addMarkers(markers [, opt_nodraw])</h4>
</dt>
<dd>
<div class="description">
<p>Adds an array of markers to the clusterer. The clusters are redrawn unless<br> <code>opt_nodraw</code> is set to <code>true</code>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>markers</code></td>
<td class="type">
<span class="param-type">Array.<google.maps.Marker></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The markers to add.</p></td>
</tr>
<tr>
<td class="name"><code>opt_nodraw</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Set to <code>true</code> to prevent redrawing.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1152">line 1152</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="addToClosestCluster_"><span class="type-signature"></span>addToClosestCluster_(marker)</h4>
</dt>
<dd>
<div class="description">
<p>Adds a marker to a cluster, or creates a new cluster.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>marker</code></td>
<td class="type">
<span class="param-type">google.maps.Marker</span>
</td>
<td class="description last"><p>The marker to add.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1403">line 1403</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="clearMarkers"><span class="type-signature"></span>clearMarkers()</h4>
</dt>
<dd>
<div class="description">
<p>Removes all clusters and markers from the map and also removes all markers<br> managed by the clusterer.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1267">line 1267</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="createClusters_"><span class="type-signature"></span>createClusters_(iFirst)</h4>
</dt>
<dd>
<div class="description">
<p>Creates the clusters. This is done in batches to avoid timeout errors<br> in some browsers when there is a huge number of markers.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>iFirst</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The index of the first marker in the batch of<br> markers to be added to clusters.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1436">line 1436</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="distanceBetweenPoints_"><span class="type-signature"></span>distanceBetweenPoints_(p1, p2)</h4>
</dt>
<dd>
<div class="description">
<p>Calculates the distance between two latlng locations in km.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>p1</code></td>
<td class="type">
<span class="param-type">google.maps.LatLng</span>
</td>
<td class="description last"><p>The first lat lng point.</p></td>
</tr>
<tr>
<td class="name"><code>p2</code></td>
<td class="type">
<span class="param-type">google.maps.LatLng</span>
</td>
<td class="description last"><p>The second lat lng point.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1373">line 1373</a>
</li>
</ul>
</dd>
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://www.movable-type.co.uk/scripts/latlong.html">http://www.movable-type.co.uk/scripts/latlong.html</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The distance between the two points in km.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="fitMapToMarkers"><span class="type-signature"></span>fitMapToMarkers()</h4>
</dt>
<dd>
<div class="description">
<p>Fits the map to the bounds of the markers managed by the clusterer.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-778">line 778</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAverageCenter"><span class="type-signature"></span>getAverageCenter()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>averageCenter</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-914">line 914</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if averageCenter property is set.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getBatchSizeIE"><span class="type-signature"></span>getBatchSizeIE()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>batchSizeIE</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1055">line 1055</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the value of the batchSizeIE property.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getCalculator"><span class="type-signature"></span>getCalculator()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>calculator</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1034">line 1034</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the value of the calculator property.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getClusterClass"><span class="type-signature"></span>getClusterClass()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>clusterClass</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1075">line 1075</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the value of the clusterClass property.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getClusters"><span class="type-signature"></span>getClusters()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the current array of clusters formed by the clusterer.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1115">line 1115</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The array of clusters formed by the clusterer.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getEnableRetinaIcons"><span class="type-signature"></span>getEnableRetinaIcons()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>enableRetinaIcons</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-954">line 954</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if enableRetinaIcons property is set.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getGridSize"><span class="type-signature"></span>getGridSize()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>gridSize</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-795">line 795</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The grid size.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getIgnoreHidden"><span class="type-signature"></span>getIgnoreHidden()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>ignoreHidden</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-934">line 934</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if ignoreHidden property is set.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getImageExtension"><span class="type-signature"></span>getImageExtension()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>imageExtension</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-974">line 974</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The value of the imageExtension property.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getImagePath"><span class="type-signature"></span>getImagePath()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>imagePath</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-994">line 994</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The value of the imagePath property.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getImageSizes"><span class="type-signature"></span>getImageSizes()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>imageSizes</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1014">line 1014</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The value of the imageSizes property.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getMarkers"><span class="type-signature"></span>getMarkers()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the array of markers managed by the clusterer.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1095">line 1095</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The array of markers managed by the clusterer.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getMaxZoom"><span class="type-signature"></span>getMaxZoom()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>maxZoom</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-834">line 834</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The maximum zoom level.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getMinimumClusterSize"><span class="type-signature"></span>getMinimumClusterSize()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>minimumClusterSize</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-815">line 815</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The minimum cluster size.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getStyles"><span class="type-signature"></span>getStyles()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>styles</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-854">line 854</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The array of styles defining the cluster markers to be used.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getTitle"><span class="type-signature"></span>getTitle()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>title</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-874">line 874</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The content of the title text.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getTotalClusters"><span class="type-signature"></span>getTotalClusters()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the number of clusters formed by the clusterer.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1125">line 1125</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The number of clusters formed by the clusterer.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getTotalMarkers"><span class="type-signature"></span>getTotalMarkers()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the number of markers managed by the clusterer.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1105">line 1105</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The number of markers.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getZoomOnClick"><span class="type-signature"></span>getZoomOnClick()</h4>
</dt>
<dd>
<div class="description">
<p>Returns the value of the <code>zoomOnClick</code> property.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-894">line 894</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if zoomOnClick property is set.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isMarkerInBounds_"><span class="type-signature"></span>isMarkerInBounds_(marker, bounds)</h4>
</dt>
<dd>
<div class="description">
<p>Determines if a marker is contained in a bounds.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>marker</code></td>
<td class="type">
<span class="param-type">google.maps.Marker</span>
</td>
<td class="description last"><p>The marker to check.</p></td>
</tr>
<tr>
<td class="name"><code>bounds</code></td>
<td class="type">
<span class="param-type">google.maps.LatLngBounds</span>
</td>
<td class="description last"><p>The bounds to check against.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html">utils/v3-utility-library-master/markerclustererplus/src/markerclusterer.js</a>,
<a href="utils_v3-utility-library-master_markerclustererplus_src_markerclusterer.js.html#sunlight-1-line-1393">line 1393</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the marker is in the bounds.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="pushMarkerTo_"><span class="type-signature"></span>pushMarkerTo_(marker)</h4>
</dt>
<dd>
<div class="description">
<p>Pushes a marker to the clusterer.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>marker</code></td>
<td class="type">