/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. <!--
  30. if (!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. <p></p>
  44. <br>
  45. <hr>
  46. </div>
  47. <a name="propertySummary"></a>
  48. <div class="summarySection">
  49. <div class="summaryTableTitle">Public Properties</div>
  50. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
  51. <tr>
  52. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  53. </tr>
  54. <tr class="">
  55. <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]
  56. This getter property is intented for Cluster use
  57. </div>
  58. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  59. </tr>
  60. <tr class="">
  61. <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>
  62. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  63. </tr>
  64. <tr class="">
  65. <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]
  66. This getter property is intented for Cluster use
  67. </div>
  68. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  69. </tr>
  70. <tr class="">
  71. <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]
  72. This getter property is intented for Cluster use
  73. </div>
  74. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  75. </tr>
  76. <tr class="">
  77. <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>
  78. <div class="summaryTableDescription"></div>
  79. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  80. </tr>
  81. <tr class="">
  82. <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]
  83. This getter property is intented for Cluster use
  84. </div>
  85. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  86. </tr>
  87. </table>
  88. </div>
  89. <a name="methodSummary"></a>
  90. <div class="summarySection">
  91. <div class="summaryTableTitle">Public Methods</div>
  92. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
  93. <tr>
  94. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  95. </tr>
  96. <tr class="">
  97. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  98. <div class="summarySignature">
  99. <a class="signatureLink" href="#MarkerClusterer()">MarkerClusterer</a>(map:Map, markers:Array, opts:<a href="MarkerClustererOptions.html">MarkerClustererOptions</a> = null)</div>
  100. <div class="summaryTableDescription">
  101. </div>
  102. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  103. </tr>
  104. <tr class="">
  105. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  106. <div class="summarySignature">
  107. <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>
  108. <div class="summaryTableDescription"></div>
  109. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  110. </tr>
  111. <tr class="">
  112. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  113. <div class="summarySignature">
  114. <a class="signatureLink" href="#addMarkers()">addMarkers</a>(markers:Array):void</div>
  115. <div class="summaryTableDescription"></div>
  116. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  117. </tr>
  118. <tr class="">
  119. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  120. <div class="summarySignature">
  121. <a class="signatureLink" href="#clearMarkers()">clearMarkers</a>():void</div>
  122. <div class="summaryTableDescription"></div>
  123. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  124. </tr>
  125. <tr class="">
  126. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  127. <div class="summarySignature">
  128. <a class="signatureLink" href="#getStyles()">getStyles</a>():Array</div>
  129. <div class="summaryTableDescription"></div>
  130. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  131. </tr>
  132. <tr class="">
  133. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  134. <div class="summarySignature">
  135. <a class="signatureLink" href="#getTotalClusters()">getTotalClusters</a>():int</div>
  136. <div class="summaryTableDescription"></div>
  137. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  138. </tr>
  139. <tr class="">
  140. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  141. <div class="summarySignature">
  142. <a class="signatureLink" href="#getTotalMarkers()">getTotalMarkers</a>():int</div>
  143. <div class="summaryTableDescription"></div>
  144. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  145. </tr>
  146. <tr class="">
  147. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  148. <div class="summarySignature">
  149. <a class="signatureLink" href="#removeMarker()">removeMarker</a>(marker:<a href="UnitMarker.html">UnitMarker</a>):void</div>
  150. <div class="summaryTableDescription"></div>
  151. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  152. </tr>
  153. <tr class="">
  154. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  155. <div class="summarySignature">
  156. <a class="signatureLink" href="#resetViewport()">resetViewport</a>(force:Boolean = false):void</div>
  157. <div class="summaryTableDescription"></div>
  158. </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
  159. </tr>
  160. </table>
  161. </div>
  162. <script type="text/javascript" language="javascript">
  163. <!--
  164. showHideInherited();
  165. --></script>
  166. <div class="MainContent">
  167. <a name="propertyDetail"></a>
  168. <div class="detailSectionHeader">Property detail</div>
  169. <a name="gridSize"></a>
  170. <table cellspacing="0" cellpadding="0" class="detailHeader">
  171. <tr>
  172. <td class="detailHeaderName">gridSize</td><td class="detailHeaderType">property</td>
  173. </tr>
  174. </table>
  175. <div class="detailBody">
  176. <code>gridSize:Number</code>&nbsp;&nbsp;[read-only]<p>
  177. This getter property is intented for Cluster use
  178. </p><span class="label">Implementation</span>
  179. <br>
  180. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get gridSize():Number</code>
  181. <br>
  182. </div>
  183. <a name="map"></a>
  184. <table cellspacing="0" cellpadding="0" class="detailHeader">
  185. <tr>
  186. <td class="detailHeaderName">map</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  187. </tr>
  188. </table>
  189. <div class="detailBody">
  190. <code>map:Map</code>&nbsp;&nbsp;[read-only]<span class="label">Implementation</span>
  191. <br>
  192. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get map():Map</code>
  193. <br>
  194. </div>
  195. <a name="maximumResolution"></a>
  196. <table cellspacing="0" cellpadding="0" class="detailHeader">
  197. <tr>
  198. <td class="detailHeaderName">maximumResolution</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  199. </tr>
  200. </table>
  201. <div class="detailBody">
  202. <code>maximumResolution:Number</code>&nbsp;&nbsp;[read-only]<p>
  203. This getter property is intented for Cluster use
  204. </p><span class="label">Implementation</span>
  205. <br>
  206. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get maximumResolution():Number</code>
  207. <br>
  208. </div>
  209. <a name="maxZoom"></a>
  210. <table cellspacing="0" cellpadding="0" class="detailHeader">
  211. <tr>
  212. <td class="detailHeaderName">maxZoom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  213. </tr>
  214. </table>
  215. <div class="detailBody">
  216. <code>maxZoom:Number</code>&nbsp;&nbsp;[read-only]<p>
  217. This getter property is intented for Cluster use
  218. </p><span class="label">Implementation</span>
  219. <br>
  220. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get maxZoom():Number</code>
  221. <br>
  222. </div>
  223. <a name="options"></a>
  224. <table cellspacing="0" cellpadding="0" class="detailHeader">
  225. <tr>
  226. <td class="detailHeaderName">options</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  227. </tr>
  228. </table>
  229. <div class="detailBody">
  230. <code>public var options:<a href="../markerclusterer/MarkerClustererOptions.html">MarkerClustererOptions</a></code>
  231. </div>
  232. <a name="zoom"></a>
  233. <table cellspacing="0" cellpadding="0" class="detailHeader">
  234. <tr>
  235. <td class="detailHeaderName">zoom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  236. </tr>
  237. </table>
  238. <div class="detailBody">
  239. <code>zoom:Number</code>&nbsp;&nbsp;[read-only]<p>
  240. This getter property is intented for Cluster use
  241. </p><span class="label">Implementation</span>
  242. <br>
  243. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get zoom():Number</code>
  244. <br>
  245. </div>
  246. <a name="constructorDetail"></a>
  247. <div class="detailSectionHeader">Constructor detail</div>
  248. <a name="MarkerClusterer()"></a>
  249. <table cellspacing="0" cellpadding="0" class="detailHeader">
  250. <tr>
  251. <td class="detailHeaderName">MarkerClusterer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
  252. </tr>
  253. </table>
  254. <div class="detailBody">
  255. <code>public function MarkerClusterer(map:Map, markers:Array, opts:<a href="MarkerClustererOptions.html">MarkerClustererOptions</a> = null)</code><p>
  256. </p><span class="label">Parameters</span>
  257. <table border="0" cellspacing="0" cellpadding="0">
  258. <tr>
  259. <td width="20px"></td><td><code><span class="label">map</span>:Map</code></td>
  260. </tr>
  261. <tr>
  262. <td class="paramSpacer">&nbsp;</td>
  263. </tr>
  264. <tr>
  265. <td width="20px"></td><td><code><span class="label">markers</span>:Array</code></td>
  266. </tr>
  267. <tr>
  268. <td class="paramSpacer">&nbsp;</td>
  269. </tr>
  270. <tr>
  271. <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>
  272. </tr>
  273. </table>
  274. </div>
  275. <a name="methodDetail"></a>
  276. <div class="detailSectionHeader">Method detail</div>
  277. <a name="addMarker()"></a>
  278. <table cellspacing="0" cellpadding="0" class="detailHeader">
  279. <tr>
  280. <td class="detailHeaderName">addMarker</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
  281. </tr>
  282. </table>
  283. <div class="detailBody">
  284. <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>
  285. <table border="0" cellspacing="0" cellpadding="0">
  286. <tr>
  287. <td width="20px"></td><td><code><span class="label">marker</span>:<a href="UnitMarker.html">UnitMarker</a></code></td>
  288. </tr>
  289. <tr>
  290. <td class="paramSpacer">&nbsp;</td>
  291. </tr>
  292. <tr>
  293. <td width="20px"></td><td><code><span class="label">opt_isNodraw</span>:Boolean</code></td>
  294. </tr>
  295. <tr>
  296. <td class="paramSpacer">&nbsp;</td>
  297. </tr>
  298. <tr>
  299. <td width="20px"></td><td><code><span class="label">isAdded</span>:Boolean</code></td>
  300. </tr>
  301. <tr>
  302. <td class="paramSpacer">&nbsp;</td>
  303. </tr>
  304. <tr>
  305. <td width="20px"></td><td><code><span class="label">clusters</span>:Array</code></td>
  306. </tr>
  307. <tr>
  308. <td class="paramSpacer">&nbsp;</td>
  309. </tr>
  310. <tr>
  311. <td width="20px"></td><td><code><span class="label">opt_isNoCheck</span>:Boolean</code></td>
  312. </tr>
  313. </table>
  314. </div>
  315. <a name="addMarkers()"></a>
  316. <table cellspacing="0" cellpadding="0" class="detailHeader">
  317. <tr>
  318. <td class="detailHeaderName">addMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  319. </tr>
  320. </table>
  321. <div class="detailBody">
  322. <code>public function addMarkers(markers:Array):void</code><span class="label">Parameters</span>
  323. <table border="0" cellspacing="0" cellpadding="0">
  324. <tr>
  325. <td width="20px"></td><td><code><span class="label">markers</span>:Array</code></td>
  326. </tr>
  327. </table>
  328. </div>
  329. <a name="clearMarkers()"></a>
  330. <table cellspacing="0" cellpadding="0" class="detailHeader">
  331. <tr>
  332. <td class="detailHeaderName">clearMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  333. </tr>
  334. </table>
  335. <div class="detailBody">
  336. <code>public function clearMarkers():void</code>
  337. </div>
  338. <a name="getStyles()"></a>
  339. <table cellspacing="0" cellpadding="0" class="detailHeader">
  340. <tr>
  341. <td class="detailHeaderName">getStyles</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  342. </tr>
  343. </table>
  344. <div class="detailBody">
  345. <code>public function getStyles():Array</code>
  346. <p></p>
  347. <span class="label">Returns</span>
  348. <table border="0" cellspacing="0" cellpadding="0">
  349. <tr>
  350. <td width="20"></td><td><code>Array</code></td>
  351. </tr>
  352. </table>
  353. </div>
  354. <a name="getTotalClusters()"></a>
  355. <table cellspacing="0" cellpadding="0" class="detailHeader">
  356. <tr>
  357. <td class="detailHeaderName">getTotalClusters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  358. </tr>
  359. </table>
  360. <div class="detailBody">
  361. <code>public function getTotalClusters():int</code>
  362. <p></p>
  363. <span class="label">Returns</span>
  364. <table border="0" cellspacing="0" cellpadding="0">
  365. <tr>
  366. <td width="20"></td><td><code>int</code></td>
  367. </tr>
  368. </table>
  369. </div>
  370. <a name="getTotalMarkers()"></a>
  371. <table cellspacing="0" cellpadding="0" class="detailHeader">
  372. <tr>
  373. <td class="detailHeaderName">getTotalMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  374. </tr>
  375. </table>
  376. <div class="detailBody">
  377. <code>public function getTotalMarkers():int</code>
  378. <p></p>
  379. <span class="label">Returns</span>
  380. <table border="0" cellspacing="0" cellpadding="0">
  381. <tr>
  382. <td width="20"></td><td><code>int</code></td>
  383. </tr>
  384. </table>
  385. </div>
  386. <a name="removeMarker()"></a>
  387. <table cellspacing="0" cellpadding="0" class="detailHeader">
  388. <tr>
  389. <td class="detailHeaderName">removeMarker</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  390. </tr>
  391. </table>
  392. <div class="detailBody">
  393. <code>public function removeMarker(marker:<a href="UnitMarker.html">UnitMarker</a>):void</code><span class="label">Parameters</span>
  394. <table border="0" cellspacing="0" cellpadding="0">
  395. <tr>
  396. <td width="20px"></td><td><code><span class="label">marker</span>:<a href="UnitMarker.html">UnitMarker</a></code></td>
  397. </tr>
  398. </table>
  399. </div>
  400. <a name="resetViewport()"></a>
  401. <table cellspacing="0" cellpadding="0" class="detailHeader">
  402. <tr>
  403. <td class="detailHeaderName">resetViewport</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  404. </tr>
  405. </table>
  406. <div class="detailBody">
  407. <code>public function resetViewport(force:Boolean = false):void</code><span class="label">Parameters</span>
  408. <table border="0" cellspacing="0" cellpadding="0">
  409. <tr>
  410. <td width="20px"></td><td><code><span class="label">force</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
  411. </tr>
  412. </table>
  413. </div>
  414. <br>
  415. <br>
  416. <hr>
  417. <br>
  418. <p></p>
  419. <center class="copyright">
  420. </center>
  421. </div>
  422. </body>
  423. </html>
  424. <!-- -->