/docs/com/google/maps/extras/gradients/ValueColorGradient.html
http://gmaps-utility-library-flash.googlecode.com/ · HTML · 404 lines · 395 code · 0 blank · 9 comment · 0 complexity · 3b994716bd0bc46266f54919e7b14376 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="ValueColorGradient,com.google.maps.extras.gradients.ValueColorGradient,maxPercent,minPercent,colorForValue,containsValue,flatGradientAt,numFlatGradients,toString" name="keywords">
- <title>com.google.maps.extras.gradients.ValueColorGradient</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 = 'ValueColorGradient - 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/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>
- </tr>
- <tr class="titleTableRow2">
- <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>
- </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 ValueColorGradient"); 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.gradients</a></td>
- </tr>
- <tr>
- <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ValueColorGradient</td>
- </tr>
- <tr>
- <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>
- </tr>
- <tr>
- <td class="classHeaderTableLabel">Subclasses</td><td><a href="../gradients/GradientControl.html">GradientControl</a></td>
- </tr>
- </table>
- <p></p>
- ValueColorGradient is an internal class that's used by GradientControl
- objects for storing final gradient lists. Certain functions are declared
- public only so that the subclasses could have them public too.
- <p></p>
- <br>
- <hr>
- </div>
- <a name="propertySummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Public Properties</div>
- <div class="showHideLinks">
- <div class="hideInheritedProperty" id="hideInheritedProperty">
- <a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
- </div>
- <div class="showInheritedProperty" id="showInheritedProperty">
- <a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
- </div>
- </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="hideInheritedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#maxPercent">maxPercent</a> : Number<div class="summaryTableDescription">
- </div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</td>
- </tr>
- <tr class="hideInheritedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="hideInheritedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#minPercent">minPercent</a> : Number<div class="summaryTableDescription">
- </div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</td>
- </tr>
- <tr class="hideInheritedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- </table>
- </div>
- <a name="protectedPropertySummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Protected Properties</div>
- <div class="showHideLinks">
- <div class="hideInheritedProtectedProperty" id="hideInheritedProtectedProperty">
- <a onclick="javascript:setInheritedVisible(false,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Properties</a>
- </div>
- <div class="showInheritedProtectedProperty" id="showInheritedProtectedProperty">
- <a onclick="javascript:setInheritedVisible(true,'ProtectedProperty');" href="#protectedPropertySummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Properties</a>
- </div>
- </div>
- <table id="summaryTableProtectedProperty" class="summaryTable hideInheritedProtectedProperty" cellpadding="3" cellspacing="0">
- <tr>
- <th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
- </tr>
- <tr class="hideInheritedProtectedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="hideInheritedProtectedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="hideInheritedProtectedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="hideInheritedProtectedProperty">
- <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>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- </table>
- </div>
- <a name="methodSummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Public Methods</div>
- <div class="showHideLinks">
- <div class="hideInheritedMethod" id="hideInheritedMethod">
- <a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
- </div>
- <div class="showInheritedMethod" id="showInheritedMethod">
- <a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
- </div>
- </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="#ValueColorGradient()">ValueColorGradient</a>()</div>
- <div class="summaryTableDescription">
- Class constructor
- </div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#colorForValue()">colorForValue</a>(someValue:Number):Number</div>
- <div class="summaryTableDescription">
- Apply the scaling calculations to translate the specfied number
- into a color within this object's range.</div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#containsValue()">containsValue</a>(someValue:Number):Boolean</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="Range.html#getRgbColorDict()">getRgbColorDict</a>():Object</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="Range.html#getValueDict()">getValueDict</a>():Object</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="hideInheritedMethod">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="Range.html#rgbColorDictString()">rgbColorDictString</a>():String</div>
- <div class="summaryTableDescription">
- String representation of the color ranges of this object
- </div>
- </td><td class="summaryTableOwnerCol"><a href="Range.html">Range</a></td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#toString()">toString</a>():String</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</td>
- </tr>
- </table>
- </div>
- <a name="protectedMethodSummary"></a>
- <div class="summarySection">
- <div class="summaryTableTitle">Protected Methods</div>
- <table id="summaryTableProtectedMethod" 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="#flatGradientAt()">flatGradientAt</a>(i:int):<a href="../gradients/ValueColorGradient.html">ValueColorGradient</a>
- </div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</td>
- </tr>
- <tr class="">
- <td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
- <div class="summarySignature">
- <a class="signatureLink" href="#numFlatGradients()">numFlatGradients</a>():int</div>
- <div class="summaryTableDescription"></div>
- </td><td class="summaryTableOwnerCol">ValueColorGradient</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="maxPercent"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">maxPercent</td><td class="detailHeaderType">property</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>maxPercent:Number</code> [read-write]<p>
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get maxPercent():Number</code>
- <br>
- <code> public function set maxPercent(value:Number):void</code>
- <br>
- <br>
- <span class="label">Throws</span>
- <br>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code></code> — Always.
- </td>
- </tr>
- </table>
- </div>
- <a name="minPercent"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">minPercent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>minPercent:Number</code> [read-write]<p>
- </p><span class="label">Implementation</span>
- <br>
- <code> public function get minPercent():Number</code>
- <br>
- <code> public function set minPercent(value:Number):void</code>
- <br>
- <br>
- <span class="label">Throws</span>
- <br>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code></code> — Always.
- </td>
- </tr>
- </table>
- </div>
- <a name="constructorDetail"></a>
- <div class="detailSectionHeader">Constructor detail</div>
- <a name="ValueColorGradient()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">ValueColorGradient</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function ValueColorGradient()</code><p>
- Class constructor
- </p></div>
- <a name="methodDetail"></a>
- <div class="detailSectionHeader">Method detail</div>
- <a name="colorForValue()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">colorForValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function colorForValue(someValue:Number):Number</code><p>
- Apply the scaling calculations to translate the specfied number
- into a color within this object's range.
- </p><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">someValue</span>:Number</code></td>
- </tr>
- </table>
- <p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>Number</code></td>
- </tr>
- </table>
- </div>
- <a name="containsValue()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">containsValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public function containsValue(someValue:Number):Boolean</code><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">someValue</span>:Number</code></td>
- </tr>
- </table>
- <p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>Boolean</code></td>
- </tr>
- </table>
- </div>
- <a name="flatGradientAt()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">flatGradientAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>protected function flatGradientAt(i:int):<a href="../gradients/ValueColorGradient.html">ValueColorGradient</a></code><span class="label">Parameters</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20px"></td><td><code><span class="label">i</span>:int</code></td>
- </tr>
- </table>
- <p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code><a href="../gradients/ValueColorGradient.html">ValueColorGradient</a></code></td>
- </tr>
- </table>
- </div>
- <a name="numFlatGradients()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">numFlatGradients</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>protected function numFlatGradients():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="toString()"></a>
- <table cellspacing="0" cellpadding="0" class="detailHeader">
- <tr>
- <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
- </tr>
- </table>
- <div class="detailBody">
- <code>public override function toString():String</code>
- <p></p>
- <span class="label">Returns</span>
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td width="20"></td><td><code>String</code></td>
- </tr>
- </table>
- </div>
- <br>
- <br>
- <hr>
- <br>
- <p></p>
- <center class="copyright">
- </center>
- </div>
- </body>
- </html>
- <!-- -->