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

http://gmaps-utility-library-flash.googlecode.com/ · HTML · 532 lines · 520 code · 3 blank · 9 comment · 0 complexity · a00a561658adc11a9ba3ec1445de148e 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="GradientRule,com.google.maps.extras.gradients.GradientRule,maxPercent,minPercent,applyGradientToValueList,createFlatGradient,createValueColorGradients,fillFromNext,fillFromPrev,fillMax,fillMin,fillValueColorFromChildren,fillValueColorFromParent,fillValueColorFromSiblings,fromXML" name="keywords">
  8. <title>com.google.maps.extras.gradients.GradientRule</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 = 'GradientRule - 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/GradientRule.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;GradientRule</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 GradientRule"); 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 GradientRule</td>
  39. </tr>
  40. <tr>
  41. <td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">GradientRule <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../../images/inherit-arrow.gif"> <a href="Range.html">Range</a></td>
  42. </tr>
  43. <tr>
  44. <td class="classHeaderTableLabel">Subclasses</td><td><a href="../gradients/GradientRuleList.html">GradientRuleList</a></td>
  45. </tr>
  46. </table>
  47. <p></p>
  48. GradientRule is a basic building block for gradient configurations.
  49. One GradientRule object corresponds to a gradient transition
  50. between two color values. Together with other GradientRule objects,
  51. it sholud be contained in GradientRuleList to form a full gradient config.
  52. <p></p>
  53. <br>
  54. <hr>
  55. </div>
  56. <a name="propertySummary"></a>
  57. <div class="summarySection">
  58. <div class="summaryTableTitle">Public Properties</div>
  59. <div class="showHideLinks">
  60. <div class="hideInheritedProperty" id="hideInheritedProperty">
  61. <a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
  62. </div>
  63. <div class="showInheritedProperty" id="showInheritedProperty">
  64. <a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
  65. </div>
  66. </div>
  67. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
  68. <tr>
  69. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  70. </tr>
  71. <tr class="hideInheritedProperty">
  72. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#maxColor">maxColor</a> : Number = NaN<div class="summaryTableDescription"></div>
  73. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  74. </tr>
  75. <tr class="">
  76. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxPercent">maxPercent</a> : Number<div class="summaryTableDescription">[write-only]
  77. End of a percentage range.</div>
  78. </td><td class="summaryTableOwnerCol">GradientRule</td>
  79. </tr>
  80. <tr class="hideInheritedProperty">
  81. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#maxValue">maxValue</a> : Number = NaN<div class="summaryTableDescription"></div>
  82. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  83. </tr>
  84. <tr class="hideInheritedProperty">
  85. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#minColor">minColor</a> : Number = NaN<div class="summaryTableDescription"></div>
  86. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  87. </tr>
  88. <tr class="">
  89. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#minPercent">minPercent</a> : Number<div class="summaryTableDescription">[write-only]
  90. Start of a percentage range.</div>
  91. </td><td class="summaryTableOwnerCol">GradientRule</td>
  92. </tr>
  93. <tr class="hideInheritedProperty">
  94. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#minValue">minValue</a> : Number = NaN<div class="summaryTableDescription"></div>
  95. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  96. </tr>
  97. </table>
  98. </div>
  99. <a name="protectedPropertySummary"></a>
  100. <div class="summarySection">
  101. <div class="summaryTableTitle">Protected Properties</div>
  102. <div class="showHideLinks">
  103. <div class="hideInheritedProtectedProperty" id="hideInheritedProtectedProperty">
  104. <a onclick="javascript:setInheritedVisible(false,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Properties</a>
  105. </div>
  106. <div class="showInheritedProtectedProperty" id="showInheritedProtectedProperty">
  107. <a onclick="javascript:setInheritedVisible(true,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Properties</a>
  108. </div>
  109. </div>
  110. <table id="summaryTableProtectedProperty" class="summaryTable hideInheritedProtectedProperty" cellpadding="3" cellspacing="0">
  111. <tr>
  112. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  113. </tr>
  114. <tr class="hideInheritedProtectedProperty">
  115. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#_maxPercent">_maxPercent</a> : Number = NaN<div class="summaryTableDescription"> Backing for minPercent.</div>
  116. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  117. </tr>
  118. <tr class="hideInheritedProtectedProperty">
  119. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#MAX_PERCENT">MAX_PERCENT</a> : Number = 100<div class="summaryTableDescription">[static]</div>
  120. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  121. </tr>
  122. <tr class="hideInheritedProtectedProperty">
  123. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#_minPercent">_minPercent</a> : Number = NaN<div class="summaryTableDescription"></div>
  124. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  125. </tr>
  126. <tr class="hideInheritedProtectedProperty">
  127. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="Range.html#MIN_PERCENT">MIN_PERCENT</a> : Number = 0<div class="summaryTableDescription">[static]</div>
  128. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  129. </tr>
  130. </table>
  131. </div>
  132. <a name="methodSummary"></a>
  133. <div class="summarySection">
  134. <div class="summaryTableTitle">Public Methods</div>
  135. <div class="showHideLinks">
  136. <div class="hideInheritedMethod" id="hideInheritedMethod">
  137. <a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
  138. </div>
  139. <div class="showInheritedMethod" id="showInheritedMethod">
  140. <a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
  141. </div>
  142. </div>
  143. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
  144. <tr>
  145. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  146. </tr>
  147. <tr class="">
  148. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  149. <div class="summarySignature">
  150. <a class="signatureLink" href="#GradientRule()">GradientRule</a>()</div>
  151. <div class="summaryTableDescription"></div>
  152. </td><td class="summaryTableOwnerCol">GradientRule</td>
  153. </tr>
  154. <tr class="">
  155. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  156. <div class="summarySignature">
  157. <a class="signatureLink" href="#applyGradientToValueList()">applyGradientToValueList</a>(dataValues:Array):<a href="../gradients/GradientControl.html">GradientControl</a>
  158. </div>
  159. <div class="summaryTableDescription">
  160. Create a new instance of this class from an XML config
  161. </div>
  162. </td><td class="summaryTableOwnerCol">GradientRule</td>
  163. </tr>
  164. <tr class="">
  165. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  166. <div class="summarySignature">
  167. <a class="signatureLink" href="#createValueColorGradients()">createValueColorGradients</a>(parent:<a href="Range.html">Range</a>):Array</div>
  168. <div class="summaryTableDescription"></div>
  169. </td><td class="summaryTableOwnerCol">GradientRule</td>
  170. </tr>
  171. <tr class="">
  172. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  173. <div class="summarySignature">
  174. <a class="signatureLink" href="#fillFromNext()">fillFromNext</a>(next:<a href="GradientRule.html">GradientRule</a>, fillPercent:Boolean = true):void</div>
  175. <div class="summaryTableDescription"></div>
  176. </td><td class="summaryTableOwnerCol">GradientRule</td>
  177. </tr>
  178. <tr class="">
  179. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  180. <div class="summarySignature">
  181. <a class="signatureLink" href="#fillFromPrev()">fillFromPrev</a>(prev:<a href="GradientRule.html">GradientRule</a>, fillPercent:Boolean = true):void</div>
  182. <div class="summaryTableDescription"></div>
  183. </td><td class="summaryTableOwnerCol">GradientRule</td>
  184. </tr>
  185. <tr class="">
  186. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  187. <div class="summarySignature">
  188. <a class="signatureLink" href="#fillMax()">fillMax</a>(other:<a href="GradientRule.html">GradientRule</a>):void</div>
  189. <div class="summaryTableDescription"></div>
  190. </td><td class="summaryTableOwnerCol">GradientRule</td>
  191. </tr>
  192. <tr class="">
  193. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  194. <div class="summarySignature">
  195. <a class="signatureLink" href="#fillMin()">fillMin</a>(other:<a href="GradientRule.html">GradientRule</a>):void</div>
  196. <div class="summaryTableDescription"></div>
  197. </td><td class="summaryTableOwnerCol">GradientRule</td>
  198. </tr>
  199. <tr class="">
  200. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  201. <div class="summarySignature">
  202. <a class="signatureLink" href="#fillValueColorFromChildren()">fillValueColorFromChildren</a>():void</div>
  203. <div class="summaryTableDescription"></div>
  204. </td><td class="summaryTableOwnerCol">GradientRule</td>
  205. </tr>
  206. <tr class="">
  207. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  208. <div class="summarySignature">
  209. <a class="signatureLink" href="#fillValueColorFromParent()">fillValueColorFromParent</a>(parent:<a href="GradientRule.html">GradientRule</a>):void</div>
  210. <div class="summaryTableDescription"></div>
  211. </td><td class="summaryTableOwnerCol">GradientRule</td>
  212. </tr>
  213. <tr class="">
  214. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  215. <div class="summarySignature">
  216. <a class="signatureLink" href="#fillValueColorFromSiblings()">fillValueColorFromSiblings</a>():void</div>
  217. <div class="summaryTableDescription"></div>
  218. </td><td class="summaryTableOwnerCol">GradientRule</td>
  219. </tr>
  220. <tr class="">
  221. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  222. <div class="summarySignature">
  223. <a class="signatureLink" href="#fromXML()">fromXML</a>(xml:XML):<a href="../gradients/GradientRule.html">GradientRule</a>
  224. </div>
  225. <div class="summaryTableDescription">[static]
  226. Create a new instance of this class from an XML config
  227. </div>
  228. </td><td class="summaryTableOwnerCol">GradientRule</td>
  229. </tr>
  230. <tr class="hideInheritedMethod">
  231. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  232. <div class="summarySignature">
  233. <a class="signatureLink" href="Range.html#getRgbColorDict()">getRgbColorDict</a>():Object</div>
  234. <div class="summaryTableDescription"></div>
  235. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  236. </tr>
  237. <tr class="hideInheritedMethod">
  238. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  239. <div class="summarySignature">
  240. <a class="signatureLink" href="Range.html#getValueDict()">getValueDict</a>():Object</div>
  241. <div class="summaryTableDescription"></div>
  242. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  243. </tr>
  244. <tr class="hideInheritedMethod">
  245. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  246. <div class="summarySignature">
  247. <a class="signatureLink" href="Range.html#rgbColorDictString()">rgbColorDictString</a>():String</div>
  248. <div class="summaryTableDescription">
  249. String representation of the color ranges of this object
  250. </div>
  251. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  252. </tr>
  253. <tr class="hideInheritedMethod">
  254. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
  255. <div class="summarySignature">
  256. <a class="signatureLink" href="Range.html#toString()">toString</a>():String</div>
  257. <div class="summaryTableDescription">
  258. String representation of this object
  259. </div>
  260. </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
  261. </tr>
  262. </table>
  263. </div>
  264. <a name="protectedMethodSummary"></a>
  265. <div class="summarySection">
  266. <div class="summaryTableTitle">Protected Methods</div>
  267. <table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0">
  268. <tr>
  269. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
  270. </tr>
  271. <tr class="">
  272. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
  273. <div class="summarySignature">
  274. <a class="signatureLink" href="#createFlatGradient()">createFlatGradient</a>():<a href="../gradients/ValueColorGradient.html">ValueColorGradient</a>
  275. </div>
  276. <div class="summaryTableDescription"></div>
  277. </td><td class="summaryTableOwnerCol">GradientRule</td>
  278. </tr>
  279. </table>
  280. </div>
  281. <script type="text/javascript" language="javascript">
  282. <!--
  283. showHideInherited();
  284. --></script>
  285. <div class="MainContent">
  286. <a name="propertyDetail"></a>
  287. <div class="detailSectionHeader">Property detail</div>
  288. <a name="maxPercent"></a>
  289. <table cellspacing="0" cellpadding="0" class="detailHeader">
  290. <tr>
  291. <td class="detailHeaderName">maxPercent</td><td class="detailHeaderType">property</td>
  292. </tr>
  293. </table>
  294. <div class="detailBody">
  295. <code>maxPercent:Number</code>&nbsp;&nbsp;[write-only]<p>
  296. End of a percentage range. Values are forced to be less than
  297. MAX_PERCENT.
  298. </p><span class="label">Implementation</span>
  299. <br>
  300. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set maxPercent(value:Number):void</code>
  301. <br>
  302. </div>
  303. <a name="minPercent"></a>
  304. <table cellspacing="0" cellpadding="0" class="detailHeader">
  305. <tr>
  306. <td class="detailHeaderName">minPercent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
  307. </tr>
  308. </table>
  309. <div class="detailBody">
  310. <code>minPercent:Number</code>&nbsp;&nbsp;[write-only]<p>
  311. Start of a percentage range. Values are forced to be greater than
  312. MIN_PERCENT.
  313. </p><span class="label">Implementation</span>
  314. <br>
  315. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function set minPercent(value:Number):void</code>
  316. <br>
  317. </div>
  318. <a name="constructorDetail"></a>
  319. <div class="detailSectionHeader">Constructor detail</div>
  320. <a name="GradientRule()"></a>
  321. <table cellspacing="0" cellpadding="0" class="detailHeader">
  322. <tr>
  323. <td class="detailHeaderName">GradientRule</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
  324. </tr>
  325. </table>
  326. <div class="detailBody">
  327. <code>public function GradientRule()</code>
  328. </div>
  329. <a name="methodDetail"></a>
  330. <div class="detailSectionHeader">Method detail</div>
  331. <a name="applyGradientToValueList()"></a>
  332. <table cellspacing="0" cellpadding="0" class="detailHeader">
  333. <tr>
  334. <td class="detailHeaderName">applyGradientToValueList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
  335. </tr>
  336. </table>
  337. <div class="detailBody">
  338. <code>public function applyGradientToValueList(dataValues:Array):<a href="../gradients/GradientControl.html">GradientControl</a></code><p>
  339. Create a new instance of this class from an XML config
  340. </p><span class="label">Parameters</span>
  341. <table border="0" cellspacing="0" cellpadding="0">
  342. <tr>
  343. <td width="20px"></td><td><code><span class="label">dataValues</span>:Array</code> &mdash; An array of numbers
  344. </td>
  345. </tr>
  346. </table>
  347. <p></p>
  348. <span class="label">Returns</span>
  349. <table border="0" cellspacing="0" cellpadding="0">
  350. <tr>
  351. <td width="20"></td><td><code><a href="../gradients/GradientControl.html">GradientControl</a></code> &mdash;
  352. A new GradientControl objects with this object's
  353. gradient config applied to the specified values
  354. </td>
  355. </tr>
  356. </table>
  357. </div>
  358. <a name="createFlatGradient()"></a>
  359. <table cellspacing="0" cellpadding="0" class="detailHeader">
  360. <tr>
  361. <td class="detailHeaderName">createFlatGradient</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  362. </tr>
  363. </table>
  364. <div class="detailBody">
  365. <code>protected function createFlatGradient():<a href="../gradients/ValueColorGradient.html">ValueColorGradient</a></code>
  366. <p></p>
  367. <span class="label">Returns</span>
  368. <table border="0" cellspacing="0" cellpadding="0">
  369. <tr>
  370. <td width="20"></td><td><code><a href="../gradients/ValueColorGradient.html">ValueColorGradient</a></code></td>
  371. </tr>
  372. </table>
  373. </div>
  374. <a name="createValueColorGradients()"></a>
  375. <table cellspacing="0" cellpadding="0" class="detailHeader">
  376. <tr>
  377. <td class="detailHeaderName">createValueColorGradients</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  378. </tr>
  379. </table>
  380. <div class="detailBody">
  381. <code>public function createValueColorGradients(parent:<a href="Range.html">Range</a>):Array</code><span class="label">Parameters</span>
  382. <table border="0" cellspacing="0" cellpadding="0">
  383. <tr>
  384. <td width="20px"></td><td><code><span class="label">parent</span>:<a href="Range.html">Range</a></code></td>
  385. </tr>
  386. </table>
  387. <p></p>
  388. <span class="label">Returns</span>
  389. <table border="0" cellspacing="0" cellpadding="0">
  390. <tr>
  391. <td width="20"></td><td><code>Array</code></td>
  392. </tr>
  393. </table>
  394. </div>
  395. <a name="fillFromNext()"></a>
  396. <table cellspacing="0" cellpadding="0" class="detailHeader">
  397. <tr>
  398. <td class="detailHeaderName">fillFromNext</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  399. </tr>
  400. </table>
  401. <div class="detailBody">
  402. <code>public function fillFromNext(next:<a href="GradientRule.html">GradientRule</a>, fillPercent:Boolean = true):void</code><span class="label">Parameters</span>
  403. <table border="0" cellspacing="0" cellpadding="0">
  404. <tr>
  405. <td width="20px"></td><td><code><span class="label">next</span>:<a href="GradientRule.html">GradientRule</a></code></td>
  406. </tr>
  407. <tr>
  408. <td class="paramSpacer">&nbsp;</td>
  409. </tr>
  410. <tr>
  411. <td width="20px"></td><td><code><span class="label">fillPercent</span>:Boolean</code> (default = <code>true</code>)<code></code></td>
  412. </tr>
  413. </table>
  414. </div>
  415. <a name="fillFromPrev()"></a>
  416. <table cellspacing="0" cellpadding="0" class="detailHeader">
  417. <tr>
  418. <td class="detailHeaderName">fillFromPrev</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  419. </tr>
  420. </table>
  421. <div class="detailBody">
  422. <code>public function fillFromPrev(prev:<a href="GradientRule.html">GradientRule</a>, fillPercent:Boolean = true):void</code><span class="label">Parameters</span>
  423. <table border="0" cellspacing="0" cellpadding="0">
  424. <tr>
  425. <td width="20px"></td><td><code><span class="label">prev</span>:<a href="GradientRule.html">GradientRule</a></code></td>
  426. </tr>
  427. <tr>
  428. <td class="paramSpacer">&nbsp;</td>
  429. </tr>
  430. <tr>
  431. <td width="20px"></td><td><code><span class="label">fillPercent</span>:Boolean</code> (default = <code>true</code>)<code></code></td>
  432. </tr>
  433. </table>
  434. </div>
  435. <a name="fillMax()"></a>
  436. <table cellspacing="0" cellpadding="0" class="detailHeader">
  437. <tr>
  438. <td class="detailHeaderName">fillMax</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  439. </tr>
  440. </table>
  441. <div class="detailBody">
  442. <code>public function fillMax(other:<a href="GradientRule.html">GradientRule</a>):void</code><span class="label">Parameters</span>
  443. <table border="0" cellspacing="0" cellpadding="0">
  444. <tr>
  445. <td width="20px"></td><td><code><span class="label">other</span>:<a href="GradientRule.html">GradientRule</a></code></td>
  446. </tr>
  447. </table>
  448. </div>
  449. <a name="fillMin()"></a>
  450. <table cellspacing="0" cellpadding="0" class="detailHeader">
  451. <tr>
  452. <td class="detailHeaderName">fillMin</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  453. </tr>
  454. </table>
  455. <div class="detailBody">
  456. <code>public function fillMin(other:<a href="GradientRule.html">GradientRule</a>):void</code><span class="label">Parameters</span>
  457. <table border="0" cellspacing="0" cellpadding="0">
  458. <tr>
  459. <td width="20px"></td><td><code><span class="label">other</span>:<a href="GradientRule.html">GradientRule</a></code></td>
  460. </tr>
  461. </table>
  462. </div>
  463. <a name="fillValueColorFromChildren()"></a>
  464. <table cellspacing="0" cellpadding="0" class="detailHeader">
  465. <tr>
  466. <td class="detailHeaderName">fillValueColorFromChildren</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  467. </tr>
  468. </table>
  469. <div class="detailBody">
  470. <code>public function fillValueColorFromChildren():void</code>
  471. </div>
  472. <a name="fillValueColorFromParent()"></a>
  473. <table cellspacing="0" cellpadding="0" class="detailHeader">
  474. <tr>
  475. <td class="detailHeaderName">fillValueColorFromParent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  476. </tr>
  477. </table>
  478. <div class="detailBody">
  479. <code>public function fillValueColorFromParent(parent:<a href="GradientRule.html">GradientRule</a>):void</code><span class="label">Parameters</span>
  480. <table border="0" cellspacing="0" cellpadding="0">
  481. <tr>
  482. <td width="20px"></td><td><code><span class="label">parent</span>:<a href="GradientRule.html">GradientRule</a></code></td>
  483. </tr>
  484. </table>
  485. </div>
  486. <a name="fillValueColorFromSiblings()"></a>
  487. <table cellspacing="0" cellpadding="0" class="detailHeader">
  488. <tr>
  489. <td class="detailHeaderName">fillValueColorFromSiblings</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  490. </tr>
  491. </table>
  492. <div class="detailBody">
  493. <code>public function fillValueColorFromSiblings():void</code>
  494. </div>
  495. <a name="fromXML()"></a>
  496. <table cellspacing="0" cellpadding="0" class="detailHeader">
  497. <tr>
  498. <td class="detailHeaderName">fromXML</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
  499. </tr>
  500. </table>
  501. <div class="detailBody">
  502. <code>public static function fromXML(xml:XML):<a href="../gradients/GradientRule.html">GradientRule</a></code><p>
  503. Create a new instance of this class from an XML config
  504. </p><span class="label">Parameters</span>
  505. <table border="0" cellspacing="0" cellpadding="0">
  506. <tr>
  507. <td width="20px"></td><td><code><span class="label">xml</span>:XML</code> &mdash; An XML configuration specifying gradient config
  508. </td>
  509. </tr>
  510. </table>
  511. <p></p>
  512. <span class="label">Returns</span>
  513. <table border="0" cellspacing="0" cellpadding="0">
  514. <tr>
  515. <td width="20"></td><td><code><a href="../gradients/GradientRule.html">GradientRule</a></code></td>
  516. </tr>
  517. </table>
  518. </div>
  519. <br>
  520. <br>
  521. <hr>
  522. <br>
  523. <p></p>
  524. <center class="copyright">
  525. </center>
  526. </div>
  527. </body>
  528. </html>
  529. <!-- -->