/docs/com/google/maps/extras/gradients/ValueColorGradient.html
HTML | 404 lines | 395 code | 0 blank | 9 comment | 0 complexity | 3b994716bd0bc46266f54919e7b14376 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="ValueColorGradient,com.google.maps.extras.gradients.ValueColorGradient,maxPercent,minPercent,colorForValue,containsValue,flatGradientAt,numFlatGradients,toString" name="keywords"> 8<title>com.google.maps.extras.gradients.ValueColorGradient</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 = 'ValueColorGradient - 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/ValueColorGradient.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 ValueColorGradient</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 ValueColorGradient"); 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 ValueColorGradient</td> 39</tr> 40<tr> 41<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ValueColorGradient <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/GradientControl.html">GradientControl</a></td> 45</tr> 46</table> 47<p></p> 48 ValueColorGradient is an internal class that's used by GradientControl 49 objects for storing final gradient lists. Certain functions are declared 50 public only so that the subclasses could have them public too. 51 <p></p> 52<br> 53<hr> 54</div> 55<a name="propertySummary"></a> 56<div class="summarySection"> 57<div class="summaryTableTitle">Public Properties</div> 58<div class="showHideLinks"> 59<div class="hideInheritedProperty" id="hideInheritedProperty"> 60<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a> 61</div> 62<div class="showInheritedProperty" id="showInheritedProperty"> 63<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a> 64</div> 65</div> 66<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0"> 67<tr> 68<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th> 69</tr> 70<tr class="hideInheritedProperty"> 71<td class="summaryTablePaddingCol"> </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> 72</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 73</tr> 74<tr class=""> 75<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxPercent">maxPercent</a> : Number<div class="summaryTableDescription"> 76 </div> 77</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 78</tr> 79<tr class="hideInheritedProperty"> 80<td class="summaryTablePaddingCol"> </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> 81</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 82</tr> 83<tr class="hideInheritedProperty"> 84<td class="summaryTablePaddingCol"> </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> 85</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 86</tr> 87<tr class=""> 88<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#minPercent">minPercent</a> : Number<div class="summaryTableDescription"> 89 </div> 90</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 91</tr> 92<tr class="hideInheritedProperty"> 93<td class="summaryTablePaddingCol"> </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> 94</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 95</tr> 96</table> 97</div> 98<a name="protectedPropertySummary"></a> 99<div class="summarySection"> 100<div class="summaryTableTitle">Protected Properties</div> 101<div class="showHideLinks"> 102<div class="hideInheritedProtectedProperty" id="hideInheritedProtectedProperty"> 103<a onclick="javascript:setInheritedVisible(false,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Properties</a> 104</div> 105<div class="showInheritedProtectedProperty" id="showInheritedProtectedProperty"> 106<a onclick="javascript:setInheritedVisible(true,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Properties</a> 107</div> 108</div> 109<table id="summaryTableProtectedProperty" class="summaryTable hideInheritedProtectedProperty" cellpadding="3" cellspacing="0"> 110<tr> 111<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th> 112</tr> 113<tr class="hideInheritedProtectedProperty"> 114<td class="summaryTablePaddingCol"> </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> 115</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 116</tr> 117<tr class="hideInheritedProtectedProperty"> 118<td class="summaryTablePaddingCol"> </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> 119</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 120</tr> 121<tr class="hideInheritedProtectedProperty"> 122<td class="summaryTablePaddingCol"> </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> 123</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 124</tr> 125<tr class="hideInheritedProtectedProperty"> 126<td class="summaryTablePaddingCol"> </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> 127</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 128</tr> 129</table> 130</div> 131<a name="methodSummary"></a> 132<div class="summarySection"> 133<div class="summaryTableTitle">Public Methods</div> 134<div class="showHideLinks"> 135<div class="hideInheritedMethod" id="hideInheritedMethod"> 136<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a> 137</div> 138<div class="showInheritedMethod" id="showInheritedMethod"> 139<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a> 140</div> 141</div> 142<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0"> 143<tr> 144<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th> 145</tr> 146<tr class=""> 147<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 148<div class="summarySignature"> 149<a class="signatureLink" href="#ValueColorGradient()">ValueColorGradient</a>()</div> 150<div class="summaryTableDescription"> 151 Class constructor 152 </div> 153</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 154</tr> 155<tr class=""> 156<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 157<div class="summarySignature"> 158<a class="signatureLink" href="#colorForValue()">colorForValue</a>(someValue:Number):Number</div> 159<div class="summaryTableDescription"> 160 Apply the scaling calculations to translate the specfied number 161 into a color within this object's range.</div> 162</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 163</tr> 164<tr class=""> 165<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 166<div class="summarySignature"> 167<a class="signatureLink" href="#containsValue()">containsValue</a>(someValue:Number):Boolean</div> 168<div class="summaryTableDescription"></div> 169</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 170</tr> 171<tr class="hideInheritedMethod"> 172<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"> 173<div class="summarySignature"> 174<a class="signatureLink" href="Range.html#getRgbColorDict()">getRgbColorDict</a>():Object</div> 175<div class="summaryTableDescription"></div> 176</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 177</tr> 178<tr class="hideInheritedMethod"> 179<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"> 180<div class="summarySignature"> 181<a class="signatureLink" href="Range.html#getValueDict()">getValueDict</a>():Object</div> 182<div class="summaryTableDescription"></div> 183</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 184</tr> 185<tr class="hideInheritedMethod"> 186<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"> 187<div class="summarySignature"> 188<a class="signatureLink" href="Range.html#rgbColorDictString()">rgbColorDictString</a>():String</div> 189<div class="summaryTableDescription"> 190 String representation of the color ranges of this object 191 </div> 192</td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td> 193</tr> 194<tr class=""> 195<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 196<div class="summarySignature"> 197<a class="signatureLink" href="#toString()">toString</a>():String</div> 198<div class="summaryTableDescription"></div> 199</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 200</tr> 201</table> 202</div> 203<a name="protectedMethodSummary"></a> 204<div class="summarySection"> 205<div class="summaryTableTitle">Protected Methods</div> 206<table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0"> 207<tr> 208<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th> 209</tr> 210<tr class=""> 211<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 212<div class="summarySignature"> 213<a class="signatureLink" href="#flatGradientAt()">flatGradientAt</a>(i:int):<a href="../gradients/ValueColorGradient.html">ValueColorGradient</a> 214</div> 215<div class="summaryTableDescription"></div> 216</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 217</tr> 218<tr class=""> 219<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"> 220<div class="summarySignature"> 221<a class="signatureLink" href="#numFlatGradients()">numFlatGradients</a>():int</div> 222<div class="summaryTableDescription"></div> 223</td><td class="summaryTableOwnerCol">ValueColorGradient</td> 224</tr> 225</table> 226</div> 227<script type="text/javascript" language="javascript"> 228<!-- 229showHideInherited(); 230--></script> 231<div class="MainContent"> 232<a name="propertyDetail"></a> 233<div class="detailSectionHeader">Property detail</div> 234<a name="maxPercent"></a> 235<table cellspacing="0" cellpadding="0" class="detailHeader"> 236<tr> 237<td class="detailHeaderName">maxPercent</td><td class="detailHeaderType">property</td> 238</tr> 239</table> 240<div class="detailBody"> 241<code>maxPercent:Number</code> [read-write]<p> 242 </p><span class="label">Implementation</span> 243<br> 244<code> public function get maxPercent():Number</code> 245<br> 246<code> public function set maxPercent(value:Number):void</code> 247<br> 248<br> 249<span class="label">Throws</span> 250<br> 251<table border="0" cellspacing="0" cellpadding="0"> 252<tr> 253<td width="20"></td><td><code></code> — Always. 254 </td> 255</tr> 256</table> 257</div> 258<a name="minPercent"></a> 259<table cellspacing="0" cellpadding="0" class="detailHeader"> 260<tr> 261<td class="detailHeaderName">minPercent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td> 262</tr> 263</table> 264<div class="detailBody"> 265<code>minPercent:Number</code> [read-write]<p> 266 </p><span class="label">Implementation</span> 267<br> 268<code> public function get minPercent():Number</code> 269<br> 270<code> public function set minPercent(value:Number):void</code> 271<br> 272<br> 273<span class="label">Throws</span> 274<br> 275<table border="0" cellspacing="0" cellpadding="0"> 276<tr> 277<td width="20"></td><td><code></code> — Always. 278 </td> 279</tr> 280</table> 281</div> 282<a name="constructorDetail"></a> 283<div class="detailSectionHeader">Constructor detail</div> 284<a name="ValueColorGradient()"></a> 285<table cellspacing="0" cellpadding="0" class="detailHeader"> 286<tr> 287<td class="detailHeaderName">ValueColorGradient</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td> 288</tr> 289</table> 290<div class="detailBody"> 291<code>public function ValueColorGradient()</code><p> 292 Class constructor 293 </p></div> 294<a name="methodDetail"></a> 295<div class="detailSectionHeader">Method detail</div> 296<a name="colorForValue()"></a> 297<table cellspacing="0" cellpadding="0" class="detailHeader"> 298<tr> 299<td class="detailHeaderName">colorForValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td> 300</tr> 301</table> 302<div class="detailBody"> 303<code>public function colorForValue(someValue:Number):Number</code><p> 304 Apply the scaling calculations to translate the specfied number 305 into a color within this object's range. 306 </p><span class="label">Parameters</span> 307<table border="0" cellspacing="0" cellpadding="0"> 308<tr> 309<td width="20px"></td><td><code><span class="label">someValue</span>:Number</code></td> 310</tr> 311</table> 312<p></p> 313<span class="label">Returns</span> 314<table border="0" cellspacing="0" cellpadding="0"> 315<tr> 316<td width="20"></td><td><code>Number</code></td> 317</tr> 318</table> 319</div> 320<a name="containsValue()"></a> 321<table cellspacing="0" cellpadding="0" class="detailHeader"> 322<tr> 323<td class="detailHeaderName">containsValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 324</tr> 325</table> 326<div class="detailBody"> 327<code>public function containsValue(someValue:Number):Boolean</code><span class="label">Parameters</span> 328<table border="0" cellspacing="0" cellpadding="0"> 329<tr> 330<td width="20px"></td><td><code><span class="label">someValue</span>:Number</code></td> 331</tr> 332</table> 333<p></p> 334<span class="label">Returns</span> 335<table border="0" cellspacing="0" cellpadding="0"> 336<tr> 337<td width="20"></td><td><code>Boolean</code></td> 338</tr> 339</table> 340</div> 341<a name="flatGradientAt()"></a> 342<table cellspacing="0" cellpadding="0" class="detailHeader"> 343<tr> 344<td class="detailHeaderName">flatGradientAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 345</tr> 346</table> 347<div class="detailBody"> 348<code>protected function flatGradientAt(i:int):<a href="../gradients/ValueColorGradient.html">ValueColorGradient</a></code><span class="label">Parameters</span> 349<table border="0" cellspacing="0" cellpadding="0"> 350<tr> 351<td width="20px"></td><td><code><span class="label">i</span>:int</code></td> 352</tr> 353</table> 354<p></p> 355<span class="label">Returns</span> 356<table border="0" cellspacing="0" cellpadding="0"> 357<tr> 358<td width="20"></td><td><code><a href="../gradients/ValueColorGradient.html">ValueColorGradient</a></code></td> 359</tr> 360</table> 361</div> 362<a name="numFlatGradients()"></a> 363<table cellspacing="0" cellpadding="0" class="detailHeader"> 364<tr> 365<td class="detailHeaderName">numFlatGradients</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 366</tr> 367</table> 368<div class="detailBody"> 369<code>protected function numFlatGradients():int</code> 370<p></p> 371<span class="label">Returns</span> 372<table border="0" cellspacing="0" cellpadding="0"> 373<tr> 374<td width="20"></td><td><code>int</code></td> 375</tr> 376</table> 377</div> 378<a name="toString()"></a> 379<table cellspacing="0" cellpadding="0" class="detailHeader"> 380<tr> 381<td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td> 382</tr> 383</table> 384<div class="detailBody"> 385<code>public override function toString():String</code> 386<p></p> 387<span class="label">Returns</span> 388<table border="0" cellspacing="0" cellpadding="0"> 389<tr> 390<td width="20"></td><td><code>String</code></td> 391</tr> 392</table> 393</div> 394<br> 395<br> 396<hr> 397<br> 398<p></p> 399<center class="copyright"> 400</center> 401</div> 402</body> 403</html> 404<!-- -->