/docs/com/google/maps/extras/gradients/MultiPolygonWithValue.html
HTML | 370 lines | 355 code | 6 blank | 9 comment | 0 complexity | ad416dcfb6199a4bfe1bb2351bf2034a 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="MultiPolygonWithValue,com.google.maps.extras.gradients.MultiPolygonWithValue,amount,id,addEventListener,addPolygonFromEncoded,addPolygonFromLatLng,addToMap,fromGeojsonMultiPolygon,removeEventListener,removeFromMap,setOptions" name="keywords"> 8<title>com.google.maps.extras.gradients.MultiPolygonWithValue</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 = 'MultiPolygonWithValue - 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 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/gradients/MultiPolygonWithValue.html&com/google/maps/extras/gradients/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> 20</tr> 21<tr class="titleTableRow2"> 22<td align="left" id="subTitle" class="titleTableSubTitle">Class MultiPolygonWithValue</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td> 23</tr> 24<tr class="titleTableRow3"> 25<td colspan="2"> </td> 26</tr> 27</table> 28<script type="text/javascript" language="javascript"> 29<!-- 30if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class MultiPolygonWithValue"); 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.gradients</a></td> 36</tr> 37<tr> 38<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MultiPolygonWithValue</td> 39</tr> 40</table> 41<p></p> 42 MultiPolygonWithValue is a wrapper class for Flash Maps API polygons 43 that associates a multipolygon geometry with a numerical value. 44 45 <p></p> 46<br> 47<hr> 48</div> 49<a name="propertySummary"></a> 50<div class="summarySection"> 51<div class="summaryTableTitle">Public Properties</div> 52<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0"> 53<tr> 54<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th> 55</tr> 56<tr class=""> 57<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#amount">amount</a> : Number = NaN<div class="summaryTableDescription"></div> 58</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 59</tr> 60<tr class=""> 61<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#id">id</a> : String = ""<div class="summaryTableDescription"></div> 62</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 63</tr> 64</table> 65</div> 66<a name="methodSummary"></a> 67<div class="summarySection"> 68<div class="summaryTableTitle">Public Methods</div> 69<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0"> 70<tr> 71<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th> 72</tr> 73<tr class=""> 74<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 75<div class="summarySignature"> 76<a class="signatureLink" href="#MultiPolygonWithValue()">MultiPolygonWithValue</a>()</div> 77<div class="summaryTableDescription"></div> 78</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 79</tr> 80<tr class=""> 81<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 82<div class="summarySignature"> 83<a class="signatureLink" href="#addEventListener()">addEventListener</a>(eventType:String, f:Function):void</div> 84<div class="summaryTableDescription"> 85 Add an event listener to all constituent polygons 86 </div> 87</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 88</tr> 89<tr class=""> 90<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 91<div class="summarySignature"> 92<a class="signatureLink" href="#addPolygonFromEncoded()">addPolygonFromEncoded</a>(polylineList:Array, options:PolygonOptions = null):void</div> 93<div class="summaryTableDescription"> 94 Add a Polygon constructed from encoded polylines 95 96 </div> 97</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 98</tr> 99<tr class=""> 100<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 101<div class="summarySignature"> 102<a class="signatureLink" href="#addPolygonFromLatLng()">addPolygonFromLatLng</a>(points:Array, options:PolygonOptions = null):void</div> 103<div class="summaryTableDescription"> 104 Add a Polygon to the current list of polygons.</div> 105</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 106</tr> 107<tr class=""> 108<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 109<div class="summarySignature"> 110<a class="signatureLink" href="#addToMap()">addToMap</a>(map:Map):void</div> 111<div class="summaryTableDescription"> 112 Add all constituent polygons to a map 113 </div> 114</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 115</tr> 116<tr class=""> 117<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 118<div class="summarySignature"> 119<a class="signatureLink" href="#fromGeojsonMultiPolygon()">fromGeojsonMultiPolygon</a>(geojsonMultiPolygon:Object, options:PolygonOptions = null):void</div> 120<div class="summaryTableDescription"> 121 Add a Polygon constructed from a geojson object 122 123 </div> 124</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 125</tr> 126<tr class=""> 127<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 128<div class="summarySignature"> 129<a class="signatureLink" href="#removeEventListener()">removeEventListener</a>(eventType:String, f:Function):void</div> 130<div class="summaryTableDescription"> 131 Remove an event listener from all constituent polygons 132 </div> 133</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 134</tr> 135<tr class=""> 136<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 137<div class="summarySignature"> 138<a class="signatureLink" href="#removeFromMap()">removeFromMap</a>(map:Map):void</div> 139<div class="summaryTableDescription"> 140 Remove all constituent polygons from a map 141 </div> 142</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 143</tr> 144<tr class=""> 145<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 146<div class="summarySignature"> 147<a class="signatureLink" href="#setOptions()">setOptions</a>(options:PolygonOptions):void</div> 148<div class="summaryTableDescription"> 149 Change polygon options on all constituent polygons 150 </div> 151</td><td class="summaryTableOwnerCol">MultiPolygonWithValue</td> 152</tr> 153</table> 154</div> 155<script type="text/javascript" language="javascript"> 156<!-- 157showHideInherited(); 158--></script> 159<div class="MainContent"> 160<a name="propertyDetail"></a> 161<div class="detailSectionHeader">Property detail</div> 162<a name="amount"></a> 163<table cellspacing="0" cellpadding="0" class="detailHeader"> 164<tr> 165<td class="detailHeaderName">amount</td><td class="detailHeaderType">property</td> 166</tr> 167</table> 168<div class="detailBody"> 169<code>public var amount:Number = NaN</code> 170</div> 171<a name="id"></a> 172<table cellspacing="0" cellpadding="0" class="detailHeader"> 173<tr> 174<td class="detailHeaderName">id</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td> 175</tr> 176</table> 177<div class="detailBody"> 178<code>public var id:String = ""</code> 179</div> 180<a name="constructorDetail"></a> 181<div class="detailSectionHeader">Constructor detail</div> 182<a name="MultiPolygonWithValue()"></a> 183<table cellspacing="0" cellpadding="0" class="detailHeader"> 184<tr> 185<td class="detailHeaderName">MultiPolygonWithValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td> 186</tr> 187</table> 188<div class="detailBody"> 189<code>public function MultiPolygonWithValue()</code> 190</div> 191<a name="methodDetail"></a> 192<div class="detailSectionHeader">Method detail</div> 193<a name="addEventListener()"></a> 194<table cellspacing="0" cellpadding="0" class="detailHeader"> 195<tr> 196<td class="detailHeaderName">addEventListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td> 197</tr> 198</table> 199<div class="detailBody"> 200<code>public function addEventListener(eventType:String, f:Function):void</code><p> 201 Add an event listener to all constituent polygons 202 </p><span class="label">Parameters</span> 203<table border="0" cellspacing="0" cellpadding="0"> 204<tr> 205<td width="20px"></td><td><code><span class="label">eventType</span>:String</code></td> 206</tr> 207<tr> 208<td class="paramSpacer"> </td> 209</tr> 210<tr> 211<td width="20px"></td><td><code><span class="label">f</span>:Function</code></td> 212</tr> 213</table> 214</div> 215<a name="addPolygonFromEncoded()"></a> 216<table cellspacing="0" cellpadding="0" class="detailHeader"> 217<tr> 218<td class="detailHeaderName">addPolygonFromEncoded</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 219</tr> 220</table> 221<div class="detailBody"> 222<code>public function addPolygonFromEncoded(polylineList:Array, options:PolygonOptions = null):void</code><p> 223 Add a Polygon constructed from encoded polylines 224 225 </p><span class="label">Parameters</span> 226<table border="0" cellspacing="0" cellpadding="0"> 227<tr> 228<td width="20px"></td><td><code><span class="label">polylineList</span>:Array</code> — Array of encoded polylines 229 </td> 230</tr> 231<tr> 232<td class="paramSpacer"> </td> 233</tr> 234<tr> 235<td width="20px"></td><td><code><span class="label">options</span>:PolygonOptions</code> (default = <code>null</code>)<code></code> — PolygonOptions 236 </td> 237</tr> 238</table> 239</div> 240<a name="addPolygonFromLatLng()"></a> 241<table cellspacing="0" cellpadding="0" class="detailHeader"> 242<tr> 243<td class="detailHeaderName">addPolygonFromLatLng</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 244</tr> 245</table> 246<div class="detailBody"> 247<code>public function addPolygonFromLatLng(points:Array, options:PolygonOptions = null):void</code><p> 248 Add a Polygon to the current list of polygons. 249 250 </p><span class="label">Parameters</span> 251<table border="0" cellspacing="0" cellpadding="0"> 252<tr> 253<td width="20px"></td><td><code><span class="label">points</span>:Array</code> — Array of LatLng coordinates 254 </td> 255</tr> 256<tr> 257<td class="paramSpacer"> </td> 258</tr> 259<tr> 260<td width="20px"></td><td><code><span class="label">options</span>:PolygonOptions</code> (default = <code>null</code>)<code></code> — PolygonOptions 261 </td> 262</tr> 263</table> 264</div> 265<a name="addToMap()"></a> 266<table cellspacing="0" cellpadding="0" class="detailHeader"> 267<tr> 268<td class="detailHeaderName">addToMap</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 269</tr> 270</table> 271<div class="detailBody"> 272<code>public function addToMap(map:Map):void</code><p> 273 Add all constituent polygons to a map 274 </p><span class="label">Parameters</span> 275<table border="0" cellspacing="0" cellpadding="0"> 276<tr> 277<td width="20px"></td><td><code><span class="label">map</span>:Map</code></td> 278</tr> 279</table> 280</div> 281<a name="fromGeojsonMultiPolygon()"></a> 282<table cellspacing="0" cellpadding="0" class="detailHeader"> 283<tr> 284<td class="detailHeaderName">fromGeojsonMultiPolygon</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 285</tr> 286</table> 287<div class="detailBody"> 288<code>public function fromGeojsonMultiPolygon(geojsonMultiPolygon:Object, options:PolygonOptions = null):void</code><p> 289 Add a Polygon constructed from a geojson object 290 291 </p><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">geojsonMultiPolygon</span>:Object</code> — A geojson object 295 </td> 296</tr> 297<tr> 298<td class="paramSpacer"> </td> 299</tr> 300<tr> 301<td width="20px"></td><td><code><span class="label">options</span>:PolygonOptions</code> (default = <code>null</code>)<code></code> — PolygonOptions 302 </td> 303</tr> 304</table> 305</div> 306<a name="removeEventListener()"></a> 307<table cellspacing="0" cellpadding="0" class="detailHeader"> 308<tr> 309<td class="detailHeaderName">removeEventListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 310</tr> 311</table> 312<div class="detailBody"> 313<code>public function removeEventListener(eventType:String, f:Function):void</code><p> 314 Remove an event listener from all constituent polygons 315 </p><span class="label">Parameters</span> 316<table border="0" cellspacing="0" cellpadding="0"> 317<tr> 318<td width="20px"></td><td><code><span class="label">eventType</span>:String</code></td> 319</tr> 320<tr> 321<td class="paramSpacer"> </td> 322</tr> 323<tr> 324<td width="20px"></td><td><code><span class="label">f</span>:Function</code></td> 325</tr> 326</table> 327</div> 328<a name="removeFromMap()"></a> 329<table cellspacing="0" cellpadding="0" class="detailHeader"> 330<tr> 331<td class="detailHeaderName">removeFromMap</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 332</tr> 333</table> 334<div class="detailBody"> 335<code>public function removeFromMap(map:Map):void</code><p> 336 Remove all constituent polygons from a map 337 </p><span class="label">Parameters</span> 338<table border="0" cellspacing="0" cellpadding="0"> 339<tr> 340<td width="20px"></td><td><code><span class="label">map</span>:Map</code></td> 341</tr> 342</table> 343</div> 344<a name="setOptions()"></a> 345<table cellspacing="0" cellpadding="0" class="detailHeader"> 346<tr> 347<td class="detailHeaderName">setOptions</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 348</tr> 349</table> 350<div class="detailBody"> 351<code>public function setOptions(options:PolygonOptions):void</code><p> 352 Change polygon options on all constituent polygons 353 </p><span class="label">Parameters</span> 354<table border="0" cellspacing="0" cellpadding="0"> 355<tr> 356<td width="20px"></td><td><code><span class="label">options</span>:PolygonOptions</code></td> 357</tr> 358</table> 359</div> 360<br> 361<br> 362<hr> 363<br> 364<p></p> 365<center class="copyright"> 366</center> 367</div> 368</body> 369</html> 370<!-- -->