rubyXL-ptr 3.3.27

data/lib/rubyXL/parser.rb

@@ -0,0 +1,29 @@
+module RubyXL
+  class Parser
+
+    # Parse <tt>.xslx</tt> file by reading it from local disk.
+    def self.parse(src_file_path)
+      begin
+        ::Zip::File.open(src_file_path) { |zip_file|
+          root = RubyXL::WorkbookRoot.parse_zip_file(zip_file)
+          root.source_file_path = src_file_path
+          root.workbook
+        }
+      rescue ::Zip::Error => e
+        raise e, "XLSX file format error: #{e}", e.backtrace
+      end
+    end
+
+    # Parse <tt>.xslx</tt> file contained in a stream (useful for receiving over HTTP).
+    def self.parse_buffer(buffer)
+      root = nil # Zip::File.open_buffer somehow fails to return the value from the block :(
+      begin
+        ::Zip::File.open_buffer(buffer) { |zip_file| root = RubyXL::WorkbookRoot.parse_zip_file(zip_file)  } 
+        root.workbook
+      rescue ::Zip::Error => e
+        raise e, "XLSX file format error: #{e}", e.backtrace
+      end
+    end
+
+  end
+end

data/lib/rubyXL/worksheet.rb

@@ -0,0 +1,105 @@
+module RubyXL
+module LegacyWorksheet
+  include Enumerable
+
+  def initialize(params = {})
+    super
+    self.workbook   = params[:workbook]
+    self.sheet_name = params[:sheet_name]
+    self.sheet_id   = params[:sheet_id]
+    self.sheet_data = RubyXL::SheetData.new
+    self.cols = RubyXL::ColumnRanges.new
+    @comments = [] # Do not optimize! These are arrays, so they will share the pointer!
+    @printer_settings = []
+    @generic_storage = []
+  end
+
+  # allows for easier access to sheet_data
+  def [](row = 0)
+    sheet_data[row]
+  end
+
+  def each
+    sheet_data.rows.each { |row| yield(row) }
+  end
+
+  def add_row(row_index = 0, params = {})
+    new_row = RubyXL::Row.new(params)
+    new_row.worksheet = self
+    sheet_data.rows[row_index] = new_row
+  end
+
+  def add_cell(row_index = 0, column_index = 0, data = '', formula = nil, overwrite = true)
+    validate_workbook
+    validate_nonnegative(row_index)
+    validate_nonnegative(column_index)
+    row = sheet_data.rows[row_index] || add_row(row_index)
+
+    c = row.cells[column_index]
+
+    if overwrite || c.nil?
+      c = RubyXL::Cell.new
+      c.worksheet = self
+      c.row = row_index
+      c.column = column_index
+
+      if formula then
+        c.formula = RubyXL::Formula.new(:expression => formula)
+        c.raw_value = data
+      else
+        case data
+        when Numeric          then c.raw_value = data
+        when String           then
+          c.raw_value = data
+          c.datatype = RubyXL::DataType::RAW_STRING
+        when RubyXL::RichText then
+          c.is = data
+          c.datatype = RubyXL::DataType::INLINE_STRING
+        when NilClass         then nil
+        end
+      end
+
+      range = cols && cols.locate_range(column_index)
+      c.style_index = row.style_index || (range && range.style_index) || 0
+      row.cells[column_index] = c
+    end
+
+    c
+  end
+
+  private
+
+  #validates Workbook, ensures that this worksheet is in @workbook
+  def validate_workbook()
+    unless @workbook.nil? || @workbook.worksheets.nil?
+      return if @workbook.worksheets.any? { |sheet| sheet.equal?(self) }
+    end
+
+    raise "This worksheet #{self} is not in workbook #{@workbook}"
+  end
+
+  # Ensures that storage space for a cell with +row_index+ and +column_index+
+  # exists in +sheet_data+ arrays, growing them up if necessary.
+  def ensure_cell_exists(row_index, column_index = 0)
+    validate_nonnegative(row_index)
+    validate_nonnegative(column_index)
+
+    sheet_data.rows[row_index] || add_row(row_index)
+  end
+
+  def get_col_xf(column_index)
+    @workbook.cell_xfs[get_col_style(column_index)]
+  end
+
+  def get_row_xf(row)
+    validate_nonnegative(row)
+    @workbook.cell_xfs[get_row_style(row)]
+  end
+
+  def validate_nonnegative(row_or_col)
+    raise 'Row and Column arguments must be nonnegative' if row_or_col < 0
+  end
+  private :validate_nonnegative
+
+end #end class
+end

