axlsx 1.0.10a → 1.0.10

data/doc/Axlsx/Worksheet.html

@@ -94,9 +94,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>
-The Worksheet class represents a worksheet in the workbook.
-</p>
+    
+<p>The Worksheet class represents a worksheet in the workbook.</p>
 
 
   </div>
@@ -128,9 +127,8 @@ The Worksheet class represents a worksheet in the workbook.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-An array of content based calculated column widths.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>An array of content based calculated column widths.</p>
 </div></span>
   
 </li>
@@ -155,9 +153,8 @@ An array of content based calculated column widths.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The name of the worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The name of the worksheet.</p>
 </div></span>
   
 </li>
@@ -182,9 +179,8 @@ The name of the worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The rows in this worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The rows in this worksheet.</p>
 </div></span>
   
 </li>
@@ -209,9 +205,8 @@ The rows in this worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The workbook that owns this worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The workbook that owns this worksheet.</p>
 </div></span>
   
 </li>
@@ -246,9 +241,8 @@ The workbook that owns this worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Adds a chart to this worksheets drawing.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Adds a chart to this worksheets drawing.</p>
 </div></span>
   
 </li>
@@ -270,9 +264,8 @@ Adds a chart to this worksheets drawing.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Adds a media item to the worksheets drawing.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Adds a media item to the worksheets drawing.</p>
 </div></span>
   
 </li>
@@ -294,9 +287,8 @@ Adds a media item to the worksheets drawing.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Adds a row to the worksheet and updates auto fit data.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Adds a row to the worksheet and updates auto fit data.</p>
 </div></span>
   
 </li>
@@ -318,9 +310,8 @@ Adds a row to the worksheet and updates auto fit data.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Determines the proper width for a column based on content.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Determines the proper width for a column based on content.</p>
 </div></span>
   
 </li>
@@ -342,9 +333,8 @@ Determines the proper width for a column based on content.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Set the style for cells in a specific column.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Set the style for cells in a specific column.</p>
 </div></span>
   
 </li>
@@ -366,9 +356,8 @@ Set the style for cells in a specific column.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-returns the sheet data as columnw.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>returns the sheet data as columnw.</p>
 </div></span>
   
 </li>
@@ -390,9 +379,8 @@ returns the sheet data as columnw.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The drawing associated with this worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The drawing associated with this worksheet.</p>
 </div></span>
   
 </li>
@@ -414,9 +402,8 @@ The drawing associated with this worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The index of this worksheet in the owning Workbook&#8217;s worksheets list.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The index of this worksheet in the owning Workbook’s worksheets list.</p>
 </div></span>
   
 </li>
@@ -440,9 +427,8 @@ The index of this worksheet in the owning Workbook&#8217;s worksheets list.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Creates a new worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a new worksheet.</p>
 </div></span>
   
 </li>
@@ -464,9 +450,8 @@ Creates a new worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The part name of this worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The part name of this worksheet.</p>
 </div></span>
   
 </li>
@@ -488,9 +473,8 @@ The part name of this worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The worksheet relationships.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The worksheet relationships.</p>
 </div></span>
   
 </li>
@@ -512,9 +496,8 @@ The worksheet relationships.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The relationship part name of this worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The relationship part name of this worksheet.</p>
 </div></span>
   
 </li>
@@ -536,9 +519,8 @@ The relationship part name of this worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-The relationship Id of thiw worksheet.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The relationship Id of thiw worksheet.</p>
 </div></span>
   
 </li>
@@ -560,9 +542,8 @@ The relationship Id of thiw worksheet.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Set the style for cells in a specific row.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Set the style for cells in a specific row.</p>
 </div></span>
   
 </li>
@@ -584,9 +565,8 @@ Set the style for cells in a specific row.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Serializes the worksheet document.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Serializes the worksheet document.</p>
 </div></span>
   
 </li>
@@ -608,9 +588,8 @@ Serializes the worksheet document.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-Updates auto fit data.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Updates auto fit data.</p>
 </div></span>
   
 </li>
@@ -634,15 +613,13 @@ Updates auto fit data.
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-the recommended way to manage worksheets is Workbook#add_worksheet
-</p>
+    <div class='inline'>
+<p>the recommended way to manage worksheets is Workbook#add_worksheet</p>
 </div>
   </div>
 
