<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Gradient</title> <base target="classFrame"> <link rel="stylesheet" href="../resources/css/reference.css" type="text/css"> <link rel="stylesheet" href="../resources/css/style.css" type="text/css"> <link rel="stylesheet" href="../resources/css/paperscript.css" type="text/css"> <link rel="stylesheet" href="../resources/css/codemirror.css" type="text/css"> <script src="../resources/js/bootstrap.js" type="text/javascript"></script> <script src="../resources/js/paper.js" type="text/javascript"></script> <script src="../resources/js/codemirror.js" type="text/javascript"></script> <script src="../resources/js/reference.js" type="text/javascript"></script> </head> <body class="reference"> <div class="reference-class"> <h1>Gradient</h1> <p>The Gradient object.</p> </div> <!-- ============================== constructors ========================= --> <div class="reference-members"><h2>Constructors</h2> <div id="gradient-stops-member" class="member"> <div id="gradient-stops-link" class="member-link"> <a name="gradient-stops" href="#" onClick="return toggleMember('gradient-stops', false);"><tt><b>Gradient</b>(stops[, type])</tt></a> </div> <div id="gradient-stops-description" class="member-description hidden"> <div class="member-header"> <div class="member-title"> <div class="member-link"> <a href="#" onClick="return toggleMember('gradient-stops', false);"><tt><b>Gradient</b>(stops[, type])</tt></a> </div> </div> <div class="member-close"><input type="button" value="Close" onClick="toggleMember('gradient-stops', false);"></div> <div class="clear"></div> </div> <div class="member-text"> <p>Creates a gradient object</p> <ul><b>Parameters:</b> <li> <tt>stops:</tt> Array of <a href="../classes/GradientStop.html"><tt>GradientStop</tt></a> objects </li> <li> <tt>type:</tt> <tt>String</tt> — 'linear' or 'radial' — optional, default: <tt>'linear'</tt> </li> </ul> </div> </div> </div> </div> <!-- ============================== properties ========================= --> <div class="reference-members"><h2>Operators</h2> <div id="equals-member" class="member"> <div id="equals-link" class="member-link"> <a name="equals" href="#" onClick="return toggleMember('equals', false);"><tt><tt><b>==</b> Gradient</tt></tt></a> </div> <div id="equals-description" class="member-description hidden"> <div class="member-header"> <div class="member-title"> <div class="member-link"> <a href="#" onClick="return toggleMember('equals', false);"><tt><b>==</b> Gradient</tt></a> </div> </div> <div class="member-close"><input type="button" value="Close" onClick="toggleMember('equals', false);"></div> <div class="clear"></div> </div> <div class="member-text"> <p>Checks whether the gradient is equal to the supplied gradient.</p> <ul><b>Returns:</b> <li> <tt><tt>Boolean</tt></tt> — <tt>true</tt> they are equal, <tt>false</tt> otherwise </li> </ul> </div> </div> </div> </div> <div class="reference-members"><h2>Properties</h2> <div id="stops-member" class="member"> <div id="stops-link" class="member-link"> <a name="stops" href="#" onClick="return toggleMember('stops', false);"><tt><b>stops</b></tt></a> </div> <div id="stops-description" class="member-description hidden"> <div class="member-header"> <div class="member-title"> <div class="member-link"> <a href="#" onClick="return toggleMember('stops', false);"><tt><b>stops</b></tt></a> </div> </div> <div class="member-close"><input type="button" value="Close" onClick="toggleMember('stops', false);"></div> <div class="clear"></div> </div> <div class="member-text"> <p>The gradient stops on the gradient ramp.</p> <ul><b>Type:</b> <li> Array of <a href="../classes/GradientStop.html"><tt>GradientStop</tt></a> objects </li> </ul> </div> </div> </div> </div> <!-- ============================== methods ================================ --> <div class="reference-members"><h2>Methods</h2> <div id="clone-member" class="member"> <div id="clone-link" class="member-link"> <a name="clone" href="#" onClick="return toggleMember('clone', false);"><tt><b>clone</b>()</tt></a> </div> <div id="clone-description" class="member-description hidden"> <div class="member-header"> <div class="member-title"> <div class="member-link"> <a href="#" onClick="return toggleMember('clone', false);"><tt><b>clone</b>()</tt></a> </div> </div> <div class="member-close"><input type="button" value="Close" onClick="toggleMember('clone', false);"></div> <div class="clear"></div> </div> <div class="member-text"> <ul><b>Returns:</b> <li> <tt><a href="../classes/Gradient.html"><tt>Gradient</tt></a></tt> — a copy of the gradient </li> </ul> </div> </div> </div> </div> <!-- =========================== copyright notice ========================= --> <p class="footer">Copyright © 2011 <a href="http://www.lehni.org" target="_blank">Jürg Lehni</a> & <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p> <div class="content-end"></div> </body>