PageRenderTime 53ms CodeModel.GetById 14ms app.highlight 31ms RepoModel.GetById 1ms app.codeStats 1ms

/docs/com/google/maps/extras/markerclusterer/MarkerClusterer.html

http://gmaps-utility-library-flash.googlecode.com/
HTML | 431 lines | 415 code | 7 blank | 9 comment | 0 complexity | 5b65c39f703bbcb89aa5fc50b2fe8e19 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<html>
  3<head>
  4<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
  6<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
  7<meta content="MarkerClusterer,com.google.maps.extras.markerclusterer.MarkerClusterer,options,gridSize,map,maxZoom,maximumResolution,zoom,addMarker,addMarkers,clearMarkers,getStyles,getTotalClusters,getTotalMarkers,removeMarker,resetViewport" name="keywords">
  8<title>com.google.maps.extras.markerclusterer.MarkerClusterer</title>
  9</head>
 10<body>
 11<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
 12<!--
 13				asdocTitle = 'MarkerClusterer - API Documentation';
 14				var baseRef = '../../../../../';
 15				window.onload = configPage;
 16			--></script>
 17<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
 18<tr>
 19<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?com/google/maps/extras/markerclusterer/MarkerClusterer.html&amp;com/google/maps/extras/markerclusterer/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
 20</tr>
 21<tr class="titleTableRow2">
 22<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;MarkerClusterer</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
 23</tr>
 24<tr class="titleTableRow3">
 25<td colspan="2">&nbsp;</td>
 26</tr>
 27</table>
 28<script type="text/javascript" language="javascript">
 29<!--
 30if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class MarkerClusterer"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
 31--></script>
 32<div class="MainContent">
 33<table cellspacing="0" cellpadding="0" class="classHeaderTable">
 34<tr>
 35<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.google.maps.extras.markerclusterer</a></td>
 36</tr>
 37<tr>
 38<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MarkerClusterer</td>
 39</tr>
 40</table>
 41<p></p>
 42 This class is the entry to MarkerClusterer package, and the only class you as a developer should touch.
 43 
 44 
 45 
 46 <p></p>
 47<br>
 48<hr>
 49</div>
 50<a name="propertySummary"></a>
 51<div class="summarySection">
 52<div class="summaryTableTitle">Public Properties</div>
 53<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
 54<tr>
 55<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
 56</tr>
 57<tr class="">
 58<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#gridSize">gridSize</a> : Number<div class="summaryTableDescription">[read-only]
 59  This getter property is intented for Cluster use
 60  </div>
 61</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
 62</tr>
 63<tr class="">
 64<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#map">map</a> : Map<div class="summaryTableDescription">[read-only]</div>
 65</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
 66</tr>
 67<tr class="">
 68<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maximumResolution">maximumResolution</a> : Number<div class="summaryTableDescription">[read-only]
 69  This getter property is intented for Cluster use
 70  </div>
 71</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
 72</tr>
 73<tr class="">
 74<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxZoom">maxZoom</a> : Number<div class="summaryTableDescription">[read-only]
 75  This getter property is intented for Cluster use
 76  </div>
 77</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
 78</tr>
 79<tr class="">
 80<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#options">options</a> : <a href="../markerclusterer/MarkerClustererOptions.html">MarkerClustererOptions</a>
 81<div class="summaryTableDescription"></div>
 82</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
 83</tr>
 84<tr class="">
 85<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#zoom">zoom</a> : Number<div class="summaryTableDescription">[read-only]
 86  This getter property is intented for Cluster use
 87  </div>
 88</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
 89</tr>
 90</table>
 91</div>
 92<a name="methodSummary"></a>
 93<div class="summarySection">
 94<div class="summaryTableTitle">Public Methods</div>
 95<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
 96<tr>
 97<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
 98</tr>
 99<tr class="">
