rdoc/RubyXL/WorksheetConvenienceMethods.html in rubyXL-3.4.25 vs rdoc/RubyXL/WorksheetConvenienceMethods.html in rubyXL-3.4.26
- old
+ new
@@ -2,11 +2,11 @@
<html>
<head>
<meta charset="UTF-8">
-<title>module RubyXL::WorksheetConvenienceMethods - rubyXL 3.4.25</title>
+<title>module RubyXL::WorksheetConvenienceMethods - rubyXL 3.4.26</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
@@ -39,11 +39,11 @@
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
- type="text" name="search" placeholder="Search" spellcheck="false"
+ type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
@@ -181,14 +181,16 @@
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-add_validation_list" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">add_validation_list</span><span
- class="method-args">(ref, list_arr)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">add_validation_list</span><span
+ class="method-args">(ref, list_arr)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -210,14 +212,16 @@
</div>
<div id="method-i-change_column_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_alignment</span><span
- class="method-args">(column_index, &block)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_alignment</span><span
+ class="method-args">(column_index, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -243,14 +247,16 @@
</div>
<div id="method-i-change_column_bold" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_bold</span><span
- class="method-args">(column_index, bolded = false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_bold</span><span
+ class="method-args">(column_index, bolded = false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -267,14 +273,16 @@
</div>
<div id="method-i-change_column_border" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_border</span><span
- class="method-args">(column_index, direction, weight)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_border</span><span
+ class="method-args">(column_index, direction, weight)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -298,14 +306,16 @@
</div>
<div id="method-i-change_column_border_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_border_color</span><span
- class="method-args">(column_index, direction, color)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_border_color</span><span
+ class="method-args">(column_index, direction, color)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -328,14 +338,16 @@
</div>
<div id="method-i-change_column_fill" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_fill</span><span
- class="method-args">(column_index, color_code = 'ffffff')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_fill</span><span
+ class="method-args">(column_index, color_code = 'ffffff')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -360,14 +372,16 @@
</div>
<div id="method-i-change_column_font" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_font</span><span
- class="method-args">(column_index, change_type, arg, font, xf)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_font</span><span
+ class="method-args">(column_index, change_type, arg, font, xf)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Helper method to update the fonts and cell styles array main method to change font, called from each separate font mutator method</p>
@@ -390,14 +404,16 @@
</div>
<div id="method-i-change_column_font_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_font_color</span><span
- class="method-args">(column_index, font_color='000000')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_font_color</span><span
+ class="method-args">(column_index, font_color='000000')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -416,14 +432,16 @@
</div>
<div id="method-i-change_column_font_name" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_font_name</span><span
- class="method-args">(column_index = 0, font_name = 'Verdana')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_font_name</span><span
+ class="method-args">(column_index = 0, font_name = 'Verdana')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -440,14 +458,16 @@
</div>
<div id="method-i-change_column_font_size" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_font_size</span><span
- class="method-args">(column_index, font_size=10)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_font_size</span><span
+ class="method-args">(column_index, font_size=10)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -464,14 +484,16 @@
</div>
<div id="method-i-change_column_horizontal_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_horizontal_alignment</span><span
- class="method-args">(column_index, alignment = 'center')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_horizontal_alignment</span><span
+ class="method-args">(column_index, alignment = 'center')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -485,14 +507,16 @@
</div>
<div id="method-i-change_column_italics" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_italics</span><span
- class="method-args">(column_index, italicized = false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_italics</span><span
+ class="method-args">(column_index, italicized = false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -509,14 +533,16 @@
</div>
<div id="method-i-change_column_strikethrough" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_strikethrough</span><span
- class="method-args">(column_index, struckthrough=false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_strikethrough</span><span
+ class="method-args">(column_index, struckthrough=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -533,14 +559,16 @@
</div>
<div id="method-i-change_column_underline" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_underline</span><span
- class="method-args">(column_index, underlined = false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_underline</span><span
+ class="method-args">(column_index, underlined = false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -557,14 +585,16 @@
</div>
<div id="method-i-change_column_vertical_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_vertical_alignment</span><span
- class="method-args">(column_index, alignment = 'center')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_vertical_alignment</span><span
+ class="method-args">(column_index, alignment = 'center')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -578,14 +608,16 @@
</div>
<div id="method-i-change_column_width" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_width</span><span
- class="method-args">(column_index, width_in_chars = RubyXL::ColumnRange::DEFAULT_WIDTH)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_width</span><span
+ class="method-args">(column_index, width_in_chars = RubyXL::ColumnRange::DEFAULT_WIDTH)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Get column width measured in number of digits, as per <a href="http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column%28v=office.14%29.aspx">msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column%28v=office.14%29.aspx</a></p>
@@ -599,14 +631,16 @@
</div>
<div id="method-i-change_column_width_raw" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_column_width_raw</span><span
- class="method-args">(column_index, width)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_column_width_raw</span><span
+ class="method-args">(column_index, width)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Set raw column width value</p>
@@ -624,14 +658,16 @@
</div>
<div id="method-i-change_row_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_alignment</span><span
- class="method-args">(row, &block)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_alignment</span><span
+ class="method-args">(row, &block)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -654,14 +690,16 @@
</div>
<div id="method-i-change_row_bold" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_bold</span><span
- class="method-args">(row = 0, bolded = false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_bold</span><span
+ class="method-args">(row = 0, bolded = false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -678,14 +716,16 @@
</div>
<div id="method-i-change_row_border" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_border</span><span
- class="method-args">(row, direction, weight)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_border</span><span
+ class="method-args">(row, direction, weight)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -706,14 +746,16 @@
</div>
<div id="method-i-change_row_border_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_border_color</span><span
- class="method-args">(row, direction, color = '000000')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_border_color</span><span
+ class="method-args">(row, direction, color = '000000')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -735,14 +777,16 @@
</div>
<div id="method-i-change_row_fill" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_fill</span><span
- class="method-args">(row_index = 0, rgb = 'ffffff')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_fill</span><span
+ class="method-args">(row_index = 0, rgb = 'ffffff')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -761,14 +805,16 @@
</div>
<div id="method-i-change_row_font" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_font</span><span
- class="method-args">(row_index, change_type, arg, font)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_font</span><span
+ class="method-args">(row_index, change_type, arg, font)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Helper method to update the row styles array change_type - <a href="WorksheetConvenienceMethods.html#NAME"><code>NAME</code></a> or <a href="WorksheetConvenienceMethods.html#SIZE"><code>SIZE</code></a> or <a href="WorksheetConvenienceMethods.html#COLOR"><code>COLOR</code></a> etc main method to change font, called from each separate font mutator method</p>
@@ -788,14 +834,16 @@
</div>
<div id="method-i-change_row_font_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_font_color</span><span
- class="method-args">(row = 0, font_color = '000000')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_font_color</span><span
+ class="method-args">(row = 0, font_color = '000000')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -813,14 +861,16 @@
</div>
<div id="method-i-change_row_font_name" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_font_name</span><span
- class="method-args">(row = 0, font_name = 'Verdana')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_font_name</span><span
+ class="method-args">(row = 0, font_name = 'Verdana')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -837,14 +887,16 @@
</div>
<div id="method-i-change_row_font_size" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_font_size</span><span
- class="method-args">(row = 0, font_size=10)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_font_size</span><span
+ class="method-args">(row = 0, font_size=10)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -861,14 +913,16 @@
</div>
<div id="method-i-change_row_height" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_height</span><span
- class="method-args">(row = 0, height = 10)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_height</span><span
+ class="method-args">(row = 0, height = 10)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -887,14 +941,16 @@
</div>
<div id="method-i-change_row_horizontal_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_horizontal_alignment</span><span
- class="method-args">(row = 0, alignment = 'center')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_horizontal_alignment</span><span
+ class="method-args">(row = 0, alignment = 'center')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -910,14 +966,16 @@
</div>
<div id="method-i-change_row_italics" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_italics</span><span
- class="method-args">(row = 0, italicized = false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_italics</span><span
+ class="method-args">(row = 0, italicized = false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -934,14 +992,16 @@
</div>
<div id="method-i-change_row_strikethrough" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_strikethrough</span><span
- class="method-args">(row = 0, struckthrough=false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_strikethrough</span><span
+ class="method-args">(row = 0, struckthrough=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -958,14 +1018,16 @@
</div>
<div id="method-i-change_row_underline" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_underline</span><span
- class="method-args">(row = 0, underlined=false)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_underline</span><span
+ class="method-args">(row = 0, underlined=false)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -982,14 +1044,16 @@
</div>
<div id="method-i-change_row_vertical_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">change_row_vertical_alignment</span><span
- class="method-args">(row = 0, alignment = 'center')</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">change_row_vertical_alignment</span><span
+ class="method-args">(row = 0, alignment = 'center')</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1005,14 +1069,16 @@
</div>
<div id="method-i-column_font" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">column_font</span><span
- class="method-args">(col)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">column_font</span><span
+ class="method-args">(col)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1028,14 +1094,16 @@
</div>
<div id="method-i-delete_cell" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">delete_cell</span><span
- class="method-args">(row_index = 0, column_index=0, shift=nil)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">delete_cell</span><span
+ class="method-args">(row_index = 0, column_index=0, shift=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>by default, only sets cell to nil if :left is specified, method will shift row contents to the right of the deleted cell to the left if :up is specified, method will shift column contents below the deleted cell upward</p>
@@ -1076,14 +1144,16 @@
</div>
<div id="method-i-delete_column" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">delete_column</span><span
- class="method-args">(column_index = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">delete_column</span><span
+ class="method-args">(column_index = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1129,14 +1199,16 @@
</div>
<div id="method-i-delete_row" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">delete_row</span><span
- class="method-args">(row_index=0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">delete_row</span><span
+ class="method-args">(row_index=0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1178,14 +1250,16 @@
</div>
<div id="method-i-get_col_style" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_col_style</span><span
- class="method-args">(column_index)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_col_style</span><span
+ class="method-args">(column_index)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Helper method to get the style index for a column</p>
@@ -1200,14 +1274,16 @@
</div>
<div id="method-i-get_cols_style_index" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_cols_style_index</span><span
- class="method-args">(column_index)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_cols_style_index</span><span
+ class="method-args">(column_index)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1223,14 +1299,16 @@
</div>
<div id="method-i-get_column_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_alignment</span><span
- class="method-args">(col, type)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_alignment</span><span
+ class="method-args">(col, type)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1247,14 +1325,16 @@
</div>
<div id="method-i-get_column_border" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_border</span><span
- class="method-args">(col, border_direction)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_border</span><span
+ class="method-args">(col, border_direction)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1272,14 +1352,16 @@
</div>
<div id="method-i-get_column_border_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_border_color</span><span
- class="method-args">(col, border_direction)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_border_color</span><span
+ class="method-args">(col, border_direction)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1297,14 +1379,16 @@
</div>
<div id="method-i-get_column_fill" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_fill</span><span
- class="method-args">(col=0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_fill</span><span
+ class="method-args">(col=0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1321,14 +1405,16 @@
</div>
<div id="method-i-get_column_font_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_font_color</span><span
- class="method-args">(col = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_font_color</span><span
+ class="method-args">(col = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1343,14 +1429,16 @@
</div>
<div id="method-i-get_column_font_name" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_font_name</span><span
- class="method-args">(col = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_font_name</span><span
+ class="method-args">(col = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1365,14 +1453,16 @@
</div>
<div id="method-i-get_column_font_size" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_font_size</span><span
- class="method-args">(col = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_font_size</span><span
+ class="method-args">(col = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1387,14 +1477,16 @@
</div>
<div id="method-i-get_column_width" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_width</span><span
- class="method-args">(column_index = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_width</span><span
+ class="method-args">(column_index = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Get column width measured in number of digits, as per <a href="http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column%28v=office.14%29.aspx">msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column%28v=office.14%29.aspx</a></p>
@@ -1410,14 +1502,16 @@
</div>
<div id="method-i-get_column_width_raw" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_column_width_raw</span><span
- class="method-args">(column_index = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_column_width_raw</span><span
+ class="method-args">(column_index = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Get raw column width value as stored in the file</p>
@@ -1435,14 +1529,16 @@
</div>
<div id="method-i-get_row_alignment" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_alignment</span><span
- class="method-args">(row, is_horizontal)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_alignment</span><span
+ class="method-args">(row, is_horizontal)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1463,14 +1559,16 @@
</div>
<div id="method-i-get_row_border" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_border</span><span
- class="method-args">(row, border_direction)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_border</span><span
+ class="method-args">(row, border_direction)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1487,14 +1585,16 @@
</div>
<div id="method-i-get_row_border_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_border_color</span><span
- class="method-args">(row, border_direction)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_border_color</span><span
+ class="method-args">(row, border_direction)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1511,14 +1611,16 @@
</div>
<div id="method-i-get_row_fill" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_fill</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_fill</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1532,14 +1634,16 @@
</div>
<div id="method-i-get_row_font_color" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_font_color</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_font_color</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1555,14 +1659,16 @@
</div>
<div id="method-i-get_row_font_name" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_font_name</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_font_name</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1576,14 +1682,16 @@
</div>
<div id="method-i-get_row_font_size" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_font_size</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_font_size</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1597,14 +1705,16 @@
</div>
<div id="method-i-get_row_height" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_height</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_height</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1621,14 +1731,16 @@
</div>
<div id="method-i-get_row_style" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">get_row_style</span><span
- class="method-args">(row_index)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">get_row_style</span><span
+ class="method-args">(row_index)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1643,14 +1755,16 @@
</div>
<div id="method-i-insert_cell" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">insert_cell</span><span
- class="method-args">(row = 0, col = 0, data = nil, formula = nil, shift = nil)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">insert_cell</span><span
+ class="method-args">(row = 0, col = 0, data = nil, formula = nil, shift = nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1686,14 +1800,16 @@
</div>
<div id="method-i-insert_column" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">insert_column</span><span
- class="method-args">(column_index = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">insert_column</span><span
+ class="method-args">(column_index = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Inserts column at <code>column_index</code>, pushes everything right, takes styles from column to left NOTE: use of this method will break formulas which reference cells which are being “pushed right”</p>
@@ -1747,14 +1863,16 @@
</div>
<div id="method-i-insert_row" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">insert_row</span><span
- class="method-args">(row_index = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">insert_row</span><span
+ class="method-args">(row_index = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Inserts row at row_index, pushes down, copies style from the row above (that’s what Excel 2013 does!) NOTE: use of this method will break formulas which reference cells which are being “pushed down”</p>
@@ -1817,14 +1935,16 @@
</div>
<div id="method-i-is_column_bolded" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_column_bolded</span><span
- class="method-args">(col = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_column_bolded</span><span
+ class="method-args">(col = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1839,14 +1959,16 @@
</div>
<div id="method-i-is_column_italicized" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_column_italicized</span><span
- class="method-args">(col = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_column_italicized</span><span
+ class="method-args">(col = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1861,14 +1983,16 @@
</div>
<div id="method-i-is_column_struckthrough" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_column_struckthrough</span><span
- class="method-args">(col = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_column_struckthrough</span><span
+ class="method-args">(col = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1883,14 +2007,16 @@
</div>
<div id="method-i-is_column_underlined" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_column_underlined</span><span
- class="method-args">(col = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_column_underlined</span><span
+ class="method-args">(col = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1905,14 +2031,16 @@
</div>
<div id="method-i-is_row_bolded" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_row_bolded</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_row_bolded</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1926,14 +2054,16 @@
</div>
<div id="method-i-is_row_italicized" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_row_italicized</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_row_italicized</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1947,14 +2077,16 @@
</div>
<div id="method-i-is_row_struckthrough" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_row_struckthrough</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_row_struckthrough</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1968,14 +2100,16 @@
</div>
<div id="method-i-is_row_underlined" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">is_row_underlined</span><span
- class="method-args">(row = 0)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">is_row_underlined</span><span
+ class="method-args">(row = 0)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -1989,14 +2123,16 @@
</div>
<div id="method-i-merge_cells" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">merge_cells</span><span
- class="method-args">(start_row, start_col, end_row, end_col)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">merge_cells</span><span
+ class="method-args">(start_row, start_col, end_row, end_col)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
<p>Merges cells within a rectangular area</p>
@@ -2014,14 +2150,16 @@
</div>
<div id="method-i-row_font" class="method-detail ">
- <div class="method-heading">
- <span class="method-name">row_font</span><span
- class="method-args">(row)</span>
- <span class="method-click-advice">click to toggle source</span>
+ <div class="method-header">
+ <div class="method-heading">
+ <span class="method-name">row_font</span><span
+ class="method-args">(row)</span>
+ <span class="method-click-advice">click to toggle source</span>
+ </div>
</div>
<div class="method-description">
@@ -2042,9 +2180,9 @@
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>