summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/GradientFill.html
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
committerRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
commit8cf0296bbc16e8eb535e9af932eed2557d5e66d2 (patch)
tree9c5a214c0ac49b56d08be769fbe0634ac1e5b0a4 /doc/Axlsx/GradientFill.html
parent076be316935180341d7ee7a9335281a4b18d1fa9 (diff)
downloadcaxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz
caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/GradientFill.html')
-rw-r--r--doc/Axlsx/GradientFill.html1004
1 files changed, 0 insertions, 1004 deletions
diff --git a/doc/Axlsx/GradientFill.html b/doc/Axlsx/GradientFill.html
deleted file mode 100644
index 30fa6143..00000000
--- a/doc/Axlsx/GradientFill.html
+++ /dev/null
@@ -1,1004 +0,0 @@
-<!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::GradientFill
-
- &mdash; AXLSX
-
-</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">GradientFill</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::GradientFill
-
-
-
-</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::GradientFill</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_fill.rb</dd>
-
-</dl>
-<div class="clear"></div>
-
-<h2>Overview</h2><div class="docstring">
- <div class="discussion">
-
-<p>A GradientFill defines the color and positioning for gradiant cell fill.</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="#bottom-instance_method" title="#bottom (instance method)">- (Float) <strong>bottom</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Percentage format bottom.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#degree-instance_method" title="#degree (instance method)">- (Float) <strong>degree</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Angle of the linear gradient.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#left-instance_method" title="#left (instance method)">- (Float) <strong>left</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Percentage format left.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#right-instance_method" title="#right (instance method)">- (Float) <strong>right</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Percentage format right.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#stop-instance_method" title="#stop (instance method)">- (SimpleTypedList) <strong>stop</strong> </a>
-
-
-
- </span>
-
-
- <span class="note title readonly">readonly</span>
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Collection of stop objects.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#top-instance_method" title="#top (instance method)">- (Float) <strong>top</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Percentage format top.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>The type of gradient.</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)">- (GradientFill) <strong>initialize</strong>(options = {}) </a>
-
-
-
- </span>
-
- <span class="note title constructor">constructor</span>
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Creates a new GradientFill 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 gradientFill.</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::GradientFill (class)">GradientFill</a></span></tt>) <strong>initialize</strong>(options = {})
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Creates a new GradientFill object</p>
-
-
- </div>
-</div>
-<div class="tags">
- <h3>Parameters:</h3>
-<ul class="param">
-
- <li>
-
- <span class='name'>options</span>
-
-
- <span class='type'>(<tt>Hash</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>{}</tt>)</em>
-
-
- &mdash;
- <div class='inline'>
-<p>a customizable set of options</p>
-</div>
-
- </li>
-
-</ul>
-
-
-
-
- <h3>Options Hash (<tt>options</tt>):</h3>
- <ul class="option">
-
- <li>
- <span class="name">type</span>
- <span class="type">(<tt>Symbol</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">degree</span>
- <span class="type">(<tt>Float</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">left</span>
- <span class="type">(<tt>Float</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">right</span>
- <span class="type">(<tt>Float</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">top</span>
- <span class="type">(<tt>Float</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">bottom</span>
- <span class="type">(<tt>Float</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- </ul>
-
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-46
-47
-48
-49
-50
-51
-52</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 46</span>
-
-<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
- <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='symbol val'>:linear</span>
- <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span>
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>&quot;#{o[0]}=&quot;</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span>
- <span class='end end kw'>end</span>
- <span class='@stop ivar id'>@stop</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='GradientStop constant id'>GradientStop</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="bottom=-instance_method"></span>
- <span id="bottom-instance_method"></span>
- <div class="method_details first">
- <p class="signature first" id="bottom-instance_method">
-
- - (<tt>Float</tt>) <strong>bottom</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Percentage format bottom</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">
-
-
-33
-34
-35</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 33</span>
-
-<span class='def def kw'>def</span> <span class='bottom identifier id'>bottom</span>
- <span class='@bottom ivar id'>@bottom</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="degree=-instance_method"></span>
- <span id="degree-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="degree-instance_method">
-
- - (<tt>Float</tt>) <strong>degree</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Angle of the linear gradient</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">
-
-
-17
-18
-19</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 17</span>
-
-<span class='def def kw'>def</span> <span class='degree identifier id'>degree</span>
- <span class='@degree ivar id'>@degree</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="left=-instance_method"></span>
- <span id="left-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="left-instance_method">
-
- - (<tt>Float</tt>) <strong>left</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Percentage format left</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">
-
-
-21
-22
-23</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 21</span>
-
-<span class='def def kw'>def</span> <span class='left identifier id'>left</span>
- <span class='@left ivar id'>@left</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="right=-instance_method"></span>
- <span id="right-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="right-instance_method">
-
- - (<tt>Float</tt>) <strong>right</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Percentage format right</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">
-
-
-25
-26
-27</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 25</span>
-
-<span class='def def kw'>def</span> <span class='right identifier id'>right</span>
- <span class='@right ivar id'>@right</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id=""></span>
- <span id="stop-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="stop-instance_method">
-
- - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>stop</strong> <span class="extras">(readonly)</span>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Collection of stop objects</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<h3>Returns:</h3>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
-
-
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-37
-38
-39</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 37</span>
-
-<span class='def def kw'>def</span> <span class='stop identifier id'>stop</span>
- <span class='@stop ivar id'>@stop</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="top=-instance_method"></span>
- <span id="top-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="top-instance_method">
-
- - (<tt>Float</tt>) <strong>top</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Percentage format top</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">
-
-
-29
-30
-31</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 29</span>
-
-<span class='def def kw'>def</span> <span class='top identifier id'>top</span>
- <span class='@top ivar id'>@top</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="type=-instance_method"></span>
- <span id="type-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="type-instance_method">
-
- - (<tt>Symbol</tt>) <strong>type</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
- <div class="note notetag">
- <strong>Note:</strong>
- <div class='inline'>
-<p>valid options are</p>
-
-<pre class="code"><span class='symbol val'>:linear</span>
-<span class='symbol val'>:path</span>
-</pre>
-</div>
- </div>
-
-
-<p>The type of gradient.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<h3>Returns:</h3>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Symbol</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_fill.rb', line 13</span>
-
-<span class='def def kw'>def</span> <span class='type identifier id'>type</span>
- <span class='@type ivar id'>@type</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 gradientFill</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">
-
-
-70
-71
-72
-73
-74</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 70</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='gradientFill identifier id'>gradientFill</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:stop</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
- <span class='@stop ivar id'>@stop</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='s identifier id'>s</span><span class='bitor op'>|</span> <span class='s identifier id'>s</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='rbrace token'>}</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
-
-</div>
-
- <div id="footer">
- Generated on Wed Nov 30 08:46:27 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