summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/BarSeries.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Axlsx/BarSeries.html')
-rw-r--r--doc/Axlsx/BarSeries.html148
1 files changed, 67 insertions, 81 deletions
diff --git a/doc/Axlsx/BarSeries.html b/doc/Axlsx/BarSeries.html
index c4a1b690..14660129 100644
--- a/doc/Axlsx/BarSeries.html
+++ b/doc/Axlsx/BarSeries.html
@@ -6,7 +6,7 @@
<title>
Class: Axlsx::BarSeries
- &mdash; Documentation by YARD 0.7.3
+ &mdash; AXLSX
</title>
@@ -99,15 +99,13 @@
<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 BarSeries defines the title, data and labels for bar charts
-</p>
+
+<p>A BarSeries defines the title, data and labels for bar charts</p>
</div>
@@ -152,9 +150,8 @@ A BarSeries defines the title, data and labels for bar charts
- <span class="summary_desc"><div class='inline'><p>
-The data for this series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>The data for this series.</p>
</div></span>
</li>
@@ -179,9 +176,8 @@ The data for this series.
- <span class="summary_desc"><div class='inline'><p>
-The labels for this series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>The labels for this series.</p>
</div></span>
</li>
@@ -206,10 +202,9 @@ The labels for this series.
- <span class="summary_desc"><div class='inline'><p>
-The shabe of the bars or columns must be one of [:percentStacked,
-:clustered, :standard, :stacked].
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>The shabe of the bars or columns must be one of [:percentStacked,
+:clustered, :standard, :stacked].</p>
</div></span>
</li>
@@ -225,7 +220,7 @@ The shabe of the bars or columns must be one of [:percentStacked,
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">order</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p>
+ <p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p>
@@ -254,9 +249,8 @@ The shabe of the bars or columns must be one of [:percentStacked,
- <span class="summary_desc"><div class='inline'><p>
-Creates a new series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>Creates a new series.</p>
</div></span>
</li>
@@ -278,9 +272,8 @@ Creates a new series.
- <span class="summary_desc"><div class='inline'><p>
-Serializes the series.
-</p>
+ <span class="summary_desc"><div class='inline'>
+<p>Serializes the series.</p>
</div></span>
</li>
@@ -294,7 +287,12 @@ Serializes the series.
- <div id="constructor_details" class="method_details_list">
+
+
+
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">#index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">#order</a></span>, <span class='object_link'><a href="Series.html#order%3D-instance_method" title="Axlsx::Series#order= (method)">#order=</a></span></p>
+<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
@@ -306,9 +304,8 @@ Serializes the series.
</p><div class="docstring">
<div class="discussion">
- <p>
-Creates a new series
-</p>
+
+<p>Creates a new series</p>
</div>
@@ -340,9 +337,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>
@@ -413,13 +409,12 @@ a customizable set of options
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_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='@shape ivar id'>@shape</span> <span class='assign token'>=</span> <span class='symbol val'>:box</span>
- <span class='super super kw'>super</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='rparen token'>)</span>
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier id'>labels</span> <span class='assign token'>=</span> <span class='CatAxisData constant id'>CatAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='ValAxisData constant id'>ValAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
-<span class='end end kw'>end</span>
-</pre>
+<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'>@shape</span> <span class='op'>=</span> <span class='symbol'>:box</span>
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span>
+ <span class='kw'>self</span><span class='period'>.</span><span class='id labels'>labels</span> <span class='op'>=</span> <span class='const'>CatAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
+ <span class='kw'>self</span><span class='period'>.</span><span class='id data'>data</span> <span class='op'>=</span> <span class='const'>ValAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -442,9 +437,8 @@ a customizable set of options
</p><div class="docstring">
<div class="discussion">
- <p>
-The data for this series.
-</p>
+
+<p>The data for this series.</p>
</div>
@@ -478,10 +472,9 @@ The data for this series.
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 11</span>
-<span class='def def kw'>def</span> <span class='data identifier id'>data</span>
- <span class='@data ivar id'>@data</span>
-<span class='end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id data'>data</span>
+ <span class='ivar'>@data</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -499,9 +492,8 @@ The data for this series.
</p><div class="docstring">
<div class="discussion">
- <p>
-The labels for this series.
-</p>
+
+<p>The labels for this series.</p>
</div>
@@ -535,10 +527,9 @@ The labels for this series.
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 15</span>
-<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span>
- <span class='@labels ivar id'>@labels</span>
-<span class='end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id labels'>labels</span>
+ <span class='ivar'>@labels</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -556,10 +547,9 @@ The labels for this series.
</p><div class="docstring">
<div class="discussion">
- <p>
-The shabe of the bars or columns must be one of [:percentStacked,
-:clustered, :standard, :stacked]
-</p>
+
+<p>The shabe of the bars or columns must be one of [:percentStacked,
+:clustered, :standard, :stacked]</p>
</div>
@@ -593,10 +583,9 @@ The shabe of the bars or columns must be one of [:percentStacked,
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 20</span>
-<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span>
- <span class='@shape ivar id'>@shape</span>
-<span class='end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id shape'>shape</span>
+ <span class='ivar'>@shape</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -618,9 +607,8 @@ The shabe of the bars or columns must be one of [:percentStacked,
</p><div class="docstring">
<div class="discussion">
- <p>
-Serializes the series
-</p>
+
+<p>Serializes the series</p>
</div>
@@ -639,9 +627,8 @@ Serializes the series
&mdash;
- <div class='inline'><p>
-The document builder instance this objects xml will be added to.
-</p>
+ <div class='inline'>
+<p>The document builder instance this objects xml will be added to.</p>
</div>
</li>
@@ -668,25 +655,24 @@ The document builder instance this objects xml will be added to.
<pre class="lines">
-43
-44
45
46
47
48
-49</pre>
+49
+50
+51</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 43</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='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
- <span class='@labels ivar id'>@labels</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='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
- <span class='@data ivar id'>@data</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='@data ivar id'>@data</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</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/bar_series.rb', line 45</span>
+
+<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span>
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml_inner'>xml_inner</span><span class='op'>|</span>
+ <span class='ivar'>@labels</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@labels</span><span class='period'>.</span><span class='id nil?'>nil?</span>
+ <span class='ivar'>@data</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id nil?'>nil?</span>
+ <span class='id xml_inner'>xml_inner</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:shape</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=&gt;</span><span class='ivar'>@shape</span><span class='rparen'>)</span>
+ <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -697,9 +683,9 @@ The document builder instance this objects xml will be added to.
</div>
<div id="footer">
- Generated on Wed Nov 23 22:20:54 2011 by
+ Generated on Sat Nov 26 13:16:38 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 22:54:39 +0000