/docs/com/google/maps/extras/gradients/MultiPolygonWithValue.html

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