diff options
Diffstat (limited to 'doc/Axlsx/TableStyles.html')
| -rw-r--r-- | doc/Axlsx/TableStyles.html | 580 |
1 files changed, 0 insertions, 580 deletions
diff --git a/doc/Axlsx/TableStyles.html b/doc/Axlsx/TableStyles.html deleted file mode 100644 index 4f265099..00000000 --- a/doc/Axlsx/TableStyles.html +++ /dev/null @@ -1,580 +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::TableStyles - - — 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> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">TableStyles</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::TableStyles - - - -</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::TableStyles</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_styles.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>Support for custom table styles does not exist in this version. Many of the -classes required are defined in preparation for future release. Please do -not attempt to add custom table styles.</p> -</div> - </div> - - -<p>TableStyles represents a collection of style definitions for table styles -and pivot table styles.</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="#defaultPivotStyle-instance_method" title="#defaultPivotStyle (instance method)">- (String) <strong>defaultPivotStyle</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The default pivot table style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#defaultTableStyle-instance_method" title="#defaultTableStyle (instance method)">- (String) <strong>defaultTableStyle</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The default table style.</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)">- (TableStyles) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new TableStyles object that is a container for TableStyle -objects.</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 styles element.</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::TableStyles (class)">TableStyles</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new TableStyles object that is a container for TableStyle objects</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> - - - — - <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">defaultTableStyle</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">defaultPivotStyle</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19 -20 -21</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 17</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='@defaultTableStyle ivar id'>@defaultTableStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"TableStyleMedium9"</span> - <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"PivotStyleLight16"</span> - <span class='super super kw'>super</span> <span class='TableStyle constant id'>TableStyle</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="defaultPivotStyle=-instance_method"></span> - <span id="defaultPivotStyle-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="defaultPivotStyle-instance_method"> - - - (<tt>String</tt>) <strong>defaultPivotStyle</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The default pivot table style. The default value is ‘PivotStyleLight6’</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"> - - -12 -13 -14</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 12</span> - -<span class='def def kw'>def</span> <span class='defaultPivotStyle identifier id'>defaultPivotStyle</span> - <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="defaultTableStyle=-instance_method"></span> - <span id="defaultTableStyle-instance_method"></span> - <div class="method_details "> - <p class="signature " id="defaultTableStyle-instance_method"> - - - (<tt>String</tt>) <strong>defaultTableStyle</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The default table style. The default value is ‘TableStyleMedium9’</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_styles.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='defaultTableStyle identifier id'>defaultTableStyle</span> - <span class='@defaultTableStyle ivar id'>@defaultTableStyle</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 styles element</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> - - - - — - <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"> - - -30 -31 -32 -33 -34 -35 -36</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 30</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='reject identifier id'>reject</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='notop op'>!</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='comma token'>,</span> <span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rparen token'>)</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='tableStyles identifier id'>tableStyles</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 identifier id'>table_style</span><span class='bitor op'>|</span> <span class='table_style identifier id'>table_style</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:33 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 |