-<p>
-Creates a new worksheet.
-</p>
+
+<p>Creates a new worksheet.</p>
 
 
   </div>
@@ -663,9 +640,8 @@ Creates a new worksheet.
       
       
         &mdash;
-        <div class='inline'><p>
-a customizable set of options
-</p>
+        <div class='inline'>
+<p>a customizable set of options</p>
 </div>
       
     </li>
@@ -686,9 +662,8 @@ a customizable set of options
           <span class="default">
             
           </span>
-          &mdash; <div class='inline'><p>
-The name of this sheet.
-</p>
+          &mdash; <div class='inline'>
+<p>The name of this sheet.</p>
 </div>
         </li>
       
@@ -759,16 +734,14 @@ The name of this sheet.
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-a single auto fit data item is a hash with :longest =&gt; [String] and
-:sz=&gt; [Integer] members.
-</p>
+    <div class='inline'>
+<p>a single auto fit data item is a hash with :longest =&gt; [String] and
+:sz=&gt; [Integer] members.</p>
 </div>
   </div>
 
-<p>
-An array of content based calculated column widths.
-</p>
+
+<p>An array of content based calculated column widths.</p>
 
 
   </div>
@@ -786,9 +759,8 @@ An array of content based calculated column widths.
       
       
         &mdash;
-        <div class='inline'><p>
-of Hash
-</p>
+        <div class='inline'>
+<p>of Hash</p>
 </div>
       
     </li>
@@ -829,9 +801,8 @@ of Hash
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-The name of the worksheet
-</p>
+    
+<p>The name of the worksheet</p>
 
 
   </div>
@@ -889,15 +860,13 @@ The name of the worksheet
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-The recommended way to manage rows is Worksheet#add_row
-</p>
+    <div class='inline'>
+<p>The recommended way to manage rows is Worksheet#add_row</p>
 </div>
   </div>
 
-<p>
-The rows in this worksheet
-</p>
+
+<p>The rows in this worksheet</p>
 
 
   </div>
@@ -959,9 +928,8 @@ The rows in this worksheet
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-The workbook that owns this worksheet
-</p>
+    
+<p>The workbook that owns this worksheet</p>
 
 
   </div>
@@ -1023,18 +991,16 @@ The workbook that owns this worksheet
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-each chart type also specifies additional options
-</p>
+    <div class='inline'>
+<p>each chart type also specifies additional options</p>
 </div>
   </div>
 
-<p>
-Adds a chart to this worksheets drawing. This is the recommended way to
+
+<p>Adds a chart to this worksheets drawing. This is the recommended way to
 create charts for your worksheet. This method wraps the complexity of
 dealing with ooxml drawing, anchors, markers graphic frames chart objects
-and all the other dirty details.
-</p>
+and all the other dirty details.</p>
 
 
   </div>
@@ -1066,9 +1032,8 @@ and all the other dirty details.
       
       
         &mdash;
-        <div class='inline'><p>
-a customizable set of options
-</p>
+        <div class='inline'>
+<p>a customizable set of options</p>
 </div>
       
     </li>
@@ -1195,9 +1160,8 @@ a customizable set of options
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-Adds a media item to the worksheets drawing
-</p>
+    
+<p>Adds a media item to the worksheets drawing</p>
 
 
   </div>
@@ -1229,9 +1193,8 @@ Adds a media item to the worksheets drawing
       
       
         &mdash;
-        <div class='inline'><p>
-a customizable set of options
-</p>
+        <div class='inline'>
+<p>a customizable set of options</p>
 </div>
       
     </li>
@@ -1250,9 +1213,8 @@ a customizable set of options
           <span class="default">
             
           </span>
-          &mdash; <div class='inline'><p>
-unknown
-</p>
+          &mdash; <div class='inline'>
+<p>unknown</p>
 </div>
         </li>
       
@@ -1308,9 +1270,8 @@ unknown
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-Adds a row to the worksheet and updates auto fit data
-</p>
+    
+<p>Adds a row to the worksheet and updates auto fit data</p>
 
 
   </div>
@@ -1331,9 +1292,8 @@ Adds a row to the worksheet and updates auto fit data
       
       
         &mdash;
-        <div class='inline'><p>
-a customizable set of options
-</p>
+        <div class='inline'>
+<p>a customizable set of options</p>
 </div>
       
     </li>