100<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
101<div class="summarySignature">
102<a class="signatureLink" href="#MarkerClusterer()">MarkerClusterer</a>(map:Map, markers:Array, opts:<a href="MarkerClustererOptions.html">MarkerClustererOptions</a> = null)</div>
103<div class="summaryTableDescription">
104  
105  
106  </div>
107</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
108</tr>
109<tr class="">
110<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
111<div class="summarySignature">
112<a class="signatureLink" href="#addMarker()">addMarker</a>(marker:<a href="UnitMarker.html">UnitMarker</a>, opt_isNodraw:Boolean, isAdded:Boolean, clusters:Array, opt_isNoCheck:Boolean):void</div>
113<div class="summaryTableDescription"></div>
114</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
115</tr>
116<tr class="">
117<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
118<div class="summarySignature">
119<a class="signatureLink" href="#addMarkers()">addMarkers</a>(markers:Array):void</div>
120<div class="summaryTableDescription"></div>
121</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
122</tr>
123<tr class="">
124<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
125<div class="summarySignature">
126<a class="signatureLink" href="#clearMarkers()">clearMarkers</a>():void</div>
127<div class="summaryTableDescription"></div>
128</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
129</tr>
130<tr class="">
131<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
132<div class="summarySignature">
133<a class="signatureLink" href="#getStyles()">getStyles</a>():Array</div>
134<div class="summaryTableDescription"></div>
135</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
136</tr>
137<tr class="">
138<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
139<div class="summarySignature">
140<a class="signatureLink" href="#getTotalClusters()">getTotalClusters</a>():int</div>
141<div class="summaryTableDescription"></div>
142</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
143</tr>
144<tr class="">
145<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
146<div class="summarySignature">
147<a class="signatureLink" href="#getTotalMarkers()">getTotalMarkers</a>():int</div>
148<div class="summaryTableDescription"></div>
149</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
150</tr>
151<tr class="">
152<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
153<div class="summarySignature">
154<a class="signatureLink" href="#removeMarker()">removeMarker</a>(marker:<a href="UnitMarker.html">UnitMarker</a>):void</div>
155<div class="summaryTableDescription"></div>
156</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
157</tr>
158<tr class="">
159<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
160<div class="summarySignature">
161<a class="signatureLink" href="#resetViewport()">resetViewport</a>(force:Boolean = false):void</div>
162<div class="summaryTableDescription"></div>
163</td><td class="summaryTableOwnerCol">MarkerClusterer</td>
164</tr>
165</table>
166</div>
167<script type="text/javascript" language="javascript">
168<!--
169showHideInherited();
170--></script>
171<div class="MainContent">
172<a name="propertyDetail"></a>
173<div class="detailSectionHeader">Property detail</div>
174<a name="gridSize"></a>
175<table cellspacing="0" cellpadding="0" class="detailHeader">
176<tr>
177<td class="detailHeaderName">gridSize</td><td class="detailHeaderType">property</td>
178</tr>
179</table>
180<div class="detailBody">
181<code>gridSize:Number</code>&nbsp;&nbsp;[read-only]<p>
182  This getter property is intented for Cluster use
183  </p><span class="label">Implementation</span>
184<br>
185<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get gridSize():Number</code>
186<br>
187</div>
188<a name="map"></a>
189<table cellspacing="0" cellpadding="0" class="detailHeader">
190<tr>
191<td class="detailHeaderName">map</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
192</tr>
193</table>
194<div class="detailBody">
195<code>map:Map</code>&nbsp;&nbsp;[read-only]<span class="label">Implementation</span>
196<br>
197<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get map():Map</code>
198<br>
199</div>
200<a name="maximumResolution"></a>
201<table cellspacing="0" cellpadding="0" class="detailHeader">
202<tr>
203<td class="detailHeaderName">maximumResolution</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
204</tr>
205</table>
206<div class="detailBody">
207<code>maximumResolution:Number</code>&nbsp;&nbsp;[read-only]<p>
208  This getter property is intented for Cluster use
209  </p><span class="label">Implementation</span>
210<br>
211<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get maximumResolution():Number</code>
212<br>
213</div>
214<a name="maxZoom"></a>
215<table cellspacing="0" cellpadding="0" class="detailHeader">
216<tr>
217<td class="detailHeaderName">maxZoom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
218</tr>
219</table>
220<div class="detailBody">
221<code>maxZoom:Number</code>&nbsp;&nbsp;[read-only]<p>
222  This getter property is intented for Cluster use
223  </p><span class="label">Implementation</span>
224<br>
225<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get maxZoom():Number</code>
226<br>
227</div>
228<a name="options"></a>
229<table cellspacing="0" cellpadding="0" class="detailHeader">
230<tr>
231<td class="detailHeaderName">options</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
232</tr>
233</table>
234<div class="detailBody">
235<code>public var options:<a href="../markerclusterer/MarkerClustererOptions.html">MarkerClustererOptions</a></code>
236</div>
237<a name="zoom"></a>
238<table cellspacing="0" cellpadding="0" class="detailHeader">
239<tr>
240<td class="detailHeaderName">zoom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
241</tr>
242</table>
243<div class="detailBody">
244<code>zoom:Number</code>&nbsp;&nbsp;[read-only]<p>
245  This getter property is intented for Cluster use
246  </p><span class="label">Implementation</span>
247<br>
248<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get zoom():Number</code>
249<br>
250</div>
251<a name="constructorDetail"></a>
252<div class="detailSectionHeader">Constructor detail</div>
253<a name="MarkerClusterer()"></a>
254<table cellspacing="0" cellpadding="0" class="detailHeader">
255<tr>
256<td class="detailHeaderName">MarkerClusterer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
257</tr>
258</table>
259<div class="detailBody">
260<code>public function MarkerClusterer(map:Map, markers:Array, opts:<a href="MarkerClustererOptions.html">MarkerClustererOptions</a> = null)</code><p>
261  
262  
263  </p><span class="label">Parameters</span>
264<table border="0" cellspacing="0" cellpadding="0">
265<tr>
266<td width="20px"></td><td><code><span class="label">map</span>:Map</code></td>
267</tr>
268<tr>
269<td class="paramSpacer">&nbsp;</td>
270</tr>
271<tr>
272<td width="20px"></td><td><code><span class="label">markers</span>:Array</code></td>
273</tr>
274<tr>
275<td class="paramSpacer">&nbsp;</td>
276</tr>
277<tr>
278<td width="20px"></td><td><code><span class="label">opts</span>:<a href="MarkerClustererOptions.html">MarkerClustererOptions</a></code> (default = <code>null</code>)<code></code></td>
279</tr>
280</table>
281</div>
282<a name="methodDetail"></a>
283<div class="detailSectionHeader">Method detail</div>
284<a name="addMarker()"></a>
285<table cellspacing="0" cellpadding="0" class="detailHeader">
286<tr>
287<td class="detailHeaderName">addMarker</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
288</tr>
289</table>
290<div class="detailBody">
291<code>public function addMarker(marker:<a href="UnitMarker.html">UnitMarker</a>, opt_isNodraw:Boolean, isAdded:Boolean, clusters:Array, opt_isNoCheck:Boolean):void</code><span class="label">Parameters</span>
292<table border="0" cellspacing="0" cellpadding="0">
293<tr>
294<td width="20px"></td><td><code><span class="label">marker</span>:<a href="UnitMarker.html">UnitMarker</a></code></td>
295</tr>
296<tr>
297<td class="paramSpacer">&nbsp;</td>
298</tr>
299<tr>
300<td width="20px"></td><td><code><span class="label">opt_isNodraw</span>:Boolean</code></td>
301</tr>
302<tr>
303<td class="paramSpacer">&nbsp;</td>
304</tr>
305<tr>
306<td width="20px"></td><td><code><span class="label">isAdded</span>:Boolean</code></td>
307</tr>
308<tr>
309<td class="paramSpacer">&nbsp;</td>
310</tr>
311<tr>
312<td width="20px"></td><td><code><span class="label">clusters</span>:Array</code></td>
313</tr>
314<tr>
315<td class="paramSpacer">&nbsp;</td>
316</tr>
317<tr>
318<td width="20px"></td><td><code><span class="label">opt_isNoCheck</span>:Boolean</code></td>
319</tr>
320</table>
321</div>
322<a name="addMarkers()"></a>
323<table cellspacing="0" cellpadding="0" class="detailHeader">
324<tr>
325<td class="detailHeaderName">addMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
326</tr>
327</table>
328<div class="detailBody">
329<code>public function addMarkers(markers:Array):void</code><span class="label">Parameters</span>
330<table border="0" cellspacing="0" cellpadding="0">
331<tr>
332<td width="20px"></td><td><code><span class="label">markers</span>:Array</code></td>
333</tr>
334</table>
335</div>
336<a name="clearMarkers()"></a>
337<table cellspacing="0" cellpadding="0" class="detailHeader">
338<tr>
339<td class="detailHeaderName">clearMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
340</tr>
341</table>
342<div class="detailBody">
343<code>public function clearMarkers():void</code>
344</div>
345<a name="getStyles()"></a>
346<table cellspacing="0" cellpadding="0" class="detailHeader">
347<tr>
348<td class="detailHeaderName">getStyles</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
349</tr>
350</table>
351<div class="detailBody">
352<code>public function getStyles():Array</code>
353<p></p>
354<span class="label">Returns</span>
355<table border="0" cellspacing="0" cellpadding="0">
356<tr>
357<td width="20"></td><td><code>Array</code></td>
358</tr>
359</table>
360</div>
361<a name="getTotalClusters()"></a>
362<table cellspacing="0" cellpadding="0" class="detailHeader">
363<tr>
364<td class="detailHeaderName">getTotalClusters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
365</tr>
366</table>
367<div class="detailBody">
368<code>public function getTotalClusters():int</code>
369<p></p>
370<span class="label">Returns</span>
371<table border="0" cellspacing="0" cellpadding="0">
372<tr>
373<td width="20"></td><td><code>int</code></td>
374</tr>
375</table>
376</div>
377<a name="getTotalMarkers()"></a>
378<table cellspacing="0" cellpadding="0" class="detailHeader">
379<tr>
380<td class="detailHeaderName">getTotalMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
381</tr>
382</table>
383<div class="detailBody">
384<code>public function getTotalMarkers():int</code>
385<p></p>
386<span class="label">Returns</span>
387<table border="0" cellspacing="0" cellpadding="0">
388<tr>
389<td width="20"></td><td><code>int</code></td>
390</tr>
391</table>
392</div>
393<a name="removeMarker()"></a>
394<table cellspacing="0" cellpadding="0" class="detailHeader">
395<tr>
396<td class="detailHeaderName">removeMarker</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
397</tr>
398</table>
399<div class="detailBody">
400<code>public function removeMarker(marker:<a href="UnitMarker.html">UnitMarker</a>):void</code><span class="label">Parameters</span>
401<table border="0" cellspacing="0" cellpadding="0">
402<tr>
403<td width="20px"></td><td><code><span class="label">marker</span>:<a href="UnitMarker.html">UnitMarker</a></code></td>
404</tr>
405</table>
406</div>
407<a name="resetViewport()"></a>
408<table cellspacing="0" cellpadding="0" class="detailHeader">
409<tr>
410<td class="detailHeaderName">resetViewport</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
411</tr>
412</table>
413<div class="detailBody">
414<code>public function resetViewport(force:Boolean = false):void</code><span class="label">Parameters</span>
415<table border="0" cellspacing="0" cellpadding="0">
416<tr>
417<td width="20px"></td><td><code><span class="label">force</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
418</tr>
419</table>
420</div>
421<br>
422<br>
423<hr>
424<br>
425<p></p>
426<center class="copyright"> 
427</center>
428</div>
429</body>
430</html>
431<!-- -->