summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/Series.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Axlsx/Series.html')
-rw-r--r--doc/Axlsx/Series.html326
1 files changed, 125 insertions, 201 deletions
diff --git a/doc/Axlsx/Series.html b/doc/Axlsx/Series.html
index 1b6792b5..f93a1220 100644
--- a/doc/Axlsx/Series.html
+++ b/doc/Axlsx/Series.html
@@ -6,7 +6,7 @@
<title>
Class: Axlsx::Series
- &mdash; Documentation by YARD 0.7.3
+ &mdash; AXLSX
</title>
@@ -97,16 +97,14 @@
<div class="note notetag">
<strong>Note:</strong>
- <div class='inline'><p>
-The recommended way to manage series is to use Chart#add_series
-</p>
+ <div class='inline'>
+<p>The recommended way to manage series is to use Chart#add_series</p>
</div>
</div>
-<p>
-A Series defines the common series attributes and is the super class for
-all concrete series types.
-</p>
+
+<p>A Series defines the common series attributes and is the super class for
+all concrete series types.</p>
</div>
@@ -151,9 +149,8 @@ all concrete series types.
- <span class="summary_desc"><div class='inline'><p>
-The chart that owns this series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>The chart that owns this series.</p>
</div></span>
</li>
@@ -162,14 +159,14 @@ The chart that owns this series.
<li class="public ">
<span class="summary_signature">
- <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
+ <a href="#title-instance_method" title="#title (instance method)">- (SeriesTitle) <strong>title</strong> </a>
</span>
- <span class="note title readonly">readonly</span>
+
@@ -178,53 +175,60 @@ The chart that owns this series.
- <span class="summary_desc"><div class='inline'><p>
-The index of this series in the chart&#8217;s series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>The title of the series.</p>
</div></span>
</li>
- <li class="public ">
+ </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="#order-instance_method" title="#order (instance method)">- (Integer) <strong>order</strong> </a>
+ <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
</span>
-
-
-
- <span class="summary_desc"><div class='inline'><p>
-The order of this series in the chart&#8217;s series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>The index of this series in the chart's series.</p>
</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
- <a href="#title-instance_method" title="#title (instance method)">- (SeriesTitle) <strong>title</strong> </a>
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Series) <strong>initialize</strong>(chart, options = {}) </a>
</span>
+ <span class="note title constructor">constructor</span>
-
-
@@ -232,38 +236,22 @@ The order of this series in the chart&#8217;s series.
- <span class="summary_desc"><div class='inline'><p>
-The title of the series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>Creates a new series.</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)">- (Series) <strong>initialize</strong>(chart, options = {}) </a>
+ <a href="#order-instance_method" title="#order (instance method)">- (Integer) <strong>order</strong> </a>
</span>
- <span class="note title constructor">constructor</span>
-
@@ -271,9 +259,8 @@ The title of the series.
- <span class="summary_desc"><div class='inline'><p>
-Creates a new series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>The order of this series in the chart's series.</p>
</div></span>
</li>
@@ -282,7 +269,7 @@ Creates a new series.
<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>
+ <a href="#order%3D-instance_method" title="#order= (instance method)">- (Object) <strong>order=</strong>(v) </a>
@@ -295,10 +282,7 @@ Creates a new series.
- <span class="summary_desc"><div class='inline'><p>
-Serializes the series.
-</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
@@ -318,9 +302,8 @@ Serializes the series.
</p><div class="docstring">
<div class="discussion">
- <p>
-Creates a new series
-</p>
+
+<p>Creates a new series</p>
</div>
@@ -352,9 +335,8 @@ Creates a new series
&mdash;
- <div class='inline'><p>
-a customizable set of options
-</p>
+ <div class='inline'>
+<p>a customizable set of options</p>
</div>
</li>
@@ -397,25 +379,26 @@ a customizable set of options
<pre class="lines">
-28
-29
-30
-31
-32
-33
-34</pre>
+20
+21
+22
+23
+24
+25
+26
+27</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 28</span>
-
-<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma 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='self self kw'>self</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='chart identifier id'>chart</span>
- <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span> <span class='lshft op'>&lt;&lt;</span> <span class='self self kw'>self</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='dstring node'>&quot;#{o[0]}=&quot;</span>
- <span class='end end kw'>end</span>
-<span class='end end kw'>end</span>
-</pre>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 20</span>
+
+<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+ <span class='ivar'>@order</span> <span class='op'>=</span> <span class='kw'>nil</span>
+ <span class='kw'>self</span><span class='period'>.</span><span class='id chart'>chart</span> <span class='op'>=</span> <span class='id chart'>chart</span>
+ <span class='ivar'>@chart</span><span class='period'>.</span><span class='id series'>series</span> <span class='op'>&lt;&lt;</span> <span class='kw'>self</span>
+ <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span>
+ <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span>
+ <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -438,9 +421,8 @@ a customizable set of options
</p><div class="docstring">
<div class="discussion">
- <p>
-The chart that owns this series
-</p>
+
+<p>The chart that owns this series</p>
</div>
@@ -474,30 +456,28 @@ The chart that owns this series
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 10</span>
-<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span>
- <span class='@chart ivar id'>@chart</span>
-<span class='end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id chart'>chart</span>
+ <span class='ivar'>@chart</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
- <span id=""></span>
- <span id="index-instance_method"></span>
+ <span id="title=-instance_method"></span>
+ <span id="title-instance_method"></span>
<div class="method_details ">
- <p class="signature " id="index-instance_method">
+ <p class="signature " id="title-instance_method">
- - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span>
+ - (<tt><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span></tt>) <strong>title</strong>
</p><div class="docstring">
<div class="discussion">
- <p>
-The index of this series in the chart&#8217;s series.
-</p>
+
+<p>The title of the series</p>
</div>
@@ -510,7 +490,7 @@ The index of this series in the chart&#8217;s series.
<li>
- <span class='type'>(<tt>Integer</tt>)</span>
+ <span class='type'>(<tt><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span></tt>)</span>
@@ -531,31 +511,32 @@ The index of this series in the chart&#8217;s series.
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 14</span>
-<span class='def def kw'>def</span> <span class='index identifier id'>index</span>
- <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span>
-<span class='end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id title'>title</span>
+ <span class='ivar'>@title</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
-
- <span id="order=-instance_method"></span>
- <span id="order-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="order-instance_method">
+ </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="index-instance_method">
- - (<tt>Integer</tt>) <strong>order</strong>
+ - (<tt>Integer</tt>) <strong>index</strong>
</p><div class="docstring">
<div class="discussion">
- <p>
-The order of this series in the chart&#8217;s series. By default the order
-is the index of the series.
-</p>
+
+<p>The index of this series in the chart's series.</p>
</div>
@@ -582,37 +563,33 @@ is the index of the series.
<pre class="lines">
-18
-19
-20</pre>
+31
+32
+33</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 18</span>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 31</span>
-<span class='def def kw'>def</span> <span class='order identifier id'>order</span>
- <span class='@order ivar id'>@order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span>
-<span class='end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id index'>index</span>
+ <span class='ivar'>@chart</span><span class='period'>.</span><span class='id series'>series</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
-
- <span id="title=-instance_method"></span>
- <span id="title-instance_method"></span>
<div class="method_details ">
- <p class="signature " id="title-instance_method">
+ <p class="signature " id="order-instance_method">
- - (<tt><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span></tt>) <strong>title</strong>
+ - (<tt>Integer</tt>) <strong>order</strong>
</p><div class="docstring">
<div class="discussion">
- <p>
-The title of the series
-</p>
+
+<p>The order of this series in the chart's series. By default the order is the
+index of the series.</p>
</div>
@@ -625,7 +602,7 @@ The title of the series
<li>
- <span class='type'>(<tt><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span></tt>)</span>
+ <span class='type'>(<tt>Integer</tt>)</span>
@@ -639,81 +616,43 @@ The title of the series
<pre class="lines">
-22
-23
-24</pre>
+38
+39
+40</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 22</span>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 38</span>
-<span class='def def kw'>def</span> <span class='title identifier id'>title</span>
- <span class='@title ivar id'>@title</span>
-<span class='end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id order'>order</span>
+ <span class='ivar'>@order</span> <span class='op'>||</span> <span class='id index'>index</span>
+<span class='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">
+ <div class="method_details ">
+ <p class="signature " id="order=-instance_method">
- - (<tt>String</tt>) <strong>to_xml</strong>(xml)
+ - (<tt>Object</tt>) <strong>order=</strong>(v)
</p><div class="docstring">
<div class="discussion">
- <p>
-Serializes the series
-</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>
+ <h3>See Also:</h3>
+ <ul class="see">
+
+ <li>order</li>
+
+ </ul>
</div><table class="source_code">
<tr>
@@ -721,27 +660,12 @@ The document builder instance this objects xml will be added to.
<pre class="lines">
-60
-61
-62
-63
-64
-65
-66
-67</pre>
+43</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 60</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='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ser'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:idx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='index identifier id'>index</span><span class='rparen token'>)</span>
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:order'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='order identifier id'>order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span><span class='rparen token'>)</span>
- <span class='title identifier id'>title</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='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
- <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
- <span class='rbrace token'>}</span>
-<span class='end end kw'>end</span>
-</pre>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 43</span>
+
+<span class='kw'>def</span> <span class='id order='>order=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_unsigned_int'>validate_unsigned_int</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='ivar'>@order</span> <span class='op'>=</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -752,9 +676,9 @@ The document builder instance this objects xml will be added to.
</div>
<div id="footer">
- Generated on Wed Nov 23 22:20:50 2011 by
+ Generated on Sat Nov 26 13:16:37 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.7.3 (ruby-1.8.7).
+ 0.7.3 (ruby-1.9.3).
</div>
</body>
generated by cgit v1.2.3 (git 2.39.1) at 2026-09-19 23:54:30 +0000