@@ -1445,20 +1405,18 @@ a customizable set of options
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-From ECMA docs
-</p>
-<pre class="code">
- <span class='Column constant id'>Column</span> <span class='width identifier id'>width</span> <span class='measured identifier id'>measured</span> <span class='as identifier id'>as</span> <span class='the identifier id'>the</span> <span class='number identifier id'>number</span> <span class='of identifier id'>of</span> <span class='characters identifier id'>characters</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='maximum identifier id'>maximum</span> <span class='digit identifier id'>digit</span> <span class='width identifier id'>width</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='numbers identifier id'>numbers</span> <span class='integer val'>0</span> <span class='dot2 op'>..</span> <span class='integer val'>9</span> <span class='as identifier id'>as</span>
- <span class='rendered identifier id'>rendered</span> <span class='in in kw'>in</span> <span class='the identifier id'>the</span> <span class='normal identifier id'>normal</span> <span class='style identifier id'>style</span><span class='string val'>'s font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
- width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256
+    <div class='inline'>
+<p>From ECMA docs</p>
+
+<pre class="code"><span class='Column constant id'>Column</span> <span class='width identifier id'>width</span> <span class='measured identifier id'>measured</span> <span class='as identifier id'>as</span> <span class='the identifier id'>the</span> <span class='number identifier id'>number</span> <span class='of identifier id'>of</span> <span class='characters identifier id'>characters</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='maximum identifier id'>maximum</span> <span class='digit identifier id'>digit</span> <span class='width identifier id'>width</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='numbers identifier id'>numbers</span> <span class='integer val'>0</span> <span class='dot2 op'>..</span> <span class='integer val'>9</span> <span class='as identifier id'>as</span> 
+<span class='rendered identifier id'>rendered</span> <span class='in in kw'>in</span> <span class='the identifier id'>the</span> <span class='normal identifier id'>normal</span> <span class='style identifier id'>style</span><span class='string val'>'s font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
+width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256
 </span></pre>
 </div>
   </div>
 
-<p>
-Determines the proper width for a column based on content.
-</p>
+
+<p>Determines the proper width for a column based on content.</p>
 
 
   </div>
@@ -1477,9 +1435,8 @@ Determines the proper width for a column based on content.
       
       
         &mdash;
-        <div class='inline'><p>
-hash of auto_fit_data
-</p>
+        <div class='inline'>
+<p>hash of auto_fit_data</p>
 </div>
       
     </li>
@@ -1550,16 +1507,14 @@ hash of auto_fit_data
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-You can also specify the style for specific columns in the call to add_row
-by using an array for the :styles option
-</p>
+    <div class='inline'>
+<p>You can also specify the style for specific columns in the call to add_row
+by using an array for the :styles option</p>
 </div>
   </div>
 
-<p>
-Set the style for cells in a specific column
-</p>
+
+<p>Set the style for cells in a specific column</p>
 
 
   </div>
@@ -1578,9 +1533,8 @@ Set the style for cells in a specific column
       
       
         &mdash;
-        <div class='inline'><p>
-the index of the column
-</p>
+        <div class='inline'>
+<p>the index of the column</p>
 </div>
       
     </li>
@@ -1595,9 +1549,8 @@ the index of the column
       
       
         &mdash;
-        <div class='inline'><p>
-cellXfs index
-</p>
+        <div class='inline'>
+<p>cellXfs index</p>
 </div>
       
     </li>
@@ -1614,9 +1567,8 @@ cellXfs index
       
       
         &mdash;
-        <div class='inline'><p>
-a customizable set of options
-</p>
+        <div class='inline'>
+<p>a customizable set of options</p>
 </div>
       
     </li>
@@ -1639,9 +1591,8 @@ a customizable set of options
           <span class="default">
             
           </span>
-          &mdash; <div class='inline'><p>
-only cells after this column will be updated.
-</p>
+          &mdash; <div class='inline'>
+<p>only cells after this column will be updated.</p>
 </div>
         </li>
       
@@ -1705,9 +1656,8 @@ only cells after this column will be updated.
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-returns the sheet data as columnw
-</p>
+    
+<p>returns the sheet data as columnw</p>
 
 
   </div>
