summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/TableStyle.html
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
committerRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
commit8cf0296bbc16e8eb535e9af932eed2557d5e66d2 (patch)
tree9c5a214c0ac49b56d08be769fbe0634ac1e5b0a4 /doc/Axlsx/TableStyle.html
parent076be316935180341d7ee7a9335281a4b18d1fa9 (diff)
downloadcaxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz
caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/TableStyle.html')
-rw-r--r--doc/Axlsx/TableStyle.html690
1 files changed, 0 insertions, 690 deletions
diff --git a/doc/Axlsx/TableStyle.html b/doc/Axlsx/TableStyle.html
deleted file mode 100644
index 41cd0318..00000000
--- a/doc/Axlsx/TableStyle.html
+++ /dev/null
@@ -1,690 +0,0 @@
-<!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::TableStyle
-
- &mdash; AXLSX
-
-</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">TableStyle</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::TableStyle
-
-
-
-</h1>
-
-<dl class="box">
-
- <dt class="r1">Inherits:</dt>
- <dd class="r1">
- <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span>
-
- <ul class="fullTree">
- <li>Object</li>
-
- <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li>
-
- <li class="next">Axlsx::TableStyle</li>
-
- </ul>
- <a href="#" class="inheritanceTree">show all</a>
-
- </dd>
-
-
-
-
-
-
-
-
-
- <dt class="r2 last">Defined in:</dt>
- <dd class="r2 last">lib/axlsx/stylesheet/table_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>Table are not supported in this version and only the defaults required for
-a valid workbook are created.</p>
-</div>
- </div>
-
-
-<p>A single table style definition and is a collection for tableStyleElements</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</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="#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 table style.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#pivot-instance_method" title="#pivot (instance method)">- (Boolean) <strong>pivot</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>indicates if this style should be applied to pivot tables.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#table-instance_method" title="#table (instance method)">- (Boolean) <strong>table</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>indicates if this style should be applied to tables.</p>
-</div></span>
-
-</li>
-
-
- </ul>
-
-
-
-
-
-
-
-
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</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)">- (TableStyle) <strong>initialize</strong>(name, options = {}) </a>
-
-
-
- </span>
-
- <span class="note title constructor">constructor</span>
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>creates a new TableStyle 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 table 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::TableStyle (class)">TableStyle</a></span></tt>) <strong>initialize</strong>(name, options = {})
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>creates a new TableStyle object</p>
-
-
- </div>
-</div>
-<div class="tags">
- <h3>Parameters:</h3>
-<ul class="param">
-
- <li>
-
- <span class='name'>name</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- </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">pivot</span>
- <span class="type">(<tt>Boolean</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">table</span>
- <span class="type">(<tt>Boolean</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- </ul>
-
-
-<h3>Raises:</h3>
-<ul class="raise">
-
- <li>
-
-
- <span class='type'>(<tt>ArgumentError</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'>
-<p>if name option is not provided.</p>
-</div>
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-23
-24
-25
-26
-27
-28
-29</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 23</span>
-
-<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='name identifier id'>name</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='name identifier id'>name</span> <span class='assign token'>=</span> <span class='name identifier id'>name</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='super super kw'>super</span> <span class='TableStyleElement constant id'>TableStyleElement</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-</div>
-<div id="method_missing_details" class="method_details_list">
- <h2>Dynamic Method Handling</h2>
- <p class="notice super">
- This class handles dynamic methods through the <tt>method_missing</tt> method
-
- in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span>
-
- </p>
-
-</div>
-
- <div id="instance_attr_details" class="attr_details">
- <h2>Instance Attribute Details</h2>
-
-
- <span id="name=-instance_method"></span>
- <span id="name-instance_method"></span>
- <div class="method_details first">
- <p class="signature first" id="name-instance_method">
-
- - (<tt>string</tt>) <strong>name</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>The name of this table 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/table_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="pivot=-instance_method"></span>
- <span id="pivot-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="pivot-instance_method">
-
- - (<tt>Boolean</tt>) <strong>pivot</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>indicates if this style should be applied to pivot tables</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">
-
-
-12
-13
-14</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 12</span>
-
-<span class='def def kw'>def</span> <span class='pivot identifier id'>pivot</span>
- <span class='@pivot ivar id'>@pivot</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="table=-instance_method"></span>
- <span id="table-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="table-instance_method">
-
- - (<tt>Boolean</tt>) <strong>table</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>indicates if this style should be applied to tables</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">
-
-
-16
-17
-18</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 16</span>
-
-<span class='def def kw'>def</span> <span class='table identifier id'>table</span>
- <span class='@table ivar id'>@table</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 table 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">
-
-
-41
-42
-43
-44
-45</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 41</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='attr identifier id'>attr</span> <span class='assign 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='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='comma token'>,</span> <span class='symbol val'>:pivot</span><span class='comma token'>,</span> <span class='symbol val'>:table</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span>
- <span class='attr identifier id'>attr</span><span class='lbrack token'>[</span><span class='symbol val'>:count</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span>
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyle identifier id'>tableStyle</span><span class='lparen token'>(</span><span class='attr identifier id'>attr</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='table_style_el identifier id'>table_style_el</span><span class='bitor op'>|</span> <span class='table_style_el identifier id'>table_style_el</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='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 Wed Nov 30 08:46:21 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> \ No newline at end of file