diff options
Diffstat (limited to 'doc/Axlsx/Ar/SingletonMethods.html')
| -rw-r--r-- | doc/Axlsx/Ar/SingletonMethods.html | 312 |
1 files changed, 0 insertions, 312 deletions
diff --git a/doc/Axlsx/Ar/SingletonMethods.html b/doc/Axlsx/Ar/SingletonMethods.html deleted file mode 100644 index 58b6b29c..00000000 --- a/doc/Axlsx/Ar/SingletonMethods.html +++ /dev/null @@ -1,312 +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> - Module: Axlsx::Ar::SingletonMethods - - — 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 (S)</a> » - <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span> - » - <span class="title">SingletonMethods</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>Module: Axlsx::Ar::SingletonMethods - - - -</h1> - -<dl class="box"> - - - - - - - - - <dt class="r1 last">Defined in:</dt> - <dd class="r1 last">lib/axlsx/ar.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Singleton methods for the mixin</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <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="#to_xlsx-instance_method" title="#to_xlsx (instance method)">- (Object) <strong>to_xlsx</strong>(number = :all, options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Maps the AR class to an Axlsx package options are passed into AR find.</p> -</div></span> - -</li> - - - </ul> - - - - - <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_xlsx-instance_method"> - - - (<tt>Object</tt>) <strong>to_xlsx</strong>(number = :all, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Maps the AR class to an Axlsx package options are passed into AR find</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>Symbol,</span> - - - <span class='type'>(<tt>Symbol</tt>, <tt>:all</tt>, <tt>etc.</tt>)</span> - - - - — - <div class='inline'> -<p>:all, etc.</p> -</div> - - </li> - - <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">header_style</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>to apply to the first row of field names</p> -</div> - </li> - - <li> - <span class="name">an</span> - <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>array of Axlsx types for each cell in data rows or a single type that will -be applied to all types.</p> -</div> - </li> - - <li> - <span class="name">style</span> - <span class="type">(<tt>Integer</tt>, <tt>Array</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The style to pass to Worksheet#add_row</p> -</div> - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="../Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 32</span> - -<span class='kw'>def</span> <span class='id to_xlsx'>to_xlsx</span><span class='lparen'>(</span><span class='id number'>number</span> <span class='op'>=</span> <span class='symbol'>:all</span><span class='comma'>,</span> <span class='id options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id row_style'>row_style</span> <span class='op'>=</span> <span class='id options'>options</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:style</span><span class='rparen'>)</span> - <span class='id header_style'>header_style</span> <span class='op'>=</span> <span class='id options'>options</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:header_style</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id row_style'>row_style</span> - <span class='id types'>types</span> <span class='op'>=</span> <span class='id options'>options</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:types</span><span class='rparen'>)</span> - - <span class='id data'>data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='op'>*</span><span class='id find'>find</span><span class='lparen'>(</span><span class='id number'>number</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span><span class='rbracket'>]</span> - <span class='id data'>data</span><span class='period'>.</span><span class='id compact!'>compact!</span> - <span class='id data'>data</span><span class='period'>.</span><span class='id flatten!'>flatten!</span> - <span class='id columns'>columns</span> <span class='op'>=</span> <span class='id data'>data</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id attributes'>attributes</span><span class='period'>.</span><span class='id keys'>keys</span> - <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id row_style'>row_style</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='id row_style'>row_style</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id row_style'>row_style</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id header_style'>header_style</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='id header_style'>header_style</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id header_style'>header_style</span><span class='period'>.</span><span class='id nil?'>nil?</span> - - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span><span class='lparen'>(</span><span class='symbol'>:name</span><span class='op'>=></span><span class='id table_name'>table_name</span><span class='period'>.</span><span class='id humanize'>humanize</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='id columns'>columns</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='id header_style'>header_style</span> - <span class='id data'>data</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id r'>r</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='id r'>r</span><span class='period'>.</span><span class='id attributes'>attributes</span><span class='period'>.</span><span class='id values'>values</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='id row_style'>row_style</span><span class='comma'>,</span> <span class='symbol'>:types</span><span class='op'>=></span><span class='id types'>types</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Sun Nov 27 22:10:46 2011 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). -</div> - - </body> -</html>
\ No newline at end of file |