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/CatAxis.html ADDED

@@ -0,0 +1,766 @@
+<!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::CatAxis
+    &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 (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
+     &raquo;
+    <span class="title">CatAxis</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::CatAxis
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></li>
+            <li class="next">Axlsx::CatAxis</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/axlsx/drawing/cat_axis.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+A CatAxis object defines a chart category axis
+</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="LBL_OFFSET_REGEX-constant" class="">LBL_OFFSET_REGEX =
+          <div class="docstring">
+  <div class="discussion">
+    <p>
+regex for validating label offset
+</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/</span>
+</pre></dd>
+    </dl>
+  <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="#auto-instance_method" title="#auto (instance method)">- (Boolean) <strong>auto</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+From the docs: This element specifies that this axis is a date or text axis
+based on the data that is used for the axis labels, not a specific choice.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#lblAlgn-instance_method" title="#lblAlgn (instance method)">- (Symbol) <strong>lblAlgn</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+specifies how the perpendicular axis is crossed must be one of [:ctr, :l,
+:r].
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#lblOffset-instance_method" title="#lblOffset (instance method)">- (Integer) <strong>lblOffset</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+The offset of the labels must be between a string between 0 and 1000.
+</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Axis.html#axId-instance_method" title="Axlsx::Axis#axId (method)">axId</a></span>, <span class='object_link'><a href="Axis.html#axPos-instance_method" title="Axlsx::Axis#axPos (method)">axPos</a></span>, <span class='object_link'><a href="Axis.html#crossAx-instance_method" title="Axlsx::Axis#crossAx (method)">crossAx</a></span>, <span class='object_link'><a href="Axis.html#crosses-instance_method" title="Axlsx::Axis#crosses (method)">crosses</a></span>, <span class='object_link'><a href="Axis.html#format_code-instance_method" title="Axlsx::Axis#format_code (method)">format_code</a></span>, <span class='object_link'><a href="Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">scaling</a></span>, <span class='object_link'><a href="Axis.html#tickLblPos-instance_method" title="Axlsx::Axis#tickLblPos (method)">tickLblPos</a></span></p>
+    <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)">- (CatAxis) <strong>initialize</strong>(axId, crossAx, options = {}) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>
+Creates a new CatAxis 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 category axis.
+</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::CatAxis (class)">CatAxis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {})
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Creates a new CatAxis object
+</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+    <li>
+        <span class='name'>axId</span>
+        <span class='type'>(<tt>Integer</tt>)</span>
+        &mdash;
+        <div class='inline'><p>
+the id of this axis
+</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>crossAx</span>
+        <span class='type'>(<tt>Integer</tt>)</span>
+        &mdash;
+        <div class='inline'><p>
+the id of the perpendicular axis
+</p>
+</div>
+    </li>
+    <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">axPos</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">tickLblPos</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">crosses</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">auto</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">lblAlgn</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">lblOffset</span>
+          <span class="type">(<tt>Integer</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+    </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+30
+31
+32
+33
+34
+35
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 30</span>
+<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</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='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</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='auto identifier id'>auto</span> <span class='assign token'>=</span> <span class='true true kw'>true</span>
+  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblAlgn identifier id'>lblAlgn</span> <span class='assign token'>=</span> <span class='symbol val'>:ctr</span>
+  <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblOffset identifier id'>lblOffset</span> <span class='assign token'>=</span> <span class='string val'>&quot;100%&quot;</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>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="auto=-instance_method"></span>
+      <span id="auto-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="auto-instance_method">
+    - (<tt>Boolean</tt>) <strong>auto</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+From the docs: This element specifies that this axis is a date or text axis
+based on the data that is used for the axis labels, not a specific choice.
+</p>
+  </div>
+</div>
+<div class="tags">
+<h3>Returns:</h3>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+6
+7
+8</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 6</span>
+<span class='def def kw'>def</span> <span class='auto identifier id'>auto</span>
+  <span class='@auto ivar id'>@auto</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="lblAlgn=-instance_method"></span>
+      <span id="lblAlgn-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="lblAlgn-instance_method">
+    - (<tt>Symbol</tt>) <strong>lblAlgn</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+specifies how the perpendicular axis is crossed must be one of [:ctr, :l,
+:r]
+</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">
+11
+12
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 11</span>
+<span class='def def kw'>def</span> <span class='lblAlgn identifier id'>lblAlgn</span>
+  <span class='@lblAlgn ivar id'>@lblAlgn</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="lblOffset=-instance_method"></span>
+      <span id="lblOffset-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="lblOffset-instance_method">
+    - (<tt>Integer</tt>) <strong>lblOffset</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+The offset of the labels must be between a string between 0 and 1000
+</p>
+  </div>
+</div>
+<div class="tags">
+<h3>Returns:</h3>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Integer</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 16</span>
+<span class='def def kw'>def</span> <span class='lblOffset identifier id'>lblOffset</span>
+  <span class='@lblOffset ivar id'>@lblOffset</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 category axis
+</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">
+47
+48
+49
+50
+51
+52
+53
+54</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 47</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:catAx'</span><span class='rparen token'>)</span> <span class='lbrace 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='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:auto'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='@auto ivar id'>@auto</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:lblAlgn'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='@lblAlgn ivar id'>@lblAlgn</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:lblOffset'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='@lblOffset ivar id'>@lblOffset</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 Tue Nov 22 00:27:44 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>