module RubyXL::LegacyWorksheet
Constants
- BOLD
- COLOR
- ITALICS
- NAME
- SIZE
- STRIKETHROUGH
- UNDERLINE
Attributes
Public Class Methods
# File lib/rubyXL/worksheet.rb, line 7 def initialize(params = {}) super @workbook = params[:workbook] @sheet_name = params[:sheet_name] @sheet_id = params[:sheet_id] self.sheet_data = RubyXL::SheetData.new self.cols = RubyXL::ColumnRanges.new @extLst = nil @validations = [] end
Public Instance Methods
allows for easier access to sheet_data
# File lib/rubyXL/worksheet.rb, line 19 def [](row = 0) sheet_data[row] end
# File lib/rubyXL/worksheet.rb, line 329 def add_cell(row = 0, column = 0, data = '', formula = nil, overwrite = true) validate_workbook ensure_cell_exists(row, column) if overwrite || sheet_data.rows[row].cells[column].nil? c = RubyXL::Cell.new c.worksheet = self c.row = row c.column = column c.raw_value = data c.datatype = (formula || data.is_a?(Numeric)) ? '' : RubyXL::Cell::RAW_STRING c.formula = formula range = cols && cols.find(column) c.style_index = sheet_data.rows[row].s || (range && range.style_index) || 0 sheet_data.rows[row].cells[column] = c end add_cell_style(row, column) sheet_data.rows[row].cells[column] end
# File lib/rubyXL/worksheet.rb, line 323 def add_row(row = 0, params = {}) new_row = RubyXL::Row.new(params) new_row.worksheet = self sheet_data.rows[row] = new_row end
# File lib/rubyXL/worksheet.rb, line 244 def change_column_bold(col = 0, bolded = false) xf = get_col_xf(col) font = @workbook.fonts[xf.font_id].dup font.set_bold(bolded) change_column_font(col, Worksheet::BOLD, bolded, font, xf) end
# File lib/rubyXL/worksheet.rb, line 307 def change_column_border_bottom(col=0,weight = 'thin') change_column_border(col, :bottom, weight) end
# File lib/rubyXL/worksheet.rb, line 311 def change_column_border_diagonal(col=0,weight = 'thin') change_column_border(col, :diagonal, weight) end
# File lib/rubyXL/worksheet.rb, line 299 def change_column_border_left(col=0,weight = 'thin') change_column_border(col, :left, weight) end
# File lib/rubyXL/worksheet.rb, line 303 def change_column_border_right(col=0,weight = 'thin') change_column_border(col, :right, weight) end
# File lib/rubyXL/worksheet.rb, line 295 def change_column_border_top(col=0,weight = 'thin') change_column_border(col, :top, weight) end
# File lib/rubyXL/worksheet.rb, line 274 def change_column_fill(column_index = 0, color_index='ffffff') validate_workbook Color.validate_color(color_index) ensure_cell_exists(0, column_index) cols.get_range(column_index).style = @workbook.modify_fill(get_col_style(column_index), color_index) sheet_data.rows.each { |row| c = row[column_index] c.change_fill(color_index) if c } end
Changes font color of column
# File lib/rubyXL/worksheet.rb, line 228 def change_column_font_color(col=0, font_color='000000') Color.validate_color(font_color) xf = get_col_xf(col) font = @workbook.fonts[xf.font_id].dup font.set_rgb_color(font_color) change_column_font(col, Worksheet::COLOR, font_color, font, xf) end
Changes font name of column
# File lib/rubyXL/worksheet.rb, line 212 def change_column_font_name(col = 0, font_name = 'Verdana') xf = get_col_xf(col) font = @workbook.fonts[xf.font_id].dup font.set_name(font_name) change_column_font(col, Worksheet::NAME, font_name, font, xf) end
Changes font size of column
# File lib/rubyXL/worksheet.rb, line 220 def change_column_font_size(col=0, font_size=10) xf = get_col_xf(col) font = @workbook.fonts[xf.font_id].dup font.set_size(font_size) change_column_font(col, Worksheet::SIZE, font_size, font, xf) end
# File lib/rubyXL/worksheet.rb, line 287 def change_column_horizontal_alignment(col=0,alignment='center') change_column_alignment(col,alignment,true) end
# File lib/rubyXL/worksheet.rb, line 237 def change_column_italics(col = 0, italicized = false) xf = get_col_xf(col) font = @workbook.fonts[xf.font_id].dup font.set_italic(italicized) change_column_font(col, Worksheet::ITALICS, italicized, font, xf) end
# File lib/rubyXL/worksheet.rb, line 258 def change_column_strikethrough(col=0, struckthrough=false) xf = get_col_xf(col) font = @workbook.fonts[xf.font_id].dup font.set_strikethrough(struckthrough) change_column_font(col, Worksheet::STRIKETHROUGH, struckthrough, font, xf) end
# File lib/rubyXL/worksheet.rb, line 251 def change_column_underline(col = 0, underlined = false) xf = get_col_xf(col) font = @workbook.fonts[xf.font_id].dup font.set_underline(underlined) change_column_font(col, Worksheet::UNDERLINE, underlined, font, xf) end
# File lib/rubyXL/worksheet.rb, line 291 def change_column_vertical_alignment(col=0,alignment='center') change_column_alignment(col, alignment, false) end
# File lib/rubyXL/worksheet.rb, line 265 def change_column_width(column_index = 0, width = 13) validate_workbook ensure_cell_exists(0, column_index) range = cols.get_range(column_index) range.width = width range.custom_width = true end
# File lib/rubyXL/worksheet.rb, line 142 def change_row_bold(row = 0, bolded=false) ensure_cell_exists(row) font = row_font(row).dup font.set_bold(bolded) change_row_font(row, Worksheet::BOLD, bolded, font) end
# File lib/rubyXL/worksheet.rb, line 203 def change_row_border_bottom(row = 0, weight = 'thin') change_row_border(row, :bottom, weight) end
# File lib/rubyXL/worksheet.rb, line 207 def change_row_border_diagonal(row = 0, weight = 'thin') change_row_border(row, :diagonal, weight) end
# File lib/rubyXL/worksheet.rb, line 195 def change_row_border_left(row = 0, weight = 'thin') change_row_border(row, :left, weight) end
# File lib/rubyXL/worksheet.rb, line 199 def change_row_border_right(row = 0, weight = 'thin') change_row_border(row, :right, weight) end
# File lib/rubyXL/worksheet.rb, line 191 def change_row_border_top(row = 0, weight = 'thin') change_row_border(row, :top, weight) end
changes color of fill in (zer0 indexed) row
# File lib/rubyXL/worksheet.rb, line 104 def change_row_fill(row_index = 0, rgb = 'ffffff') validate_workbook ensure_cell_exists(row_index) Color.validate_color(rgb) sheet_data.rows[row_index].s = @workbook.modify_fill(get_row_style(row_index), rgb) sheet_data[row_index].cells.each { |c| c.change_fill(rgb) unless c.nil? } end
# File lib/rubyXL/worksheet.rb, line 127 def change_row_font_color(row = 0, font_color='000000') ensure_cell_exists(row) Color.validate_color(font_color) font = row_font(row).dup font.set_rgb_color(font_color) change_row_font(row, Worksheet::COLOR, font_color, font) end
# File lib/rubyXL/worksheet.rb, line 113 def change_row_font_name(row = 0, font_name = 'Verdana') ensure_cell_exists(row) font = row_font(row).dup font.set_name(font_name) change_row_font(row, Worksheet::NAME, font_name, font) end
# File lib/rubyXL/worksheet.rb, line 120 def change_row_font_size(row = 0, font_size=10) ensure_cell_exists(row) font = row_font(row).dup font.set_size(font_size) change_row_font(row, Worksheet::SIZE, font_size, font) end
# File lib/rubyXL/worksheet.rb, line 163 def change_row_height(row = 0, height=10) validate_workbook ensure_cell_exists(row) if height.to_i.to_s == height.to_s height = Integer(height) elsif height.to_f.to_s == height.to_s height = Float(height) else raise 'You must enter a number for the height' end sheet_data.rows[row].ht = height sheet_data.rows[row].custom_height = true end
# File lib/rubyXL/worksheet.rb, line 179 def change_row_horizontal_alignment(row = 0,alignment='center') validate_workbook validate_nonnegative(row) change_row_alignment(row,alignment,true) end
# File lib/rubyXL/worksheet.rb, line 135 def change_row_italics(row = 0, italicized=false) ensure_cell_exists(row) font = row_font(row).dup font.set_italic(italicized) change_row_font(row, Worksheet::ITALICS, italicized, font) end
# File lib/rubyXL/worksheet.rb, line 156 def change_row_strikethrough(row = 0, struckthrough=false) ensure_cell_exists(row) font = row_font(row).dup font.set_strikethrough(struckthrough) change_row_font(row, Worksheet::STRIKETHROUGH, struckthrough, font) end
# File lib/rubyXL/worksheet.rb, line 149 def change_row_underline(row = 0, underlined=false) ensure_cell_exists(row) font = row_font(row).dup font.set_underline(underlined) change_row_font(row, Worksheet::UNDERLINE, underlined, font) end
# File lib/rubyXL/worksheet.rb, line 185 def change_row_vertical_alignment(row = 0,alignment='center') validate_workbook validate_nonnegative(row) change_row_alignment(row,alignment,false) end
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
# File lib/rubyXL/worksheet.rb, line 472 def delete_cell(row = 0, col=0, shift=nil) validate_workbook validate_nonnegative(row) validate_nonnegative(col) return nil unless row_exists(row) && column_exists(col) cell = sheet_data[row][col] case shift when nil then sheet_data.rows[row].cells[col] = nil when :left then sheet_data.rows[row].delete_cell_shift_left(col) when :up then (row...(sheet_data.size - 1)).each { |index| c = sheet_data.rows[index].cells[col] = sheet_data.rows[index + 1].cells[col] c.row -= 1 if c.is_a?(Cell) } else raise 'invalid shift option' end return cell end
# File lib/rubyXL/worksheet.rb, line 398 def delete_column(column_index = 0) validate_workbook validate_nonnegative(column_index) return nil unless column_exists(column_index) #delete column sheet_data.rows.each { |row| row.cells.delete_at(column_index) } #change column numbers for cells to right of deleted column sheet_data.rows.each_with_index { |row, row_index| row.cells.each_with_index { |c, column_index| c.column -= 1 if c.is_a?(Cell) } } cols.column_ranges.each { |range| range.delete_column(column_index) } end
# File lib/rubyXL/worksheet.rb, line 353 def delete_row(row_index=0) validate_workbook validate_nonnegative(row_index) return nil unless row_exists(row_index) deleted = sheet_data.rows.delete_at(row_index) row_num = row_index+1 # Change cell row numbers row_index.upto(sheet_data.size - 1) { |index| sheet_data[index].cells.each{ |c| c.row -= 1 unless c.nil? } } return deleted end
# File lib/rubyXL/worksheet.rb, line 23 def each sheet_data.rows.each { |row| yield(row) } end
returns 2d array of just the cell values (without style or formula information)
# File lib/rubyXL/worksheet.rb, line 28 def extract_data(args = {}) sheet_data.rows.map { |row| row && row.cells.map { |c| c && c.value(args) } } end
# File lib/rubyXL/worksheet.rb, line 640 def get_column_border_bottom(col=0) get_column_border(col, :bottom) end
# File lib/rubyXL/worksheet.rb, line 644 def get_column_border_diagonal(col=0) get_column_border(col, :diagonal) end
# File lib/rubyXL/worksheet.rb, line 632 def get_column_border_left(col=0) get_column_border(col, :left) end
# File lib/rubyXL/worksheet.rb, line 636 def get_column_border_right(col=0) get_column_border(col, :right) end
# File lib/rubyXL/worksheet.rb, line 628 def get_column_border_top(col=0) get_column_border(col, :top) end
# File lib/rubyXL/worksheet.rb, line 612 def get_column_fill(col=0) validate_workbook validate_nonnegative(col) return nil unless column_exists(col) @workbook.get_fill_color(get_col_xf(col)) end
# File lib/rubyXL/worksheet.rb, line 578 def get_column_font_color(col = 0) font = column_font(col) font && (font.get_rgb_color || '000000') end
# File lib/rubyXL/worksheet.rb, line 568 def get_column_font_name(col = 0) font = column_font(col) font && font.get_name end
# File lib/rubyXL/worksheet.rb, line 573 def get_column_font_size(col = 0) font = column_font(col) font && font.get_size end
# File lib/rubyXL/worksheet.rb, line 620 def get_column_horizontal_alignment(col=0) get_column_alignment(col, :horizontal) end
# File lib/rubyXL/worksheet.rb, line 624 def get_column_vertical_alignment(col=0) get_column_alignment(col, :vertical) end
# File lib/rubyXL/worksheet.rb, line 603 def get_column_width(column_index = 0) validate_workbook validate_nonnegative(column_index) return nil unless column_exists(column_index) range = cols.find(column_index) (range && range.width) || 10 end
# File lib/rubyXL/worksheet.rb, line 560 def get_row_border_bottom(row = 0) return get_row_border(row, :bottom) end
# File lib/rubyXL/worksheet.rb, line 564 def get_row_border_diagonal(row = 0) return get_row_border(row, :diagonal) end
# File lib/rubyXL/worksheet.rb, line 552 def get_row_border_left(row = 0) return get_row_border(row, :left) end
# File lib/rubyXL/worksheet.rb, line 556 def get_row_border_right(row = 0) return get_row_border(row, :right) end
# File lib/rubyXL/worksheet.rb, line 548 def get_row_border_top(row = 0) return get_row_border(row, :top) end
# File lib/rubyXL/worksheet.rb, line 498 def get_row_fill(row = 0) (row = sheet_data.rows[row]) && row.get_fill_color end
# File lib/rubyXL/worksheet.rb, line 510 def get_row_font_color(row = 0) font = row_font(row) color = font && font.color color && (color.rgb || '000000') end
# File lib/rubyXL/worksheet.rb, line 502 def get_row_font_name(row = 0) (font = row_font(row)) && font.get_name end
# File lib/rubyXL/worksheet.rb, line 506 def get_row_font_size(row = 0) (font = row_font(row)) && font.get_size end
# File lib/rubyXL/worksheet.rb, line 532 def get_row_height(row = 0) validate_workbook validate_nonnegative(row) return nil unless row_exists(row) row = sheet_data.rows[row] row && row.ht || 13 end
# File lib/rubyXL/worksheet.rb, line 540 def get_row_horizontal_alignment(row = 0) return get_row_alignment(row, true) end
# File lib/rubyXL/worksheet.rb, line 544 def get_row_vertical_alignment(row = 0) return get_row_alignment(row, false) end
# File lib/rubyXL/worksheet.rb, line 34 def get_table(headers = [], opts = {}) validate_workbook headers = [headers] unless headers.is_a?(Array) row_num = find_first_row_with_content(headers) return nil if row_num.nil? table_hash = {} table_hash[:table] = [] header_row = sheet_data[row_num] header_row.cells.each_with_index { |header_cell, index| break if index>0 && !opts[:last_header].nil? && !header_row[index-1].nil? && !header_row[index-1].value.nil? && header_row[index-1].value.to_s==opts[:last_header] next if header_cell.nil? || header_cell.value.nil? header = header_cell.value.to_s table_hash[:sorted_headers]||=[] table_hash[:sorted_headers] << header table_hash[header] = [] original_row = row_num + 1 current_row = original_row row = sheet_data.rows[current_row] cell = row && row.cells[index] # makes array of hashes in table_hash[:table] # as well as hash of arrays in table_hash[header] table_index = current_row - original_row cell_test = (!cell.nil? && !cell.value.nil?) while cell_test || (table_hash[:table][table_index] && !table_hash[:table][table_index].empty?) table_hash[header] << cell.value if cell_test table_index = current_row - original_row if cell_test then table_hash[:table][table_index] ||= {} table_hash[:table][table_index][header] = cell.value end current_row += 1 if sheet_data.rows[current_row].nil? then cell = nil else cell = sheet_data.rows[current_row].cells[index] end cell_test = (!cell.nil? && !cell.value.nil?) end } return table_hash end
# File lib/rubyXL/worksheet.rb, line 449 def insert_cell(row = 0, col = 0, data = nil, formula = nil, shift = nil) validate_workbook ensure_cell_exists(row, col) case shift when nil then # No shifting at all when :right then sheet_data.rows[row].insert_cell_shift_right(nil, col) when :down then add_row(sheet_data.size, :cells => Array.new(sheet_data.rows[row].size)) (sheet_data.size - 1).downto(row+1) { |index| sheet_data.rows[index].cells[col] = sheet_data.rows[index-1].cells[col] } else raise 'invalid shift option' end return add_cell(row,col,data,formula) end
inserts column at column_index
, pushes everything right, takes
styles from column to left USE OF THIS METHOD will break formulas which
reference cells which are being “pushed down”
# File lib/rubyXL/worksheet.rb, line 419 def insert_column(column_index = 0) validate_workbook ensure_cell_exists(0, column_index) old_range = cols.get_range(column_index) #go through each cell in column sheet_data.rows.each_with_index { |row, row_index| old_cell = row[column_index] c = nil if old_cell && old_cell.style_index != 0 && old_range && old_range.style != old_cell.style_index then c = Cell.new c.worksheet = self c.row = row_index c.column = column_index c.datatype = RubyXL::Cell::SHARED_STRING c.style_index = old_cell.style_index end row.insert_cell_shift_right(c, column_index) } cols.insert_column(column_index) # TODO: update column numbers end
Inserts row at row_index, pushes down, copies style from the row above (that's what Excel 2013 does!)
USE OF THIS METHOD will break formulas which reference cells which are being “pushed down”
# File lib/rubyXL/worksheet.rb, line 371 def insert_row(row_index = 0) validate_workbook ensure_cell_exists(row_index) if row_index == 0 then old_row = nil new_cells = Array.new(sheet_data.rows[0].cells.size) else old_row = sheet_data.rows[row_index - 1] new_cells = old_row.cells.collect { |c| if c.nil? then nil else RubyXL::Cell.new(:style_index => c.style_index) end } end sheet_data.rows.insert(row_index, nil) new_row = add_row(row_index, :cells => new_cells, :s => old_row && old_row.s) #update row value for all rows below row_index.upto(sheet_data.rows.size - 1) { |i| row = sheet_data.rows[i] row.cells.each { |c| c.row = i unless c.nil? } } return new_row end
# File lib/rubyXL/worksheet.rb, line 588 def is_column_bolded(col = 0) font = column_font(col) font && font.is_bold end
# File lib/rubyXL/worksheet.rb, line 583 def is_column_italicized(col = 0) font = column_font(col) font && font.is_italic end
# File lib/rubyXL/worksheet.rb, line 598 def is_column_struckthrough(col = 0) font = column_font(col) font && font.is_strikethrough end
# File lib/rubyXL/worksheet.rb, line 593 def is_column_underlined(col = 0) font = column_font(col) font && font.is_underlined end
# File lib/rubyXL/worksheet.rb, line 520 def is_row_bolded(row = 0) (font = row_font(row)) && font.is_bold end
# File lib/rubyXL/worksheet.rb, line 516 def is_row_italicized(row = 0) (font = row_font(row)) && font.is_italic end
# File lib/rubyXL/worksheet.rb, line 528 def is_row_struckthrough(row = 0) (font = row_font(row)) && font.is_strikethrough end
# File lib/rubyXL/worksheet.rb, line 524 def is_row_underlined(row = 0) (font = row_font(row)) && font.is_underlined end
merges cells within a rectangular range
# File lib/rubyXL/worksheet.rb, line 316 def merge_cells(row1 = 0, col1 = 0, row2 = 0, col2 = 0) validate_workbook self.merged_cells ||= RubyXL::MergedCells.new merged_cells << RubyXL::MergedCell.new(:ref => RubyXL::Reference.new(row1, row2, col1, col2)) end