diff options
| author | Randy Morgan <[email protected]> | 2011-11-27 21:53:25 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-27 21:53:25 +0900 |
| commit | f050dd81a633c45e3c8a57dffcdb4db715183e3d (patch) | |
| tree | 995191ef952e91198b77283e1ab89a9ac22421dd /doc/Axlsx | |
| parent | cdfc7251bde8347678d355e5fe65fc20e120bc23 (diff) | |
| download | caxlsx-f050dd81a633c45e3c8a57dffcdb4db715183e3d.tar.gz caxlsx-f050dd81a633c45e3c8a57dffcdb4db715183e3d.zip | |
more documentation for 10a release
Diffstat (limited to 'doc/Axlsx')
60 files changed, 342 insertions, 88 deletions
diff --git a/doc/Axlsx/App.html b/doc/Axlsx/App.html index 30353577..d8ee7c52 100644 --- a/doc/Axlsx/App.html +++ b/doc/Axlsx/App.html @@ -2631,7 +2631,7 @@ The document as a string </div> <div id="footer"> - Generated on Sun Nov 27 21:44:45 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Ar.html b/doc/Axlsx/Ar.html index 469545c1..958064a3 100644 --- a/doc/Axlsx/Ar.html +++ b/doc/Axlsx/Ar.html @@ -77,7 +77,19 @@ </dl> <div class="clear"></div> -<h2>Defined Under Namespace</h2> +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Mixing module for adding acts_as_axlsx to active record base +</p> + + + </div> +</div> +<div class="tags"> + + +</div><h2>Defined Under Namespace</h2> <p class="children"> @@ -92,12 +104,94 @@ + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(base) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Extents active record with this ojbects class method acts_as_axlsx. +</p> +</div></span> + +</li> + + </ul> + + + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="included-class_method"> + + + (<tt>Object</tt>) <strong>included</strong>(base) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Extents active record with this ojbects class method acts_as_axlsx +</p> + + + </div> +</div> +<div class="tags"> + + +</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/ar.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='included identifier id'>included</span><span class='lparen token'>(</span><span class='base identifier id'>base</span><span class='rparen token'>)</span> + <span class='base identifier id'>base</span><span class='dot token'>.</span><span class='send identifier id'>send</span> <span class='symbol val'>:extend</span><span class='comma token'>,</span> <span class='ClassMethods constant id'>ClassMethods</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> </div> <div id="footer"> - Generated on Sun Nov 27 21:44:29 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Ar/ClassMethods.html b/doc/Axlsx/Ar/ClassMethods.html index f77762a6..8a98b4a4 100644 --- a/doc/Axlsx/Ar/ClassMethods.html +++ b/doc/Axlsx/Ar/ClassMethods.html @@ -77,7 +77,19 @@ </dl> <div class="clear"></div> +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Class methods for the mixin +</p> + + + </div> +</div> +<div class="tags"> + +</div> @@ -107,7 +119,7 @@ <span class="summary_desc"><div class='inline'><p> -we should do what ruport did and use only, exclude and methods hashes. +adds in the instance and singleton methods. </p> </div></span> @@ -133,7 +145,7 @@ we should do what ruport did and use only, exclude and methods hashes. </p><div class="docstring"> <div class="discussion"> <p> -we should do what ruport did and use only, exclude and methods hashes +adds in the instance and singleton methods </p> @@ -148,13 +160,13 @@ we should do what ruport did and use only, exclude and methods hashes <pre class="lines"> -14 -15 16 -17</pre> +17 +18 +19</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 14</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 16</span> <span class='def def kw'>def</span> <span class='acts_as_axlsx identifier id'>acts_as_axlsx</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='include identifier id'>include</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Ar constant id'>Ar</span><span class='colon2 op'>::</span><span class='InstanceMethods constant id'>InstanceMethods</span> @@ -171,7 +183,7 @@ we should do what ruport did and use only, exclude and methods hashes </div> <div id="footer"> - Generated on Sun Nov 27 21:44:28 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Ar/InstanceMethods.html b/doc/Axlsx/Ar/InstanceMethods.html index e1253017..ccff0449 100644 --- a/doc/Axlsx/Ar/InstanceMethods.html +++ b/doc/Axlsx/Ar/InstanceMethods.html @@ -77,8 +77,21 @@ </dl> <div class="clear"></div> +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Empty module - I really like ruports way of allowing :include, :only, +:exclude and am looking to add something like that in later +</p> + </div> +</div> +<div class="tags"> + + +</div> + @@ -87,7 +100,7 @@ </div> <div id="footer"> - Generated on Sun Nov 27 21:44:28 2011 by + Generated on Sun Nov 27 21:52:30 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> diff --git a/doc/Axlsx/Ar/SingletonMethods.html b/doc/Axlsx/Ar/SingletonMethods.html index 19fe1358..f1081b17 100644 --- a/doc/Axlsx/Ar/SingletonMethods.html +++ b/doc/Axlsx/Ar/SingletonMethods.html @@ -77,8 +77,20 @@ </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> + @@ -106,7 +118,10 @@ - <span class="summary_desc"><div class='inline'></div></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> @@ -127,21 +142,102 @@ -</p><table class="source_code"> +</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'>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"> -22 -23 -24 -25 -26 -27 -28 -29 -30 31 32 33 @@ -153,10 +249,19 @@ 39 40 41 -42</pre> +42 +43 +44 +45 +46 +47 +48 +49 +50 +51</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 22</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 31</span> <span class='def def kw'>def</span> <span class='to_xlsx identifier id'>to_xlsx</span><span class='lparen token'>(</span><span class='number identifier id'>number</span> <span class='assign token'>=</span> <span class='symbol val'>:all</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='row_style identifier id'>row_style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:style</span><span class='rparen token'>)</span> @@ -190,7 +295,7 @@ </div> <div id="footer"> - Generated on Sun Nov 27 21:44:39 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html index afe6295c..5588a0b4 100644 --- a/doc/Axlsx/Axis.html +++ b/doc/Axlsx/Axis.html @@ -1066,7 +1066,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:29 2011 by + Generated on Sun Nov 27 21:52:34 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> diff --git a/doc/Axlsx/Bar3DChart.html b/doc/Axlsx/Bar3DChart.html index 00f05ccb..da81e4d9 100644 --- a/doc/Axlsx/Bar3DChart.html +++ b/doc/Axlsx/Bar3DChart.html @@ -1173,7 +1173,7 @@ Serializes the bar chart </div> <div id="footer"> - Generated on Sun Nov 27 21:44:43 2011 by + Generated on Sun Nov 27 21:52:48 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> diff --git a/doc/Axlsx/BarSeries.html b/doc/Axlsx/BarSeries.html index aa071eea..ac711ddc 100644 --- a/doc/Axlsx/BarSeries.html +++ b/doc/Axlsx/BarSeries.html @@ -702,7 +702,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:38 2011 by + Generated on Sun Nov 27 21:52:43 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> diff --git a/doc/Axlsx/Border.html b/doc/Axlsx/Border.html index 2e4de314..b1becd25 100644 --- a/doc/Axlsx/Border.html +++ b/doc/Axlsx/Border.html @@ -770,7 +770,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:37 2011 by + Generated on Sun Nov 27 21:52:42 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> diff --git a/doc/Axlsx/BorderPr.html b/doc/Axlsx/BorderPr.html index dea2809d..5e549bf0 100644 --- a/doc/Axlsx/BorderPr.html +++ b/doc/Axlsx/BorderPr.html @@ -700,7 +700,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:38 2011 by + Generated on Sun Nov 27 21:52:43 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> diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html index 2e6da39d..2795d665 100644 --- a/doc/Axlsx/CatAxis.html +++ b/doc/Axlsx/CatAxis.html @@ -760,7 +760,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:38 2011 by + Generated on Sun Nov 27 21:52:43 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> diff --git a/doc/Axlsx/CatAxisData.html b/doc/Axlsx/CatAxisData.html index ec16a685..92239b29 100644 --- a/doc/Axlsx/CatAxisData.html +++ b/doc/Axlsx/CatAxisData.html @@ -388,7 +388,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:26 2011 by + Generated on Sun Nov 27 21:52:31 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> diff --git a/doc/Axlsx/Cell.html b/doc/Axlsx/Cell.html index ede1f07d..3df34d79 100644 --- a/doc/Axlsx/Cell.html +++ b/doc/Axlsx/Cell.html @@ -1622,7 +1622,7 @@ xml text for the cell </div> <div id="footer"> - Generated on Sun Nov 27 21:44:41 2011 by + Generated on Sun Nov 27 21:52:45 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> diff --git a/doc/Axlsx/CellAlignment.html b/doc/Axlsx/CellAlignment.html index dde76f01..8d87931f 100644 --- a/doc/Axlsx/CellAlignment.html +++ b/doc/Axlsx/CellAlignment.html @@ -1238,7 +1238,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:42 2011 by + Generated on Sun Nov 27 21:52:46 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> diff --git a/doc/Axlsx/CellProtection.html b/doc/Axlsx/CellProtection.html index 578ca844..2270800b 100644 --- a/doc/Axlsx/CellProtection.html +++ b/doc/Axlsx/CellProtection.html @@ -556,7 +556,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:44 2011 by + Generated on Sun Nov 27 21:52:48 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> diff --git a/doc/Axlsx/CellStyle.html b/doc/Axlsx/CellStyle.html index e30b4a7e..3574cb20 100644 --- a/doc/Axlsx/CellStyle.html +++ b/doc/Axlsx/CellStyle.html @@ -940,7 +940,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:32 2011 by + Generated on Sun Nov 27 21:52:37 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> diff --git a/doc/Axlsx/Chart.html b/doc/Axlsx/Chart.html index 7a9b16d3..77cc801b 100644 --- a/doc/Axlsx/Chart.html +++ b/doc/Axlsx/Chart.html @@ -1675,7 +1675,7 @@ Chart Serialization serializes the chart </div> <div id="footer"> - Generated on Sun Nov 27 21:44:40 2011 by + Generated on Sun Nov 27 21:52:45 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> diff --git a/doc/Axlsx/Color.html b/doc/Axlsx/Color.html index b37d18ba..cabe0d1d 100644 --- a/doc/Axlsx/Color.html +++ b/doc/Axlsx/Color.html @@ -656,7 +656,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:29 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/ContentType.html b/doc/Axlsx/ContentType.html index b5631e7b..70bd847c 100644 --- a/doc/Axlsx/ContentType.html +++ b/doc/Axlsx/ContentType.html @@ -326,7 +326,7 @@ The document as a string. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:33 2011 by + Generated on Sun Nov 27 21:52:37 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> diff --git a/doc/Axlsx/Core.html b/doc/Axlsx/Core.html index ac608d16..37251c2a 100644 --- a/doc/Axlsx/Core.html +++ b/doc/Axlsx/Core.html @@ -456,7 +456,7 @@ time when this method is called. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:44 2011 by + Generated on Sun Nov 27 21:52:48 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> diff --git a/doc/Axlsx/DataTypeValidator.html b/doc/Axlsx/DataTypeValidator.html index a9b24ff1..ee08feeb 100644 --- a/doc/Axlsx/DataTypeValidator.html +++ b/doc/Axlsx/DataTypeValidator.html @@ -315,7 +315,7 @@ types or the block passed returns false </div> <div id="footer"> - Generated on Sun Nov 27 21:44:29 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Default.html b/doc/Axlsx/Default.html index f9c1a94d..7f380873 100644 --- a/doc/Axlsx/Default.html +++ b/doc/Axlsx/Default.html @@ -556,7 +556,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:30 2011 by + Generated on Sun Nov 27 21:52:34 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> diff --git a/doc/Axlsx/Drawing.html b/doc/Axlsx/Drawing.html index 72ee7ea6..d0ed25f3 100644 --- a/doc/Axlsx/Drawing.html +++ b/doc/Axlsx/Drawing.html @@ -1255,7 +1255,7 @@ Serializes the drawing </div> <div id="footer"> - Generated on Sun Nov 27 21:44:43 2011 by + Generated on Sun Nov 27 21:52:47 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> diff --git a/doc/Axlsx/Fill.html b/doc/Axlsx/Fill.html index 4a2cf21e..3171e6b2 100644 --- a/doc/Axlsx/Fill.html +++ b/doc/Axlsx/Fill.html @@ -451,7 +451,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:30 2011 by + Generated on Sun Nov 27 21:52:35 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> diff --git a/doc/Axlsx/Font.html b/doc/Axlsx/Font.html index 35ffa4ec..80ee6bd2 100644 --- a/doc/Axlsx/Font.html +++ b/doc/Axlsx/Font.html @@ -1545,7 +1545,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:31 2011 by + Generated on Sun Nov 27 21:52:35 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> diff --git a/doc/Axlsx/GradientFill.html b/doc/Axlsx/GradientFill.html index 9315c460..019d2fe8 100644 --- a/doc/Axlsx/GradientFill.html +++ b/doc/Axlsx/GradientFill.html @@ -1017,7 +1017,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:26 2011 by + Generated on Sun Nov 27 21:52:30 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> diff --git a/doc/Axlsx/GradientStop.html b/doc/Axlsx/GradientStop.html index 6d7afa37..6d4546d7 100644 --- a/doc/Axlsx/GradientStop.html +++ b/doc/Axlsx/GradientStop.html @@ -517,7 +517,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:29 2011 by + Generated on Sun Nov 27 21:52:34 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> diff --git a/doc/Axlsx/GraphicFrame.html b/doc/Axlsx/GraphicFrame.html index 3c191594..0ca334a2 100644 --- a/doc/Axlsx/GraphicFrame.html +++ b/doc/Axlsx/GraphicFrame.html @@ -633,7 +633,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:34 2011 by + Generated on Sun Nov 27 21:52:39 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> diff --git a/doc/Axlsx/Line3DChart.html b/doc/Axlsx/Line3DChart.html index 9fa25d73..42667ca9 100644 --- a/doc/Axlsx/Line3DChart.html +++ b/doc/Axlsx/Line3DChart.html @@ -995,7 +995,7 @@ Serializes the bar chart </div> <div id="footer"> - Generated on Sun Nov 27 21:44:36 2011 by + Generated on Sun Nov 27 21:52:41 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> diff --git a/doc/Axlsx/LineSeries.html b/doc/Axlsx/LineSeries.html index c38ac861..dbc5fa45 100644 --- a/doc/Axlsx/LineSeries.html +++ b/doc/Axlsx/LineSeries.html @@ -596,7 +596,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:28 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Marker.html b/doc/Axlsx/Marker.html index 51bc972f..81613635 100644 --- a/doc/Axlsx/Marker.html +++ b/doc/Axlsx/Marker.html @@ -848,7 +848,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:26 2011 by + Generated on Sun Nov 27 21:52:31 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> diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html index a087eb2f..8dd0ac81 100644 --- a/doc/Axlsx/NumFmt.html +++ b/doc/Axlsx/NumFmt.html @@ -553,7 +553,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:43 2011 by + Generated on Sun Nov 27 21:52:48 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> diff --git a/doc/Axlsx/OneCellAnchor.html b/doc/Axlsx/OneCellAnchor.html index 7a77d0c3..f75e35e3 100644 --- a/doc/Axlsx/OneCellAnchor.html +++ b/doc/Axlsx/OneCellAnchor.html @@ -973,7 +973,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:28 2011 by + Generated on Sun Nov 27 21:52:32 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> diff --git a/doc/Axlsx/Override.html b/doc/Axlsx/Override.html index 4fdb36bf..1a0de048 100644 --- a/doc/Axlsx/Override.html +++ b/doc/Axlsx/Override.html @@ -543,7 +543,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:39 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Package.html b/doc/Axlsx/Package.html index c3b046a6..e1afdd68 100644 --- a/doc/Axlsx/Package.html +++ b/doc/Axlsx/Package.html @@ -902,7 +902,7 @@ ArgumentError if workbook parameter is not a Workbook instance. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:39 2011 by + Generated on Sun Nov 27 21:52:38 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> diff --git a/doc/Axlsx/PatternFill.html b/doc/Axlsx/PatternFill.html index 1315ba7a..5e7f0e06 100644 --- a/doc/Axlsx/PatternFill.html +++ b/doc/Axlsx/PatternFill.html @@ -672,7 +672,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:30 2011 by + Generated on Sun Nov 27 21:52:34 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> diff --git a/doc/Axlsx/Pic.html b/doc/Axlsx/Pic.html index 4b5d6971..e131236c 100644 --- a/doc/Axlsx/Pic.html +++ b/doc/Axlsx/Pic.html @@ -1619,7 +1619,7 @@ providing access to the anchor’s width attribute </div> <div id="footer"> - Generated on Sun Nov 27 21:44:42 2011 by + Generated on Sun Nov 27 21:52:47 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> diff --git a/doc/Axlsx/Pie3DChart.html b/doc/Axlsx/Pie3DChart.html index a05e7c77..8703fd0b 100644 --- a/doc/Axlsx/Pie3DChart.html +++ b/doc/Axlsx/Pie3DChart.html @@ -480,7 +480,7 @@ Serializes the pie chart </div> <div id="footer"> - Generated on Sun Nov 27 21:44:26 2011 by + Generated on Sun Nov 27 21:52:30 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> diff --git a/doc/Axlsx/PieSeries.html b/doc/Axlsx/PieSeries.html index b3101562..59d0146c 100644 --- a/doc/Axlsx/PieSeries.html +++ b/doc/Axlsx/PieSeries.html @@ -701,7 +701,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:39 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/RegexValidator.html b/doc/Axlsx/RegexValidator.html index 7cab4fdb..f1571271 100644 --- a/doc/Axlsx/RegexValidator.html +++ b/doc/Axlsx/RegexValidator.html @@ -259,7 +259,7 @@ The value to validate. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:30 2011 by + Generated on Sun Nov 27 21:52:35 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> diff --git a/doc/Axlsx/Relationship.html b/doc/Axlsx/Relationship.html index 12dbfeec..6d0f4060 100644 --- a/doc/Axlsx/Relationship.html +++ b/doc/Axlsx/Relationship.html @@ -545,7 +545,7 @@ the reference id of the object. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:36 2011 by + Generated on Sun Nov 27 21:52:41 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> diff --git a/doc/Axlsx/Relationships.html b/doc/Axlsx/Relationships.html index baeb3709..28523893 100644 --- a/doc/Axlsx/Relationships.html +++ b/doc/Axlsx/Relationships.html @@ -329,7 +329,7 @@ Serializes the relationships document. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:42 2011 by + Generated on Sun Nov 27 21:52:47 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> diff --git a/doc/Axlsx/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html index 9ddb1e89..14a579a1 100644 --- a/doc/Axlsx/RestrictionValidator.html +++ b/doc/Axlsx/RestrictionValidator.html @@ -291,7 +291,7 @@ Raised if the value provided is not in the list of choices. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:33 2011 by + Generated on Sun Nov 27 21:52:38 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> diff --git a/doc/Axlsx/Row.html b/doc/Axlsx/Row.html index 24933dab..e8623faa 100644 --- a/doc/Axlsx/Row.html +++ b/doc/Axlsx/Row.html @@ -294,7 +294,7 @@ sets the style for every cell in this row. <li class="public "> <span class="summary_signature"> - <a href="#to_ary-instance_method" title="#to_ary (instance method)">- (Object) <strong>to_ary</strong> </a> + <a href="#to_ary-instance_method" title="#to_ary (instance method)">- (Array) <strong>to_ary</strong> </a> @@ -307,7 +307,11 @@ sets the style for every cell in this row. - <span class="summary_desc"><div class='inline'></div></span> + <span class="summary_desc"><div class='inline'><p> +returns the cells in this row as an array This lets us transpose the rows +into columns. +</p> +</div></span> </li> @@ -771,22 +775,48 @@ sets the style for every cell in this row <div class="method_details "> <p class="signature " id="to_ary-instance_method"> - - (<tt>Object</tt>) <strong>to_ary</strong> + - (<tt>Array</tt>) <strong>to_ary</strong> -</p><table class="source_code"> +</p><div class="docstring"> + <div class="discussion"> + <p> +returns the cells in this row as an array This lets us transpose the rows +into columns +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> <tr> <td> <pre class="lines"> -65 -66 -67</pre> +68 +69 +70</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 65</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 68</span> <span class='def def kw'>def</span> <span class='to_ary identifier id'>to_ary</span> <span class='@cells ivar id'>@cells</span><span class='dot token'>.</span><span class='to_ary identifier id'>to_ary</span> @@ -877,7 +907,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:27 2011 by + Generated on Sun Nov 27 21:52:32 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> diff --git a/doc/Axlsx/Scaling.html b/doc/Axlsx/Scaling.html index f6d2a33b..e4b9881e 100644 --- a/doc/Axlsx/Scaling.html +++ b/doc/Axlsx/Scaling.html @@ -733,7 +733,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:28 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/SerAxis.html b/doc/Axlsx/SerAxis.html index 59445925..6d122772 100644 --- a/doc/Axlsx/SerAxis.html +++ b/doc/Axlsx/SerAxis.html @@ -632,7 +632,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:37 2011 by + Generated on Sun Nov 27 21:52:42 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> diff --git a/doc/Axlsx/Series.html b/doc/Axlsx/Series.html index 925b2c4c..6142ec01 100644 --- a/doc/Axlsx/Series.html +++ b/doc/Axlsx/Series.html @@ -804,7 +804,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:32 2011 by + Generated on Sun Nov 27 21:52:36 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> diff --git a/doc/Axlsx/SeriesTitle.html b/doc/Axlsx/SeriesTitle.html index 0c21a9d8..43e526d1 100644 --- a/doc/Axlsx/SeriesTitle.html +++ b/doc/Axlsx/SeriesTitle.html @@ -281,7 +281,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:25 2011 by + Generated on Sun Nov 27 21:52:30 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> diff --git a/doc/Axlsx/Styles.html b/doc/Axlsx/Styles.html index 425c8461..1ce1ddc5 100644 --- a/doc/Axlsx/Styles.html +++ b/doc/Axlsx/Styles.html @@ -1745,7 +1745,7 @@ Serializes the styles document </div> <div id="footer"> - Generated on Sun Nov 27 21:44:27 2011 by + Generated on Sun Nov 27 21:52:32 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> diff --git a/doc/Axlsx/TableStyle.html b/doc/Axlsx/TableStyle.html index f77ec619..ad318d8a 100644 --- a/doc/Axlsx/TableStyle.html +++ b/doc/Axlsx/TableStyle.html @@ -696,7 +696,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:28 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/TableStyleElement.html b/doc/Axlsx/TableStyleElement.html index 2fe39a4a..7a8b5912 100644 --- a/doc/Axlsx/TableStyleElement.html +++ b/doc/Axlsx/TableStyleElement.html @@ -668,7 +668,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:36 2011 by + Generated on Sun Nov 27 21:52:41 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> diff --git a/doc/Axlsx/TableStyles.html b/doc/Axlsx/TableStyles.html index 9971e09e..dbbe360b 100644 --- a/doc/Axlsx/TableStyles.html +++ b/doc/Axlsx/TableStyles.html @@ -585,7 +585,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:39 2011 by + Generated on Sun Nov 27 21:52: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> diff --git a/doc/Axlsx/Title.html b/doc/Axlsx/Title.html index 6f3e21f8..acc832e6 100644 --- a/doc/Axlsx/Title.html +++ b/doc/Axlsx/Title.html @@ -534,7 +534,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:36 2011 by + Generated on Sun Nov 27 21:52:41 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> diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html index 32a5b362..731764f1 100644 --- a/doc/Axlsx/TwoCellAnchor.html +++ b/doc/Axlsx/TwoCellAnchor.html @@ -964,7 +964,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:41 2011 by + Generated on Sun Nov 27 21:52:46 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> diff --git a/doc/Axlsx/ValAxis.html b/doc/Axlsx/ValAxis.html index 3bf1fead..66d9e01b 100644 --- a/doc/Axlsx/ValAxis.html +++ b/doc/Axlsx/ValAxis.html @@ -529,7 +529,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:38 2011 by + Generated on Sun Nov 27 21:52:43 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> diff --git a/doc/Axlsx/ValAxisData.html b/doc/Axlsx/ValAxisData.html index 89dbb467..96fbca5c 100644 --- a/doc/Axlsx/ValAxisData.html +++ b/doc/Axlsx/ValAxisData.html @@ -312,7 +312,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:38 2011 by + Generated on Sun Nov 27 21:52:43 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> diff --git a/doc/Axlsx/View3D.html b/doc/Axlsx/View3D.html index b96b8c96..3eecea4e 100644 --- a/doc/Axlsx/View3D.html +++ b/doc/Axlsx/View3D.html @@ -964,7 +964,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:37 2011 by + Generated on Sun Nov 27 21:52:42 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> diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html index db00aa41..764ec304 100644 --- a/doc/Axlsx/Workbook.html +++ b/doc/Axlsx/Workbook.html @@ -1500,7 +1500,7 @@ Serializes the workbook document </div> <div id="footer"> - Generated on Sun Nov 27 21:44:33 2011 by + Generated on Sun Nov 27 21:52:38 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> diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html index 0630d08b..eb6045a5 100644 --- a/doc/Axlsx/Worksheet.html +++ b/doc/Axlsx/Worksheet.html @@ -2444,7 +2444,7 @@ of Cell objects </div> <div id="footer"> - Generated on Sun Nov 27 21:44:31 2011 by + Generated on Sun Nov 27 21:52:36 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> diff --git a/doc/Axlsx/Xf.html b/doc/Axlsx/Xf.html index 67653bae..b7da1702 100644 --- a/doc/Axlsx/Xf.html +++ b/doc/Axlsx/Xf.html @@ -1771,7 +1771,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:44:33 2011 by + Generated on Sun Nov 27 21:52:37 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> |