RubyGems - axlsx - Versions diffs - 1.0.5 → 1.0.6 - Mend

axlsx 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (71) hide show

data/README.md +10 -9
data/doc/Axlsx.html +2443 -0
data/doc/Axlsx/App.html +2640 -0
data/doc/Axlsx/Axis.html +1047 -0
data/doc/Axlsx/Bar3DChart.html +1153 -0
data/doc/Axlsx/BarSeries.html +764 -0
data/doc/Axlsx/Border.html +775 -0
data/doc/Axlsx/BorderPr.html +709 -0
data/doc/Axlsx/CatAxis.html +766 -0
data/doc/Axlsx/Cell.html +1623 -0
data/doc/Axlsx/CellAlignment.html +1247 -0
data/doc/Axlsx/CellProtection.html +565 -0
data/doc/Axlsx/CellStyle.html +949 -0
data/doc/Axlsx/Chart.html +1459 -0
data/doc/Axlsx/Color.html +665 -0
data/doc/Axlsx/ContentType.html +340 -0
data/doc/Axlsx/Core.html +465 -0
data/doc/Axlsx/DataTypeValidator.html +324 -0
data/doc/Axlsx/Default.html +575 -0
data/doc/Axlsx/Drawing.html +1154 -0
data/doc/Axlsx/Fill.html +460 -0
data/doc/Axlsx/Font.html +1554 -0
data/doc/Axlsx/GradientFill.html +1026 -0
data/doc/Axlsx/GradientStop.html +526 -0
data/doc/Axlsx/GraphicFrame.html +646 -0
data/doc/Axlsx/Line3DChart.html +921 -0
data/doc/Axlsx/LineSeries.html +656 -0
data/doc/Axlsx/Marker.html +857 -0
data/doc/Axlsx/NumFmt.html +562 -0
data/doc/Axlsx/Override.html +568 -0
data/doc/Axlsx/Package.html +1293 -0
data/doc/Axlsx/PatternFill.html +681 -0
data/doc/Axlsx/Pie3DChart.html +439 -0
data/doc/Axlsx/PieSeries.html +762 -0
data/doc/Axlsx/RegexValidator.html +268 -0
data/doc/Axlsx/Relationship.html +554 -0
data/doc/Axlsx/Relationships.html +343 -0
data/doc/Axlsx/RestrictionValidator.html +300 -0
data/doc/Axlsx/Row.html +771 -0
data/doc/Axlsx/Scaling.html +740 -0
data/doc/Axlsx/SerAxis.html +624 -0
data/doc/Axlsx/Series.html +746 -0
data/doc/Axlsx/SeriesTitle.html +289 -0
data/doc/Axlsx/SimpleTypedList.html +1617 -0
data/doc/Axlsx/Styles.html +1754 -0
data/doc/Axlsx/TableStyle.html +710 -0
data/doc/Axlsx/TableStyleElement.html +677 -0
data/doc/Axlsx/TableStyles.html +599 -0
data/doc/Axlsx/Title.html +625 -0
data/doc/Axlsx/TwoCellAnchor.html +1115 -0
data/doc/Axlsx/ValAxis.html +539 -0
data/doc/Axlsx/View3D.html +971 -0
data/doc/Axlsx/Workbook.html +1347 -0
data/doc/Axlsx/Worksheet.html +1864 -0
data/doc/Axlsx/Xf.html +1681 -0
data/doc/_index.html +611 -0
data/doc/class_list.html +47 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +55 -0
data/doc/css/style.css +322 -0
data/doc/file.README.html +262 -0
data/doc/file_list.html +49 -0
data/doc/frames.html +13 -0
data/doc/index.html +262 -0
data/doc/js/app.js +205 -0
data/doc/js/full_list.js +167 -0
data/doc/js/jquery.js +16 -0
data/doc/method_list.html +3038 -0
data/doc/top-level-namespace.html +103 -0
data/lib/axlsx/util/constants.rb +1 -1
metadata +71 -3

data/doc/Axlsx/Title.html ADDED

@@ -0,0 +1,625 @@
+<!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::Title
+    &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 (T)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
+     &raquo;
+    <span class="title">Title</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::Title
+</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::Title</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/axlsx/drawing/title.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+A Title stores information about the title of a chart
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span></p>
+</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="#cell-instance_method" title="#cell (instance method)">- (Cell) <strong>cell</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+The cell that holds the text for the title.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#text-instance_method" title="#text (instance method)">- (String) <strong>text</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+The text to be shown.
+</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)">- (Title) <strong>initialize</strong>(title = &quot;&quot;) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>
+Creates a new Title object.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#range-instance_method" title="#range (instance method)">- (String) <strong>range</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+returns the excel style abslute reference for the title when title is a
+Cell 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 chart title.
+</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::Title (class)">Title</a></span></tt>) <strong>initialize</strong>(title = &quot;&quot;)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Creates a new Title object
+</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+    <li>
+        <span class='name'>title</span>
+        <span class='type'>(<tt>String</tt>, <tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span>
+        <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
+        &mdash;
+        <div class='inline'><p>
+The cell or string to be used for the chart&#8217;s title
+</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+15
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 15</span>
+<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='title identifier id'>title</span><span class='assign token'>=</span><span class='string val'>&quot;&quot;</span><span class='rparen token'>)</span>
+  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='cell identifier id'>cell</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span> <span class='if if_mod kw'>if</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span>
+  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='text identifier id'>text</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> <span class='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</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="cell=-instance_method"></span>
+      <span id="cell-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="cell-instance_method">
+    - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>cell</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+The cell that holds the text for the title. Setting this property will
+automatically update the text attribute.
+</p>
+  </div>
+</div>
+<div class="tags">
+<h3>Returns:</h3>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+11
+12
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 11</span>
+<span class='def def kw'>def</span> <span class='cell identifier id'>cell</span>
+  <span class='@cell ivar id'>@cell</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="text=-instance_method"></span>
+      <span id="text-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="text-instance_method">
+    - (<tt>String</tt>) <strong>text</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+The text to be shown. Setting this property directly with a string will
+remove the cell reference.
+</p>
+  </div>
+</div>
+<div class="tags">
+<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">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 7</span>
+<span class='def def kw'>def</span> <span class='text identifier id'>text</span>
+  <span class='@text ivar id'>@text</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="range-instance_method">
+    - (<tt>String</tt>) <strong>range</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+returns the excel style abslute reference for the title when title is a
+Cell object
+</p>
+  </div>
+</div>
+<div class="tags">
+<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">
+62
+63
+64
+65</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 62</span>
+<span class='def def kw'>def</span> <span class='range identifier id'>range</span>
+  <span class='return return kw'>return</span> <span class='string val'>&quot;&quot;</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span>
+  <span class='dstring node'>&quot;#{@data.row.worksheet.name}!#{data.row.r_abs}&quot;</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="to_xml-instance_method">
+    - (<tt>String</tt>) <strong>to_xml</strong>(xml)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Serializes the chart title
+</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">
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 42</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:title'</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:tx'</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:strRef'</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:f'</span><span class='comma token'>,</span> <span class='range identifier id'>range</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:strCache'</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:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='integer val'>1</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:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>&gt;</span><span class='integer val'>0</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:v'</span><span class='comma token'>,</span> <span class='@text ivar id'>@text</span><span class='rparen token'>)</span>
+          <span class='rbrace token'>}</span>
+        <span class='rbrace token'>}</span>
+      <span class='rbrace 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 Tue Nov 22 00:27: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).
+</div>
+  </body>
+</html>