summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/GradientStop.html
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2011-11-20 23:44:58 +0900
committerRandy Morgan <[email protected]>2011-11-20 23:44:58 +0900
commit2d0ac967e94c5944ccccf9adad8da5a9d082df29 (patch)
tree194839f4ce3687bd51577bab7e75dddc21ad5c9c /doc/Axlsx/GradientStop.html
parent9d210b319c43141120c42aa740fd4a8670e5029a (diff)
downloadcaxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.tar.gz
caxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.zip
pushing docs
Diffstat (limited to 'doc/Axlsx/GradientStop.html')
-rw-r--r--doc/Axlsx/GradientStop.html526
1 files changed, 526 insertions, 0 deletions
diff --git a/doc/Axlsx/GradientStop.html b/doc/Axlsx/GradientStop.html
new file mode 100644
index 00000000..eacf1c92
--- /dev/null
+++ b/doc/Axlsx/GradientStop.html
@@ -0,0 +1,526 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+ Class: Axlsx::GradientStop
+
+ &mdash; Documentation by YARD 0.7.3
+
+</title>
+
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+ relpath = '..';
+ if (relpath != '') relpath += '/';
+</script>
+
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (G)</a> &raquo;
+ <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
+ &raquo;
+ <span class="title">GradientStop</span>
+
+
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+ <div id="search">
+
+ <a id="class_list_link" href="#">Class List</a>
+
+ <a id="method_list_link" href="#">Method List</a>
+
+ <a id="file_list_link" href="#">File List</a>
+
+</div>
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Class: Axlsx::GradientStop
+
+
+
+</h1>
+
+<dl class="box">
+
+ <dt class="r1">Inherits:</dt>
+ <dd class="r1">
+ <span class="inheritName">Object</span>
+
+ <ul class="fullTree">
+ <li>Object</li>
+
+ <li class="next">Axlsx::GradientStop</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+
+
+
+
+
+
+
+
+
+ <dt class="r2 last">Defined in:</dt>
+ <dd class="r2 last">lib/axlsx/stylesheet/gradient_stop.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
+ <p>
+The GradientStop object represents a color point in a gradient.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+ <h3>See Also:</h3>
+ <ul class="see">
+
+ <li>Office XML Part 1 ยง18.8.24</li>
+
+ </ul>
+
+</div>
+
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+ <ul class="summary">
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#color-instance_method" title="#color (instance method)">- (Color) <strong>color</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+The color for this gradient stop.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#position-instance_method" title="#position (instance method)">- (Float) <strong>position</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+The position of the color.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+
+ <h2>
+ Instance Method Summary
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (GradientStop) <strong>initialize</strong>(color, position) </a>
+
+
+
+ </span>
+
+ <span class="note title constructor">constructor</span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Creates a new GradientStop object.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Serializes the gradientStop.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+<div id="constructor_details" class="method_details_list">
+ <h2>Constructor Details</h2>
+
+ <div class="method_details first">
+ <p class="signature first" id="initialize-instance_method">
+
+ - (<tt><span class='object_link'><a href="" title="Axlsx::GradientStop (class)">GradientStop</a></span></tt>) <strong>initialize</strong>(color, position)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Creates a new GradientStop object
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Parameters:</h3>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>color</span>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span>
+
+
+
+ </li>
+
+ <li>
+
+ <span class='name'>position</span>
+
+
+ <span class='type'>(<tt>Float</tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+18
+19
+20
+21</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 18</span>
+
+<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='color identifier id'>color</span><span class='comma token'>,</span> <span class='position identifier id'>position</span><span class='rparen token'>)</span>
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='color identifier id'>color</span>
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span> <span class='assign token'>=</span> <span class='position identifier id'>position</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+</div>
+
+ <div id="instance_attr_details" class="attr_details">
+ <h2>Instance Attribute Details</h2>
+
+
+ <span id="color=-instance_method"></span>
+ <span id="color-instance_method"></span>
+ <div class="method_details first">
+ <p class="signature first" id="color-instance_method">
+
+ - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>color</strong>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+The color for this gradient stop
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
+ <h3>See Also:</h3>
+ <ul class="see">
+
+ <li><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></li>
+
+ </ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+9
+10
+11</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 9</span>
+
+<span class='def def kw'>def</span> <span class='color identifier id'>color</span>
+ <span class='@color ivar id'>@color</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+
+ <span id="position=-instance_method"></span>
+ <span id="position-instance_method"></span>
+ <div class="method_details ">
+ <p class="signature " id="position-instance_method">
+
+ - (<tt>Float</tt>) <strong>position</strong>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+The position of the color
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Float</tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+13
+14
+15</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 13</span>
+
+<span class='def def kw'>def</span> <span class='position identifier id'>position</span>
+ <span class='@position ivar id'>@position</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
+
+
+ <div class="method_details first">
+ <p class="signature first" id="to_xml-instance_method">
+
+ - (<tt>String</tt>) <strong>to_xml</strong>(xml)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Serializes the gradientStop
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Parameters:</h3>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>xml</span>
+
+
+ <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
+
+
+
+ &mdash;
+ <div class='inline'><p>
+The document builder instance this objects xml will be added to.
+</p>
+</div>
+
+ </li>
+
+</ul>
+
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+29</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 29</span>
+
+<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='stop identifier id'>stop</span><span class='lparen token'>(</span><span class='symbol val'>:position</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span><span class='rbrace token'>}</span> <span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Sun Nov 20 23:43:48 2011 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.7.3 (ruby-1.8.7).
+</div>
+
+ </body>
+</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2026-05-06 10:12:38 +0000