/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
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
- <link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
- <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">
- <title>com.google.maps.extras.markerclusterer.MarkerClusterer</title>
- </head>
- <body>
- <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">
- <!--
- asdocTitle = 'MarkerClusterer - API Documentation';
- var baseRef = '../../../../../';
- window.onload = configPage;
- --></script>
- <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
- <tr>
- <td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All Packages</a> | <a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a> | <a href="../../../../../index.html?com/google/maps/extras/markerclusterer/MarkerClusterer.html&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 Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
- </tr>
- <tr class="titleTableRow2">
- <td align="left" id="subTitle" class="titleTableSubTitle">Class MarkerClusterer</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td>
- </tr>
- <tr class="titleTableRow3">
- <td colspan="2"> </td>
- </tr>
- </table>
- <script type="text/javascript" language="javascript">
- <!--
- 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);}
- --></script>
- <div class="MainContent">
- <table cellspacing="0" cellpadding="0" class="classHeaderTable">
- <tr>
- <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.google.maps.extras.markerclusterer</a></td>
- </tr>
- <tr>
- <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MarkerClusterer</td>
- </tr>
- </table>
- <p></p>
- This class is the entry to MarkerClusterer package, and the only class you as a developer should touch.
-
-
-
- <p></p>
- <br>
- <hr>
- </div>
- <a name="propertySummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Public Properties</div>
- <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
- <tr>
- <th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#gridSize">gridSize</a> : Number<div class="summaryTableDescription">[read-only]
- This getter property is intented for Cluster use
- </div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#map">map</a> : Map<div class="summaryTableDescription">[read-only]</div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maximumResolution">maximumResolution</a> : Number<div class="summaryTableDescription">[read-only]
- This getter property is intented for Cluster use
- </div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxZoom">maxZoom</a> : Number<div class="summaryTableDescription">[read-only]
- This getter property is intented for Cluster use
- </div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#options">options</a> : <a href="../markerclusterer/MarkerClustererOptions.html">MarkerClustererOptions</a>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#zoom">zoom</a> : Number<div class="summaryTableDescription">[read-only]
- This getter property is intented for Cluster use
- </div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- </table>
- </div>
- <a name="methodSummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Public Methods</div>
- <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
- <tr>
- <th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#MarkerClusterer()">MarkerClusterer</a>(map:Map, markers:Array, opts:<a href="MarkerClustererOptions.html">MarkerClustererOptions</a> = null)</div>
- <div class="summaryTableDescription">
-
-
- </div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <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>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#addMarkers()">addMarkers</a>(markers:Array):void</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#clearMarkers()">clearMarkers</a>():void</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#getStyles()">getStyles</a>():Array</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#getTotalClusters()">getTotalClusters</a>():int</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#getTotalMarkers()">getTotalMarkers</a>():int</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#removeMarker()">removeMarker</a>(marker:<a href="UnitMarker.html">UnitMarker</a>):void</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#resetViewport()">resetViewport</a>(force:Boolean = false):void</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">MarkerClusterer</td>
- </tr>
- </table>
- </div>
- <script type="text/javascript" language="javascript">
- <!--
- showHideInherited();
- --></script>
- <div class="MainContent">
- <a name="propertyDetail"></a>
- <div class="detailSectionHeader">Property detail</div>
- <a name="gridSize"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">gridSize</td><td class="detailHeaderType">property</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>gridSize:Number</code> [read-only]<p>
- This getter property is intented for Cluster use
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get gridSize():Number</code>
- <br>
- </div>
- <a name="map"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">map</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>map:Map</code> [read-only]<span class="label">Implementation</span>
- <br>
- <code> public function get map():Map</code>
- <br>
- </div>
- <a name="maximumResolution"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">maximumResolution</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>maximumResolution:Number</code> [read-only]<p>
- This getter property is intented for Cluster use
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get maximumResolution():Number</code>
- <br>
- </div>
- <a name="maxZoom"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">maxZoom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>maxZoom:Number</code> [read-only]<p>
- This getter property is intented for Cluster use
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get maxZoom():Number</code>
- <br>
- </div>
- <a name="options"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">options</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public var options:<a href="../markerclusterer/MarkerClustererOptions.html">MarkerClustererOptions</a></code>
- </div>
- <a name="zoom"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">zoom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>zoom:Number</code> [read-only]<p>
- This getter property is intented for Cluster use
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get zoom():Number</code>
- <br>
- </div>
- <a name="constructorDetail"></a>
- <div class="detailSectionHeader">Constructor detail</div>
- <a name="MarkerClusterer()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">MarkerClusterer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function MarkerClusterer(map:Map, markers:Array, opts:<a href="MarkerClustererOptions.html">MarkerClustererOptions</a> = null)</code><p>
-
-
- </p><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">map</span>:Map</code></td>
- </tr>
- <tr>
- <td class="paramSpacer"> </td>
- </tr>
- <tr>
- <td width="20px"></td><td><code><span class="label">markers</span>:Array</code></td>
- </tr>
- <tr>
- <td class="paramSpacer"> </td>
- </tr>
- <tr>
- <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>
- </tr>
- </table>
- </div>
- <a name="methodDetail"></a>
- <div class="detailSectionHeader">Method detail</div>
- <a name="addMarker()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">addMarker</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
- </tr>
- </table>
- <div class="detailBody">
- <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>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">marker</span>:<a href="UnitMarker.html">UnitMarker</a></code></td>
- </tr>
- <tr>
- <td class="paramSpacer"> </td>
- </tr>
- <tr>
- <td width="20px"></td><td><code><span class="label">opt_isNodraw</span>:Boolean</code></td>
- </tr>
- <tr>
- <td class="paramSpacer"> </td>
- </tr>
- <tr>
- <td width="20px"></td><td><code><span class="label">isAdded</span>:Boolean</code></td>
- </tr>
- <tr>
- <td class="paramSpacer"> </td>
- </tr>
- <tr>
- <td width="20px"></td><td><code><span class="label">clusters</span>:Array</code></td>
- </tr>
- <tr>
- <td class="paramSpacer"> </td>
- </tr>
- <tr>
- <td width="20px"></td><td><code><span class="label">opt_isNoCheck</span>:Boolean</code></td>
- </tr>
- </table>
- </div>
- <a name="addMarkers()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">addMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function addMarkers(markers:Array):void</code><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">markers</span>:Array</code></td>
- </tr>
- </table>
- </div>
- <a name="clearMarkers()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">clearMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function clearMarkers():void</code>
- </div>
- <a name="getStyles()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">getStyles</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function getStyles():Array</code>
- <p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>Array</code></td>
- </tr>
- </table>
- </div>
- <a name="getTotalClusters()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">getTotalClusters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function getTotalClusters():int</code>
- <p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>int</code></td>
- </tr>
- </table>
- </div>
- <a name="getTotalMarkers()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">getTotalMarkers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function getTotalMarkers():int</code>
- <p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>int</code></td>
- </tr>
- </table>
- </div>
- <a name="removeMarker()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">removeMarker</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function removeMarker(marker:<a href="UnitMarker.html">UnitMarker</a>):void</code><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">marker</span>:<a href="UnitMarker.html">UnitMarker</a></code></td>
- </tr>
- </table>
- </div>
- <a name="resetViewport()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">resetViewport</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function resetViewport(force:Boolean = false):void</code><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">force</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
- </tr>
- </table>
- </div>
- <br>
- <br>
- <hr>
- <br>
- <p></p>
- <center class="copyright">
- </center>
- </div>
- </body>
- </html>
- <!-- -->