@@ -1749,15 +1699,13 @@ returns the sheet data as columnw
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-the recommended way to work with drawings and charts is Worksheet#add_chart
-</p>
+    <div class='inline'>
+<p>the recommended way to work with drawings and charts is Worksheet#add_chart</p>
 </div>
   </div>
 
-<p>
-The drawing associated with this worksheet.
-</p>
+
+<p>The drawing associated with this worksheet.</p>
 
 
   </div>
@@ -1816,9 +1764,8 @@ The drawing associated with this worksheet.
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-The index of this worksheet in the owning Workbook&#8217;s worksheets list.
-</p>
+    
+<p>The index of this worksheet in the owning Workbook’s worksheets list.</p>
 
 
   </div>
@@ -1870,9 +1817,8 @@ The index of this worksheet in the owning Workbook&#8217;s worksheets list.
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-The part name of this worksheet
-</p>
+    
+<p>The part name of this worksheet</p>
 
 
   </div>
@@ -1924,9 +1870,8 @@ The part name of this worksheet
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-The worksheet relationships. This is managed automatically by the worksheet
-</p>
+    
+<p>The worksheet relationships. This is managed automatically by the worksheet</p>
 
 
   </div>
@@ -1982,9 +1927,8 @@ The worksheet relationships. This is managed automatically by the worksheet
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-The relationship part name of this worksheet
-</p>
+    
+<p>The relationship part name of this worksheet</p>
 
 
   </div>
@@ -2036,9 +1980,8 @@ The relationship part name of this worksheet
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-The relationship Id of thiw worksheet
-</p>
+    
+<p>The relationship Id of thiw worksheet</p>
 
 
   </div>
@@ -2093,15 +2036,13 @@ The relationship Id of thiw worksheet
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'><p>
-You can also specify the style in the add_row call
-</p>
+    <div class='inline'>
+<p>You can also specify the style in the add_row call</p>
 </div>
   </div>
 
-<p>
-Set the style for cells in a specific row
-</p>
+
+<p>Set the style for cells in a specific row</p>
 
 
   </div>
@@ -2120,9 +2061,8 @@ Set the style for cells in a specific row
       
       
         &mdash;
-        <div class='inline'><p>
-or range of indexes in the table
-</p>
+        <div class='inline'>
+<p>or range of indexes in the table</p>
 </div>
       
     </li>
@@ -2137,9 +2077,8 @@ or range of indexes in the table
       
       
         &mdash;
-        <div class='inline'><p>
-cellXfs index
-</p>
+        <div class='inline'>
+<p>cellXfs index</p>
 </div>
       
     </li>
@@ -2156,9 +2095,8 @@ cellXfs index
       
       
         &mdash;
-        <div class='inline'><p>
-a customizable set of options
-</p>
+        <div class='inline'>
+<p>a customizable set of options</p>
 </div>
       
     </li>
@@ -2181,9 +2119,8 @@ a customizable set of options
           <span class="default">
             
           </span>
-          &mdash; <div class='inline'><p>
-only cells after this column will be updated.
-</p>
+          &mdash; <div class='inline'>
+<p>only cells after this column will be updated.</p>
 </div>
         </li>
       
@@ -2243,9 +2180,8 @@ only cells after this column will be updated.
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-Serializes the worksheet document
-</p>
+    
+<p>Serializes the worksheet document</p>
 
 
   </div>
@@ -2333,11 +2269,10 @@ Serializes the worksheet document
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-Updates auto fit data. Autofit data attempts to determine the cell in a
+    
+<p>Updates auto fit data.  Autofit data attempts to determine the cell in a
 column that has the greatest width by comparing the length of the text
-multiplied by the size of the font.
-</p>
+multiplied by the size of the font.</p>
 
 
   </div>
@@ -2356,9 +2291,8 @@ multiplied by the size of the font.
       
       
         &mdash;
-        <div class='inline'><p>
-an array of cells
-</p>
+        <div class='inline'>
+<p>an array of cells</p>
 </div>
       
     </li>
@@ -2376,9 +2310,8 @@ an array of cells
       
       
         &mdash;
-        <div class='inline'><p>
-of Cell objects
-</p>
+        <div class='inline'>
+<p>of Cell objects</p>
 </div>
       
     </li>
@@ -2444,7 +2377,7 @@ of Cell objects
 </div>
     
     <div id="footer">
-  Generated on Sun Nov 27 21:54:17 2011 by 
+  Generated on Wed Nov 30 08:53: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>