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

@@ -0,0 +1,949 @@
+<!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::CellStyle
+    &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">CellStyle</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::CellStyle
+</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::CellStyle</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/axlsx/stylesheet/cell_style.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'><p>
+Using Styles#add_style is the recommended way to manage cell styling.
+</p>
+</div>
+  </div>
+<p>
+CellStyle defines named styles that reference defined formatting records
+and can be used in your worksheet.
+</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>See Also:</h3>
+  <ul class="see">
+      <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</a></span></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="#builtinId-instance_method" title="#builtinId (instance method)">- (Integer) <strong>builtinId</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+The buildinId to use when this named style is applied.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#customBuiltin-instance_method" title="#customBuiltin (instance method)">- (Boolean) <strong>customBuiltin</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Indicates that the build in style reference has been customized.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#hidden-instance_method" title="#hidden (instance method)">- (Boolean) <strong>hidden</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Determines if this named style should show in the list of styles when using
+excel.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#iLevel-instance_method" title="#iLevel (instance method)">- (Integer) <strong>iLevel</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Determines if this formatting is for an outline style, and what level of
+the outline it is to be applied to.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+The name of this cell style.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#xfId-instance_method" title="#xfId (instance method)">- (Integer) <strong>xfId</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+The formatting record id this named style utilizes.
+</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)">- (CellStyle) <strong>initialize</strong>(options = {}) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>
+Creats a new CellStyle 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 cell style.
+</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::CellStyle (class)">CellStyle</a></span></tt>) <strong>initialize</strong>(options = {})
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Creats a new CellStyle 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">name</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">xfId</span>
+          <span class="type">(<tt>Integer</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">buildinId</span>
+          <span class="type">(<tt>Integer</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">iLevel</span>
+          <span class="type">(<tt>Integer</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">hidden</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+        <li>
+          <span class="name">customBuiltIn</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+          </span>
+        </li>
+    </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+39
+40
+41
+42
+43</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 39</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='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='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="builtinId=-instance_method"></span>
+      <span id="builtinId-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="builtinId-instance_method">
+    - (<tt>Integer</tt>) <strong>builtinId</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+The buildinId to use when this named style is applied
+</p>
+  </div>
+</div>
+<div class="tags">
+<h3>Returns:</h3>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Integer</tt>)</span>
+    </li>
+</ul>
+  <h3>See Also:</h3>
+  <ul class="see">
+      <li><span class='object_link'><a href="NumFmt.html" title="Axlsx::NumFmt (class)">NumFmt</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+18
+19
+20</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 18</span>
+<span class='def def kw'>def</span> <span class='builtinId identifier id'>builtinId</span>
+  <span class='@builtinId ivar id'>@builtinId</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="customBuiltin=-instance_method"></span>
+      <span id="customBuiltin-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="customBuiltin-instance_method">
+    - (<tt>Boolean</tt>) <strong>customBuiltin</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Indicates that the build in style reference has been customized.
+</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">
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 30</span>
+<span class='def def kw'>def</span> <span class='customBuiltin identifier id'>customBuiltin</span>
+  <span class='@customBuiltin ivar id'>@customBuiltin</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="hidden=-instance_method"></span>
+      <span id="hidden-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="hidden-instance_method">
+    - (<tt>Boolean</tt>) <strong>hidden</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Determines if this named style should show in the list of styles when using
+excel
+</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">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 26</span>
+<span class='def def kw'>def</span> <span class='hidden identifier id'>hidden</span>
+  <span class='@hidden ivar id'>@hidden</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="iLevel=-instance_method"></span>
+      <span id="iLevel-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="iLevel-instance_method">
+    - (<tt>Integer</tt>) <strong>iLevel</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Determines if this formatting is for an outline style, and what level of
+the outline it is to be applied to.
+</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">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 22</span>
+<span class='def def kw'>def</span> <span class='iLevel identifier id'>iLevel</span>
+  <span class='@iLevel ivar id'>@iLevel</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="name=-instance_method"></span>
+      <span id="name-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="name-instance_method">
+    - (<tt>String</tt>) <strong>name</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+The name of this cell style
+</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">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 8</span>
+<span class='def def kw'>def</span> <span class='name identifier id'>name</span>
+  <span class='@name ivar id'>@name</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="xfId=-instance_method"></span>
+      <span id="xfId-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="xfId-instance_method">
+    - (<tt>Integer</tt>) <strong>xfId</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+The formatting record id this named style utilizes
+</p>
+  </div>
+</div>
+<div class="tags">
+<h3>Returns:</h3>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Integer</tt>)</span>
+    </li>
+</ul>
+  <h3>See Also:</h3>
+  <ul class="see">
+      <li><span class='object_link'><a href="Xf.html" title="Axlsx::Xf (class)">Xf</a></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/cell_style.rb', line 13</span>
+<span class='def def kw'>def</span> <span class='xfId identifier id'>xfId</span>
+  <span class='@xfId ivar id'>@xfId</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 cell style
+</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">
+55
+56
+57</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 55</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='cellStyle identifier id'>cellStyle</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='rparen 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:49 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>