diff options
Diffstat (limited to 'doc/Axlsx/Worksheet.html')
| -rw-r--r-- | doc/Axlsx/Worksheet.html | 1115 |
1 files changed, 903 insertions, 212 deletions
diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html index db1e39f7..05bc4c18 100644 --- a/doc/Axlsx/Worksheet.html +++ b/doc/Axlsx/Worksheet.html @@ -94,8 +94,9 @@ <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> @@ -127,8 +128,9 @@ - <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> @@ -153,8 +155,9 @@ - <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> @@ -179,8 +182,9 @@ - <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> @@ -205,8 +209,9 @@ - <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> @@ -241,8 +246,9 @@ - <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> @@ -264,8 +270,9 @@ - <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> @@ -287,8 +294,57 @@ - <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> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#auto_width-instance_method" title="#auto_width (instance method)">- (Float) <strong>auto_width</strong>(col) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines the proper width for a column based on content. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#col_style-instance_method" title="#col_style (instance method)">- (Object) <strong>col_style</strong>(index, style, options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Set the style for cells in a specific column. +</p> </div></span> </li> @@ -310,8 +366,9 @@ - <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> @@ -333,8 +390,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The index of this worksheet in the owning Workbook'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> @@ -358,8 +416,9 @@ - <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> @@ -381,8 +440,9 @@ - <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> @@ -404,8 +464,9 @@ - <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> @@ -427,8 +488,9 @@ - <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> @@ -450,8 +512,33 @@ - <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> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#row_style-instance_method" title="#row_style (instance method)">- (Object) <strong>row_style</strong>(index, style, options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Set the style for cells in a specific row. +</p> </div></span> </li> @@ -473,8 +560,33 @@ - <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> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#update_auto_fit_data-instance_method" title="#update_auto_fit_data (instance method)">- (Array) <strong>update_auto_fit_data</strong>(cells) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Updates auto fit data. +</p> </div></span> </li> @@ -498,13 +610,15 @@ <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> @@ -525,8 +639,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -547,8 +662,9 @@ <span class="default"> </span> - — <div class='inline'> -<p>The name of this sheet.</p> + — <div class='inline'><p> +The name of this sheet. +</p> </div> </li> @@ -582,15 +698,16 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 34</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id wb'>wb</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='ivar'>@drawing</span> <span class='op'>=</span> <span class='kw'>nil</span> - <span class='ivar'>@rows</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Row</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id workbook'>workbook</span> <span class='op'>=</span> <span class='id wb'>wb</span> - <span class='ivar'>@workbook</span><span class='period'>.</span><span class='id worksheets'>worksheets</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@auto_fit_data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id name'>name</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Sheet</span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='period'>.</span><span class='id to_s'>to_s</span> - <span class='ivar'>@magick_draw</span> <span class='op'>=</span> <span class='const'>Magick</span><span class='op'>::</span><span class='const'>Draw</span><span class='period'>.</span><span class='id new'>new</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='wb identifier id'>wb</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='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='@rows ivar id'>@rows</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Row constant id'>Row</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span> + <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack 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='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"Sheet"</span> <span class='plus op'>+</span> <span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='@magick_draw ivar id'>@magick_draw</span> <span class='assign token'>=</span> <span class='Magick constant id'>Magick</span><span class='colon2 op'>::</span><span class='Draw constant id'>Draw</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -616,14 +733,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>a single auto fit data item is a hash with :longest => [String] and -:sz=> [Integer] members.</p> + <div class='inline'><p> +a single auto fit data item is a hash with :longest => [String] and +:sz=> [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> @@ -641,8 +760,9 @@ — - <div class='inline'> -<p>of Hash</p> + <div class='inline'><p> +of Hash +</p> </div> </li> @@ -662,9 +782,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 25</span> -<span class='kw'>def</span> <span class='id auto_fit_data'>auto_fit_data</span> - <span class='ivar'>@auto_fit_data</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='auto_fit_data identifier id'>auto_fit_data</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -682,8 +803,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The name of the worksheet</p> + <p> +The name of the worksheet +</p> </div> @@ -717,9 +839,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 9</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<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> @@ -740,13 +863,15 @@ <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> @@ -787,9 +912,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 20</span> -<span class='kw'>def</span> <span class='id rows'>rows</span> - <span class='ivar'>@rows</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rows identifier id'>rows</span> + <span class='@rows ivar id'>@rows</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -807,8 +933,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The workbook that owns this worksheet</p> + <p> +The workbook that owns this worksheet +</p> </div> @@ -842,9 +969,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 13</span> -<span class='kw'>def</span> <span class='id workbook'>workbook</span> - <span class='ivar'>@workbook</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> + <span class='@workbook ivar id'>@workbook</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -869,16 +997,18 @@ <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> @@ -910,8 +1040,9 @@ and all the other dirty details.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1009,20 +1140,21 @@ and all the other dirty details.</p> <pre class="lines"> -105 -106 -107 -108 -109</pre> +132 +133 +134 +135 +136</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 105</span> - -<span class='kw'>def</span> <span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</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 chart'>chart</span> <span class='op'>=</span> <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id chart'>chart</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='id chart'>chart</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 132</span> + +<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</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='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='chart identifier id'>chart</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='chart identifier id'>chart</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1037,8 +1169,9 @@ and all the other dirty details.</p> </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> @@ -1070,8 +1203,9 @@ and all the other dirty details.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1090,8 +1224,9 @@ and all the other dirty details.</p> <span class="default"> </span> - — <div class='inline'> -<p>unknown</p> + — <div class='inline'><p> +unknown +</p> </div> </li> @@ -1118,20 +1253,21 @@ and all the other dirty details.</p> <pre class="lines"> -114 -115 -116 -117 -118</pre> +141 +142 +143 +144 +145</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 114</span> - -<span class='kw'>def</span> <span class='id add_image'>add_image</span><span class='lparen'>(</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 image'>image</span> <span class='op'>=</span> <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id add_image'>add_image</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id image'>image</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='id image'>image</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 141</span> + +<span class='def def kw'>def</span> <span class='add_image identifier id'>add_image</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='image identifier id'>image</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='image identifier id'>image</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='image identifier id'>image</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1146,8 +1282,9 @@ and all the other dirty details.</p> </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> @@ -1168,8 +1305,9 @@ and all the other dirty details.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1257,12 +1395,277 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 85</span> -<span class='kw'>def</span> <span class='id add_row'>add_row</span><span class='lparen'>(</span><span class='id values'>values</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</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='const'>Row</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id values'>values</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='id update_auto_fit_data'>update_auto_fit_data</span> <span class='ivar'>@rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span> - <span class='kw'>yield</span> <span class='ivar'>@rows</span><span class='period'>.</span><span class='id last'>last</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='ivar'>@rows</span><span class='period'>.</span><span class='id last'>last</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_row identifier id'>add_row</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</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 constant id'>Row</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='yield yield kw'>yield</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="auto_width-instance_method"> + + - (<tt>Float</tt>) <strong>auto_width</strong>(col) + + + +</p><div class="docstring"> + <div class="discussion"> + + <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 +</span></pre> +</div> + </div> + +<p> +Determines the proper width for a column based on content. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>A</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'><p> +hash of auto_fit_data +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 216</span> + +<span class='def def kw'>def</span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span> + <span class='mdw identifier id'>mdw</span> <span class='assign token'>=</span> <span class='float val'>6.0</span> <span class='comment val'># maximum digit with is always 6.0 with RMagick's default font</span> + <span class='mdw_count identifier id'>mdw_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='best_guess identifier id'>best_guess</span> <span class='assign token'>=</span> <span class='float val'>1.5</span> <span class='comment val'>#direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling</span> + <span class='font_scale identifier id'>font_scale</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='orop op'>||</span> <span class='float val'>11.0</span><span class='rparen token'>)</span> + + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</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='i identifier id'>i</span><span class='bitor op'>|</span> + <span class='mdw_count identifier id'>mdw_count</span> <span class='opasgn op'>+=</span><span class='integer val'>1</span> <span class='if if_mod kw'>if</span> <span class='@magick_draw ivar id'>@magick_draw</span><span class='dot token'>.</span><span class='get_type_metrics identifier id'>get_type_metrics</span><span class='lparen token'>(</span><span class='i identifier id'>i</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='geq op'>>=</span> <span class='mdw identifier id'>mdw</span> + <span class='end end kw'>end</span> + <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='mdw_count identifier id'>mdw_count</span> <span class='mult op'>*</span> <span class='mdw identifier id'>mdw</span> <span class='plus op'>+</span> <span class='integer val'>5</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='mdw identifier id'>mdw</span> <span class='mult op'>*</span> <span class='integer val'>256</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='float val'>256.0</span> <span class='mult op'>*</span> <span class='best_guess identifier id'>best_guess</span> <span class='mult op'>*</span> <span class='font_scale identifier id'>font_scale</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="col_style-instance_method"> + + - (<tt>Object</tt>) <strong>col_style</strong>(index, style, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + + <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> + </div> + +<p> +Set the style for cells in a specific column +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>index</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the index of the column +</p> +</div> + + </li> + + <li> + + <span class='name'>the</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +cellXfs index +</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">row_offset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +only cells after this column will be updated. +</p> +</div> + </li> + + </ul> + + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li> + + <li>for an example</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +113 +114 +115 +116 +117</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 113</span> + +<span class='def def kw'>def</span> <span class='col_style identifier id'>col_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</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='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Invalid Column Index"</span> <span class='unless unless_mod kw'>unless</span> <span class='index identifier id'>index</span> <span class='lt op'><</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='offset identifier id'>offset</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'>:row_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</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='r identifier id'>r</span><span class='bitor op'>|</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1280,13 +1683,15 @@ and all the other dirty details.</p> <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> @@ -1327,9 +1732,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 76</span> -<span class='kw'>def</span> <span class='id drawing'>drawing</span> - <span class='ivar'>@drawing</span> <span class='op'>||</span> <span class='ivar'>@drawing</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Drawing</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> + <span class='@drawing ivar id'>@drawing</span> <span class='orop op'>||</span> <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Drawing constant id'>Drawing</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1344,8 +1750,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this worksheet in the owning Workbook's worksheets list.</p> + <p> +The index of this worksheet in the owning Workbook’s worksheets list. +</p> </div> @@ -1379,9 +1786,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 68</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@workbook</span><span class='period'>.</span><span class='id worksheets'>worksheets</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1396,8 +1804,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The part name of this worksheet</p> + <p> +The part name of this worksheet +</p> </div> @@ -1431,9 +1840,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 50</span> -<span class='kw'>def</span> <span class='id pn'>pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>WORKSHEET_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{WORKSHEET_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1448,8 +1858,9 @@ and all the other dirty details.</p> </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> @@ -1476,20 +1887,21 @@ and all the other dirty details.</p> <pre class="lines"> -146 -147 -148 -149 -150</pre> +173 +174 +175 +176 +177</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 146</span> - -<span class='kw'>def</span> <span class='id relationships'>relationships</span> - <span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Relationships</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>DRAWING_R</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>../</span><span class='embexpr_beg'>#{</span><span class='ivar'>@drawing</span><span class='period'>.</span><span class='id pn'>pn</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@drawing</span> - <span class='id r'>r</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 173</span> + +<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> + <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='DRAWING_R constant id'>DRAWING_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{@drawing.pn}"</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> + <span class='r identifier id'>r</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1504,8 +1916,9 @@ and all the other dirty details.</p> </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> @@ -1539,9 +1952,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 56</span> -<span class='kw'>def</span> <span class='id rels_pn'>rels_pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>WORKSHEET_RELS_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span> + <span class='dstring node'>"#{WORKSHEET_RELS_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1556,8 +1970,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The relationship Id of thiw worksheet</p> + <p> +The relationship Id of thiw worksheet +</p> </div> @@ -1591,9 +2006,168 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 62</span> -<span class='kw'>def</span> <span class='id rId'>rId</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId</span><span class='embexpr_beg'>#{</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> + <span class='dstring node'>"rId#{index+1}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="row_style-instance_method"> + + - (<tt>Object</tt>) <strong>row_style</strong>(index, style, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <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> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>index</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the index of the row +</p> +</div> + + </li> + + <li> + + <span class='name'>the</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +cellXfs index +</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">col_offset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +only cells after this column will be updated. +</p> +</div> + </li> + + </ul> + + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li> + + <li>for an example</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +99 +100 +101 +102 +103</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 99</span> + +<span class='def def kw'>def</span> <span class='row_style identifier id'>row_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</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='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Invalid Row Index"</span> <span class='unless unless_mod kw'>unless</span> <span class='index identifier id'>index</span> <span class='lt op'><</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='offset identifier id'>offset</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'>:col_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</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='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1608,8 +2182,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the worksheet document</p> + <p> +Serializes the worksheet document +</p> </div> @@ -1636,52 +2211,168 @@ and all the other dirty details.</p> <pre class="lines"> -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142</pre> +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 149</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='if if kw'>if</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>0</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='cols identifier id'>cols</span> <span class='lbrace token'>{</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='min_max identifier id'>min_max</span> <span class='assign token'>=</span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='col identifier id'>col</span><span class='lparen token'>(</span><span class='symbol val'>:min=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:max=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:width</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:customWidth=</span><span class='gt op'>></span><span class='string val'>"true"</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheetData identifier id'>sheetData</span> <span class='lbrace token'>{</span> + <span class='@rows ivar id'>@rows</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='row identifier id'>row</span><span class='bitor op'>|</span> + <span class='row identifier id'>row</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='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span> <span class='symbol val'>:"r:id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"rId1"</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="update_auto_fit_data-instance_method"> + + - (<tt>Array</tt>) <strong>update_auto_fit_data</strong>(cells) + + + +</p><div class="docstring"> + <div class="discussion"> + <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> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>cells</span> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +an array of cells +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +of Cell objects +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 122</span> - -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='lparen'>(</span><span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>XML_NS</span><span class='comma'>,</span> <span class='symbol'>:xmlns:r</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_R</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>if</span> <span class='ivar'>@auto_fit_data</span><span class='period'>.</span><span class='id size'>size</span> <span class='op'>></span> <span class='int'>0</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id cols'>cols</span> <span class='lbrace'>{</span> - <span class='ivar'>@auto_fit_data</span><span class='period'>.</span><span class='id each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id col'>col</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span> - <span class='id min_max'>min_max</span> <span class='op'>=</span> <span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id col'>col</span><span class='lparen'>(</span><span class='symbol'>:min</span><span class='op'>=></span><span class='id min_max'>min_max</span><span class='comma'>,</span> <span class='symbol'>:max</span><span class='op'>=></span><span class='id min_max'>min_max</span><span class='comma'>,</span> <span class='symbol'>:width</span> <span class='op'>=></span> <span class='id auto_width'>auto_width</span><span class='lparen'>(</span><span class='id col'>col</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='symbol'>:customWidth</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>true</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id sheetData'>sheetData</span> <span class='lbrace'>{</span> - <span class='ivar'>@rows</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id row'>row</span><span class='op'>|</span> - <span class='id row'>row</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id drawing'>drawing</span> <span class='symbol'>:r:id</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId1</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@drawing</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 188</span> + +<span class='def def kw'>def</span> <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span><span class='lparen token'>(</span><span class='cells identifier id'>cells</span><span class='rparen token'>)</span> + <span class='styles identifier id'>styles</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span> + <span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='fonts identifier id'>fonts</span> <span class='assign token'>=</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span> + <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> + + <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrace token'>{</span><span class='symbol val'>:longest=</span><span class='gt op'>></span><span class='string val'>""</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='sz identifier id'>sz</span><span class='rbrace token'>}</span> + <span class='cell_xf identifier id'>cell_xf</span> <span class='assign token'>=</span> <span class='cellXfs identifier id'>cellXfs</span><span class='lbrack token'>[</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='rbrack token'>]</span> + <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='cell_xf identifier id'>cell_xf</span><span class='dot token'>.</span><span class='fontId identifier id'>fontId</span> <span class='orop op'>||</span> <span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> <span class='orop op'>||</span> <span class='sz identifier id'>sz</span> + + <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='lt op'><</span> <span class='lparen token'>(</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='sz identifier id'>sz</span><span class='rparen token'>)</span> + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='sz identifier id'>sz</span> + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='end end kw'>end</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> + <span class='end end kw'>end</span> + <span class='cells identifier id'>cells</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1692,9 +2383,9 @@ and all the other dirty details.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:40 2011 by + Generated on Sun Nov 27 18:05:04 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> |