data/rdoc/README_rdoc.html

@@ -0,0 +1,475 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>README - rubyXL 3.3.27</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="file">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <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"
+             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"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+<div class="nav-section">
+  <h3>Table of Contents</h3>
+
+  <ul class="link-list" role="directory">
+    <li><a href="#label-rubyXL">rubyXL</a>
+    <li><a href="#label-To+Install-3A">To Install:</a>
+    <li><a href="#label-To+Use-3A">To Use:</a>
+    <li><a href="#label-Parsing+an+existing+workbook">Parsing an existing workbook</a>
+    <li><a href="#label-Creating+a+new+Workbook">Creating a new Workbook</a>
+    <li><a href="#label-Accessing">Accessing</a>
+    <li><a href="#label-Accessing+a+Worksheet">Accessing a Worksheet</a>
+    <li><a href="#label-Accessing+a+Row+-28Array+of+Cells-29">Accessing a Row (Array of Cells)</a>
+    <li><a href="#label-Accessing+a+Cell+object">Accessing a Cell object</a>
+    <li><a href="#label-Wrappers+for+accessing+Cell+properties">Wrappers for accessing Cell properties</a>
+    <li><a href="#label-Wrappers+for+accessing+Row+properties+">Wrappers for accessing Row properties </a>
+    <li><a href="#label-Accessing+column+properties">Accessing column properties</a>
+    <li><a href="#label-Table+reading">Table reading</a>
+    <li><a href="#label-Modifying">Modifying</a>
+    <li><a href="#label-Adding+Worksheets">Adding Worksheets</a>
+    <li><a href="#label-Renaming+Worksheets">Renaming Worksheets</a>
+    <li><a href="#label-Adding+Cells">Adding Cells</a>
+    <li><a href="#label-Changing+Cells">Changing Cells</a>
+    <li><a href="#label-Changing+Fonts">Changing Fonts</a>
+    <li><a href="#label-Changing+Fills+++++">Changing Fills     </a>
+    <li><a href="#label-Changing+Borders">Changing Borders</a>
+    <li><a href="#label-Changing+Alignment">Changing Alignment</a>
+    <li><a href="#label-Horizontal">Horizontal</a>
+    <li><a href="#label-Vertical">Vertical</a>
+    <li><a href="#label-Changing+Row+Height">Changing Row Height</a>
+    <li><a href="#label-Changing+Column+Width">Changing Column Width</a>
+    <li><a href="#label-Merging+Cells">Merging Cells</a>
+    <li><a href="#label-Insert+Row">Insert Row</a>
+    <li><a href="#label-Insert+Column">Insert Column</a>
+    <li><a href="#label-Delete+Row">Delete Row</a>
+    <li><a href="#label-Delete+Column">Delete Column</a>
+    <li><a href="#label-Insert+Cell">Insert Cell</a>
+    <li><a href="#label-Delete+Cell">Delete Cell</a>
+    <li><a href="#label-Modifying+Cell+Format">Modifying Cell Format</a>
+    <li><a href="#label-I-2FO">I/O</a>
+    <li><a href="#label-Miscellaneous">Miscellaneous</a>
+    <li><a href="#label-For+more+information">For more information</a>
+    <li><a href="#label-Contributing+to+rubyXL">Contributing to rubyXL</a>
+    <li><a href="#label-Copyright">Copyright</a>
+  </ul>
+</div>
+
+
+  <div id="project-metadata">
+    <div id="fileindex-section" class="nav-section">
+  <h3>Pages</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./README_rdoc.html">README</a>
+  
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-label="Page README.rdoc">
+
+<h1 id="label-rubyXL">rubyXL<span><a href="#label-rubyXL">&para;</a> <a href="#top">&uarr;</a></span></h1>
+
+<p><a href="http://badge.fury.io/rb/rubyXL"><img
+src="https://badge.fury.io/rb/rubyXL.svg" alt="Gem Version" /></a> <a
+href="https://codeclimate.com/github/weshatheleopard/rubyXL"><img
+src="https://codeclimate.com/github/weshatheleopard/rubyXL.png" alt="Code
+Climate" /></a></p>
+
+<p>This gem supports operating on <code>xlsx</code> files (Open XML format).
+While it is capable of properly parsing the entire OOXML structure, its
+current main emphasis is on reading files produced by MS Excel, making
+minor modifications to them and saving them to be opened again, while
+preserving as much of the structure as possible.</p>
+
+<p>Please note that proprietary binary <code>xls</code> format is
+<strong>not</strong> supported.</p>
+
+<h2 id="label-To+Install-3A">To Install:<span><a href="#label-To+Install-3A">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">rubyXL</span>
+</pre>
+
+<h2 id="label-To+Use-3A">To Use:<span><a href="#label-To+Use-3A">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;rubyXL&#39;</span> <span class="ruby-comment"># Assuming rubygems is already required</span>
+</pre>
+
+<h3 id="label-Parsing+an+existing+workbook">Parsing an existing workbook<span><a href="#label-Parsing+an+existing+workbook">&para;</a> <a href="#top">&uarr;</a></span></h3>
+
+<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">&quot;path/to/Excel/file.xlsx&quot;</span>)
+</pre>
+
+<h3 id="label-Creating+a+new+Workbook">Creating a new Workbook<span><a href="#label-Creating+a+new+Workbook">&para;</a> <a href="#top">&uarr;</a></span></h3>
+
+<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>
+</pre>
+
+<h3 id="label-Accessing">Accessing<span><a href="#label-Accessing">&para;</a> <a href="#top">&uarr;</a></span></h3>
+
+<h4 id="label-Accessing+a+Worksheet">Accessing a Worksheet<span><a href="#label-Accessing+a+Worksheet">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">worksheets</span>[<span class="ruby-value">0</span>] <span class="ruby-comment"># Returns first worksheet</span>
+<span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>]            <span class="ruby-comment"># Returns first worksheet</span>
+<span class="ruby-identifier">workbook</span>[<span class="ruby-string">&#39;Sheet1&#39;</span>]     <span class="ruby-comment"># Finds and returns worksheet titled &quot;Sheet1&quot;</span>
+</pre>
+
+<h4 id="label-Accessing+a+Row+-28Array+of+Cells-29">Accessing a Row (Array of Cells)<span><a href="#label-Accessing+a+Row+-28Array+of+Cells-29">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>Please note that worksheet is a <em>sparse</em> array of rows. Your code
+<strong>must</strong> expect that any row it plucks from the array may be
+<code>nil</code>.</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span> = <span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>]
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>] <span class="ruby-comment"># Returns first row of the worksheet</span>
+<span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>]            <span class="ruby-comment"># Returns first row of the worksheet</span>
+</pre>
+
+<h4 id="label-Accessing+a+Cell+object">Accessing a Cell object<span><a href="#label-Accessing+a+Cell+object">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>Please note that row is a <em>sparse</em> array of cells. Your code
+<strong>must</strong> expect that any cell it plucks from the array may be
+<code>nil</code>.</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span> = <span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>]
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>] <span class="ruby-comment"># Returns cell A1 in the worksheet</span>
+<span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>]            <span class="ruby-comment"># Returns cell A1 in the worksheet</span>
+</pre>
+
+<h4 id="label-Wrappers+for+accessing+Cell+properties">Wrappers for accessing Cell properties<span><a href="#label-Wrappers+for+accessing+Cell+properties">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">cell</span> = <span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>][<span class="ruby-value">0</span>]
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">is_struckthrough</span>  <span class="ruby-comment"># Returns +true+ if the cell is struckthrough, other boolean properties have same syntax</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">font_name</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">font_size</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">font_color</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">fill_color</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">horizontal_alignment</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">vertical_alignment</span>
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">get_border</span>(:<span class="ruby-identifier">top</span>)
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">get_border_color</span>(:<span class="ruby-identifier">top</span>)
+</pre>
+
+<h4 id="label-Wrappers+for+accessing+Row+properties+">Wrappers for accessing Row properties <span><a href="#label-Wrappers+for+accessing+Row+properties+">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>Please note: these methods are being phased out in favor of the OOXML
+object model.</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span> = <span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>]
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_fill</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_font_name</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_font_size</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_font_color</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">is_row_underlined</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_height</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-keyword">true</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-keyword">false</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_border</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">right</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_border_color</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">right</span>)
+</pre>
+
+<h4 id="label-Accessing+column+properties">Accessing column properties<span><a href="#label-Accessing+column+properties">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>Please note: these methods are being phased out in favor of the OOXML
+object model.</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span> = <span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>]
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_fill</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_font_name</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_font_size</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_font_color</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">is_column_underlined</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_width</span>(<span class="ruby-value">0</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_alignment</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">horizontal</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_alignment</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">vertical</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_border</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">right</span>)
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_border_color</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">right</span>)
+</pre>
+
+<h4 id="label-Table+reading">Table reading<span><a href="#label-Table+reading">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>In order to discourage unnecessary reshuffling of data in memory, methods
+<code>extract_data</code> and <code>get_table</code> are being deprecated.
+You should access and iterate through rows and cells directly:</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span>
+   <span class="ruby-identifier">row</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">row</span>.<span class="ruby-identifier">cells</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">cell</span><span class="ruby-operator">|</span>
+     <span class="ruby-identifier">val</span> = <span class="ruby-identifier">cell</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">cell</span>.<span class="ruby-identifier">value</span>
+     <span class="ruby-identifier">do_whatever_you_want</span>(<span class="ruby-identifier">val</span>)
+   }
+}
+</pre>
+
+<h3 id="label-Modifying">Modifying<span><a href="#label-Modifying">&para;</a> <a href="#top">&uarr;</a></span></h3>
+
+<h4 id="label-Adding+Worksheets">Adding Worksheets<span><a href="#label-Adding+Worksheets">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">add_worksheet</span>(<span class="ruby-string">&#39;Sheet2&#39;</span>)
+</pre>
+
+<h4 id="label-Renaming+Worksheets">Renaming Worksheets<span><a href="#label-Renaming+Worksheets">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_name</span> = <span class="ruby-string">&#39;Cool New Name&#39;</span>
+</pre>
+
+<h4 id="label-Adding+Cells">Adding Cells<span><a href="#label-Adding+Cells">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">add_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, <span class="ruby-string">&#39;A1&#39;</span>)      <span class="ruby-comment"># Sets cell A1 to string &quot;A1&quot;</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">add_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">1</span>, <span class="ruby-string">&#39;&#39;</span>, <span class="ruby-string">&#39;A1&#39;</span>)  <span class="ruby-comment"># Sets formula in the cell B1 to &#39;=A1&#39;</span>
+</pre>
+
+<h4 id="label-Changing+Cells">Changing Cells<span><a href="#label-Changing+Cells">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_contents</span>(<span class="ruby-string">&quot;&quot;</span>, <span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">formula</span>) <span class="ruby-comment"># Sets value of cell A1 to empty string, preserves formula</span>
+</pre>
+
+<h4 id="label-Changing+Fonts">Changing Fonts<span><a href="#label-Changing+Fonts">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_font_bold</span>(<span class="ruby-keyword">true</span>) <span class="ruby-comment"># Makes A1 bold</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_italics</span>(<span class="ruby-value">0</span>,<span class="ruby-keyword">true</span>)              <span class="ruby-comment"># Makes first row italicized</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_font_name</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;Courier&#39;</span>)   <span class="ruby-comment"># Makes first column have font Courier</span>
+</pre>
+
+<h4 id="label-Changing+Fills+++++">Changing Fills     <span><a href="#label-Changing+Fills+++++">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_fill</span>(<span class="ruby-string">&#39;0ba53d&#39;</span>)  <span class="ruby-comment"># Sets A1 to have fill #0ba53d</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_fill</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;0ba53d&#39;</span>)            <span class="ruby-comment"># Sets first row to have fill #0ba53d</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_fill</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;0ba53d&#39;</span>)         <span class="ruby-comment"># Sets first column to have fill #0ba53d</span>
+</pre>
+
+<h4 id="label-Changing+Borders">Changing Borders<span><a href="#label-Changing+Borders">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-comment"># Possible weights: hairline, thin, medium, thick</span>
+<span class="ruby-comment"># Possible &quot;directions&quot;: top, bottom, left, right, diagonal</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_border</span>(:<span class="ruby-identifier">top</span>, <span class="ruby-string">&#39;thin&#39;</span>)  <span class="ruby-comment"># Sets A1 to have a top, thin border</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_border</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">left</span>, <span class="ruby-string">&#39;hairline&#39;</span>)       <span class="ruby-comment"># Sets first row to have a left, hairline border</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_border</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">diagonal</span>, <span class="ruby-string">&#39;medium&#39;</span>)  <span class="ruby-comment"># Sets first column to have diagonal, medium border</span>
+
+<span class="ruby-comment"># Set the border style first so there&#39;s something to color.</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_border_color</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">top</span>, <span class="ruby-string">&#39;0ba53d&#39;</span>)    <span class="ruby-comment"># Sets first row to have a green top border</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_border_color</span>(<span class="ruby-value">0</span>, :<span class="ruby-identifier">top</span>, <span class="ruby-string">&#39;0ba53d&#39;</span>) <span class="ruby-comment"># Sets first column to have a green top border</span>
+</pre>
+
+<h4 id="label-Changing+Alignment">Changing Alignment<span><a href="#label-Changing+Alignment">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<h5 id="label-Horizontal">Horizontal<span><a href="#label-Horizontal">&para;</a> <a href="#top">&uarr;</a></span></h5>
+
+<p>center, distributed, justify, left, right</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_horizontal_alignment</span>(<span class="ruby-string">&#39;center&#39;</span>) <span class="ruby-comment"># Sets A1 to be centered</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_horizontal_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;justify&#39;</span>)          <span class="ruby-comment"># Sets first row to be justified</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_horizontal_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;right&#39;</span>)         <span class="ruby-comment"># Sets first column to be right-aligned</span>
+</pre>
+
+<h5 id="label-Vertical">Vertical<span><a href="#label-Vertical">&para;</a> <a href="#top">&uarr;</a></span></h5>
+
+<p>bottom, center, distributed, top</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_vertical_alignment</span>(<span class="ruby-string">&#39;bottom&#39;</span>)  <span class="ruby-comment"># Sets A1 to be bottom aligned</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_vertical_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;distributed&#39;</span>)       <span class="ruby-comment"># Sets first row to be distributed vertically</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_vertical_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-string">&#39;top&#39;</span>)            <span class="ruby-comment"># Sets first column to be top aligned</span>
+</pre>
+
+<h4 id="label-Changing+Row+Height">Changing Row Height<span><a href="#label-Changing+Row+Height">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_height</span>(<span class="ruby-value">0</span>, <span class="ruby-value">30</span>)  <span class="ruby-comment"># Sets first row height to 30</span>
+</pre>
+
+<h4 id="label-Changing+Column+Width">Changing Column Width<span><a href="#label-Changing+Column+Width">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_width</span>(<span class="ruby-value">0</span>, <span class="ruby-value">30</span>)  <span class="ruby-comment"># Sets first column width to 30</span>
+</pre>
+
+<h4 id="label-Merging+Cells">Merging Cells<span><a href="#label-Merging+Cells">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">merge_cells</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, <span class="ruby-value">1</span>, <span class="ruby-value">1</span>)  <span class="ruby-comment"># Merges A1:B2</span>
+</pre>
+
+<h4 id="label-Insert+Row">Insert Row<span><a href="#label-Insert+Row">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>This method will insert a row at specified index, pushing all rows below it
+down. It also copies styles from row above.</p>
+
+<p>WARNING: Use of this method WILL break formulas referencing cells which
+have been moved, as the formulas do not adapt to the shifted rows</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_row</span>(<span class="ruby-value">1</span>)
+</pre>
+
+<h4 id="label-Insert+Column">Insert Column<span><a href="#label-Insert+Column">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>This method will insert a column at specified index, pushing all columns to
+the right of it one to the right. It also copies styles from column to the
+left</p>
+
+<p>WARNING: Use of this method WILL break formulas referencing cells which
+have been moved, as the formulas do not adapt to the shifted columns</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_column</span>(<span class="ruby-value">1</span>)
+</pre>
+
+<h4 id="label-Delete+Row">Delete Row<span><a href="#label-Delete+Row">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>This method will delete a row at specified index, pushing all rows below it
+up.</p>
+
+<p>WARNING: Use of this method WILL break formulas referencing cells which
+have been moved, as the formulas do not adapt to the shifted rows</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_row</span>(<span class="ruby-value">1</span>)
+</pre>
+
+<h4 id="label-Delete+Column">Delete Column<span><a href="#label-Delete+Column">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>This method will delete a column at specified index, pushing all columns to
+the right of it left.</p>
+
+<p>WARNING: Use of this method WILL break formulas referencing cells which
+have been moved, as the formulas do not adapt to the shifted columns</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_column</span>(<span class="ruby-value">1</span>)
+</pre>
+
+<h4 id="label-Insert+Cell">Insert Cell<span><a href="#label-Insert+Cell">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>This method will insert a cell at specified position. It takes a :right or
+:down option, to shift cells either left or down upon inserting (nil means
+replacing the cell)</p>
+
+<p>WARNING: Use of this method WILL break formulas referencing cells which
+have been moved, as the formulas do not adapt to the shifted cells</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, <span class="ruby-string">&quot;blah&quot;</span>, <span class="ruby-identifier">formula</span> = <span class="ruby-keyword">nil</span>, :<span class="ruby-identifier">right</span>)  <span class="ruby-comment"># Inserts cell at A1, shifts cells in first row right</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, <span class="ruby-string">&quot;blah&quot;</span>, <span class="ruby-identifier">formula</span> = <span class="ruby-keyword">nil</span>, :<span class="ruby-identifier">down</span>)   <span class="ruby-comment"># Inserts cell at A1, shifts cells in first column down</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, <span class="ruby-string">&quot;blah&quot;</span>)                         <span class="ruby-comment"># Inserts cell at A1, shifts nothing</span>
+</pre>
+
+<h4 id="label-Delete+Cell">Delete Cell<span><a href="#label-Delete+Cell">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<p>This method will delete a cell at specified position. It takes a :left or
+:up option, to shift cells either up or left upon deletion (nil means
+simply deleting the cell contents)</p>
+
+<p>WARNING: Use of this method WILL break formulas referencing cells which
+have been moved, as the formulas do not adapt to the shifted cells</p>
+
+<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, :<span class="ruby-identifier">left</span>)  <span class="ruby-comment"># Deletes A1, shifts contents of first row left</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, :<span class="ruby-identifier">up</span>)    <span class="ruby-comment"># Deletes A1, shifts contents of first column up</span>
+<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>)         <span class="ruby-comment"># Deletes A1, does not shift cells</span>
+</pre>
+
+<h4 id="label-Modifying+Cell+Format">Modifying Cell Format<span><a href="#label-Modifying+Cell+Format">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">cell</span> = <span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>]
+<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">set_number_format</span> <span class="ruby-string">&#39;0.0000%&#39;</span>    <span class="ruby-comment"># For formats, see https://support.office.com/en-us/article/5026bbd6-04bc-48cd-bf33-80f18b4eae68</span>
+</pre>
+
+<h2 id="label-I-2FO">I/O<span><a href="#label-I-2FO">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>By default, the gem operates with files on the local filesystem:</p>
+
+<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">&quot;path/to/Excel/file.xlsx&quot;</span>)
+<span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">write</span>(<span class="ruby-string">&quot;path/to/desired/Excel/file.xlsx&quot;</span>)
+</pre>
+
+<p>It can also operate on <code>StringIO</code> objects, thus eliminating the
+need to save the <code>xlsx</code> file to disk. This capability comes in
+handy for web servers.</p>
+
+<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse_buffer</span>(<span class="ruby-identifier">buffer</span>)
+<span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">stream</span>
+</pre>
+
+<h2 id="label-Miscellaneous">Miscellaneous<span><a href="#label-Miscellaneous">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<pre class="ruby"><span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Reference</span>.<span class="ruby-identifier">ind2ref</span>(<span class="ruby-value">0</span>,<span class="ruby-value">0</span>) <span class="ruby-operator">==</span> <span class="ruby-string">&#39;A1&#39;</span>    <span class="ruby-comment"># Converts row and column index to Excel-style cell reference</span>
+<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Reference</span>.<span class="ruby-identifier">ref2ind</span>(<span class="ruby-string">&#39;A1&#39;</span>) <span class="ruby-operator">==</span> [<span class="ruby-value">0</span>, <span class="ruby-value">0</span>] <span class="ruby-comment"># Converts Excel-style cell reference to row and column index</span>
+</pre>
+
+<h2 id="label-For+more+information">For more information<span><a href="#label-For+more+information">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Take a look at the files in spec/lib/ for rspecs on most methods</p>
+
+<h2 id="label-Contributing+to+rubyXL">Contributing to rubyXL<span><a href="#label-Contributing+to+rubyXL">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<ul><li>
+<p>Check out the latest master to make sure the feature hasn&#39;t been
+implemented or the bug hasn&#39;t been fixed yet</p>
+</li><li>
+<p>Check out the issue tracker to make sure someone already hasn&#39;t
+requested it and/or contributed it</p>
+</li><li>
+<p>Fork the project</p>
+</li><li>
+<p>Start a feature/bugfix branch</p>
+</li><li>
+<p>Commit and push until you are happy with your contribution</p>
+</li><li>
+<p>Make sure to add tests for it. This is important so I don&#39;t break it in
+a future version unintentionally.</p>
+</li><li>
+<p>Please try not to mess with the Rakefile, version, or history. If you want
+to have your own version, or is otherwise necessary, that is fine, but
+please isolate to its own commit so I can cherry-pick around it.</p>
+</li></ul>
+
+<h2 id="label-Copyright">Copyright<span><a href="#label-Copyright">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Copyright © 2011 Vivek Bhagwat, 2013-2016 Wesha. See LICENSE.txt for
+further details.</p>
+</main>
+
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+