Class: RubyXL::Worksheet

Inherits:
PrivateClass show all
Includes:
Enumerable
Defined in:
lib/rubyXL/worksheet.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(workbook, sheet_name = 'Sheet1', sheet_data = [[nil]], cols = [], merged_cells = []) ⇒ Worksheet

Returns a new instance of Worksheet.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rubyXL/worksheet.rb', line 8

def initialize(workbook, sheet_name='Sheet1',sheet_data=[[nil]],cols=[], merged_cells=[])
  @workbook = workbook

  @sheet_name = sheet_name
  @sheet_data = sheet_data
  @cols = cols
  @merged_cells = merged_cells
  @row_styles={}
  @sheet_view = {
                  :attributes => {
                                    :workbookViewId => 0, :zoomScale => 100, :tabSelected => 1, :view=>'normalLayout', :zoomScaleNormal => 100
                                 }
                }
  @extLst = nil
  @legacy_drawing=nil
end

Instance Attribute Details

#cols ⇒ Object

Returns the value of attribute cols.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def cols
  @cols
end

#extLst ⇒ Object

Returns the value of attribute extLst.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def extLst
  @extLst
end

#legacy_drawing ⇒ Object

Returns the value of attribute legacy_drawing.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def legacy_drawing
  @legacy_drawing
end

#merged_cells ⇒ Object

Returns the value of attribute merged_cells.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def merged_cells
  @merged_cells
end

#pane ⇒ Object

Returns the value of attribute pane.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def pane
  @pane
end

#row_styles ⇒ Object

Returns the value of attribute row_styles.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def row_styles
  @row_styles
end

#sheet_data ⇒ Object

Returns the value of attribute sheet_data.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def sheet_data
  @sheet_data
end

#sheet_name ⇒ Object

Returns the value of attribute sheet_name.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def sheet_name
  @sheet_name
end

#sheet_view ⇒ Object

Returns the value of attribute sheet_view.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def sheet_view
  @sheet_view
end

#validations ⇒ Object

Returns the value of attribute validations.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def validations
  @validations
end

#workbook ⇒ Object

Returns the value of attribute workbook.



5
6
7
 
# File 'lib/rubyXL/worksheet.rb', line 5

def workbook
  @workbook
end

Instance Method Details

#[](row = 0) ⇒ Object

allows for easier access to sheet_data



26
27
28
 
# File 'lib/rubyXL/worksheet.rb', line 26

def [](row=0)
  return @sheet_data[row]
end

#add_cell(row = 0, column = 0, data = '', formula = nil, overwrite = true) ⇒ Object 



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/rubyXL/worksheet.rb', line 427

def add_cell(row=0, column=0, data='', formula=nil,overwrite=true)
  validate_workbook
  validate_nonnegative(row)
  validate_nonnegative(column)

  unless @sheet_data.size > row && @sheet_data[row].size > column
    increase_columns(column)
    increase_rows(row)
  end

  datatype = 'str'
  unless formula.nil?
    datatype = ''
  end
  if overwrite || @sheet_data[row][column].nil?
    @sheet_data[row][column] = Cell.new(self,row,column,data,formula,datatype)

    if (data.is_a?Integer) || (data.is_a?Float)
      @sheet_data[row][column].datatype = ''
    end
    col = @cols[get_cols_index(column)]

    if @row_styles[(row+1).to_s] != nil
      @sheet_data[row][column].style_index = @row_styles[(row+1).to_s][:style]
    elsif col != nil
      @sheet_data[row][column].style_index = col[:attributes][:style]
    end
  end

  add_cell_style(row,column)

  return @sheet_data[row][column]
end

#add_cell_obj(cell, overwrite = true) ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/rubyXL/worksheet.rb', line 461

def add_cell_obj(cell, overwrite=true)
  validate_workbook

  if cell.nil?
    return cell
  end

  row = cell.row
  column = cell.column

  validate_nonnegative(row)
  validate_nonnegative(column)

  unless @sheet_data.size > row && @sheet_data[row].size > column
    increase_columns(column)
    increase_rows(row)
  end
  if overwrite || @sheet_data[row][column].nil?
    @sheet_data[row][column] = cell
  end

  add_cell_style(row,column)

  return @sheet_data[row][column]
end

#change_column_bold(col = 0, bolded = false) ⇒ Object

Changes font bold settings of column



299
300
301
302
303
304
305
306
307
 
# File 'lib/rubyXL/worksheet.rb', line 299

def change_column_bold(col=0, bolded=false)
  # Get style object
  xf_id = xf_id(get_col_style(col))
  # Get copy of font object with modified bold settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_bold(font, bolded)
  # Update font and xf array
  change_column_font(col, Worksheet::BOLD, bolded, font, xf_id)
end

#change_column_border_bottom(col = 0, weight = 'thin') ⇒ Object 



406
407
408
 
# File 'lib/rubyXL/worksheet.rb', line 406

def change_column_border_bottom(col=0,weight='thin')
  change_column_border(col,:bottom,weight)
end

#change_column_border_diagonal(col = 0, weight = 'thin') ⇒ Object 



410
411
412
 
# File 'lib/rubyXL/worksheet.rb', line 410

def change_column_border_diagonal(col=0,weight='thin')
  change_column_border(col,:diagonal,weight)
end

#change_column_border_left(col = 0, weight = 'thin') ⇒ Object 



398
399
400
 
# File 'lib/rubyXL/worksheet.rb', line 398

def change_column_border_left(col=0,weight='thin')
  change_column_border(col,:left,weight)
end

#change_column_border_right(col = 0, weight = 'thin') ⇒ Object 



402
403
404
 
# File 'lib/rubyXL/worksheet.rb', line 402

def change_column_border_right(col=0,weight='thin')
  change_column_border(col,:right,weight)
end

#change_column_border_top(col = 0, weight = 'thin') ⇒ Object 



394
395
396
 
# File 'lib/rubyXL/worksheet.rb', line 394

def change_column_border_top(col=0,weight='thin')
  change_column_border(col,:top,weight)
end

#change_column_fill(col = 0, color_index = 'ffffff') ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/rubyXL/worksheet.rb', line 351

def change_column_fill(col=0, color_index='ffffff')
  validate_workbook
  validate_nonnegative(col)
  Color.validate_color(color_index)
  increase_columns(col)

  i = get_cols_index(col)

  if cols[i].nil?
    style_index = 0
  else
    #just copies any style if there is none which already exists for this col
    #while it changes style/min/max, width *might* be preserved
    style_index = Integer(@cols[i][:attributes][:style])
  end

  modify_fill(@workbook,style_index,color_index)

  change_cols(i,col)

  @sheet_data.each_with_index do |row,i|
    c = row[Integer(col)]
    unless c.nil?
      c.change_fill(color_index)
    end
  end

end

#change_column_font_color(col = 0, font_color = '000000') ⇒ Object

Changes font color of column



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/rubyXL/worksheet.rb', line 276

def change_column_font_color(col=0, font_color='000000')
  Color.validate_color(font_color)
  # Get style object
  xf_id = xf_id(get_col_style(col))
  # Get copy of font object with modified color
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_color(font, font_color.to_s)
  # Update font and xf array
  change_column_font(col, Worksheet::COLOR, font_color, font, xf_id)
end

#change_column_font_name(col = 0, font_name = 'Verdana') ⇒ Object

Changes font name of column



254
255
256
257
258
259
260
261
262
 
# File 'lib/rubyXL/worksheet.rb', line 254

def change_column_font_name(col=0, font_name='Verdana')
  # Get style object
  xf_id = xf_id(get_col_style(col))
  # Get copy of font object with modified name
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font[:name][:attributes][:val] = font_name.to_s
  # Update font and xf array
  change_column_font(col, Worksheet::NAME, font_name, font, xf_id)
end

#change_column_font_size(col = 0, font_size = 10) ⇒ Object

Changes font size of column



265
266
267
268
269
270
271
272
273
 
# File 'lib/rubyXL/worksheet.rb', line 265

def change_column_font_size(col=0, font_size=10)
  # Get style object
  xf_id = xf_id(get_col_style(col))
  # Get copy of font object with modified size
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font[:sz][:attributes][:val] = font_size
  # Update font and xf array
  change_column_font(col, Worksheet::SIZE, font_size, font, xf_id)
end

#change_column_horizontal_alignment(col = 0, alignment = 'center') ⇒ Object 



380
381
382
383
384
385
 
# File 'lib/rubyXL/worksheet.rb', line 380

def change_column_horizontal_alignment(col=0,alignment='center')
  validate_workbook
  validate_nonnegative(col)
  validate_horizontal_alignment(alignment)
  change_column_alignment(col,alignment,true)
end

#change_column_italics(col = 0, italicized = false) ⇒ Object

Changes font italics settings of column



288
289
290
291
292
293
294
295
296
 
# File 'lib/rubyXL/worksheet.rb', line 288

def change_column_italics(col=0, italicized=false)
  # Get style object
  xf_id = xf_id(get_col_style(col))
  # Get copy of font object with modified italics settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_italics(font, italicized)
  # Update font and xf array
  change_column_font(col, Worksheet::ITALICS, italicized, font, xf_id)
end

#change_column_strikethrough(col = 0, struckthrough = false) ⇒ Object

Changes font strikethrough settings of column



321
322
323
324
325
326
327
328
329
 
# File 'lib/rubyXL/worksheet.rb', line 321

def change_column_strikethrough(col=0, struckthrough=false)
  # Get style object
  xf_id = xf_id(get_col_style(col))
  # Get copy of font object with modified strikethrough settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_strikethrough(font, struckthrough)
  # Update font and xf array
  change_column_font(col, Worksheet::STRIKETHROUGH, struckthrough, font, xf_id)
end

#change_column_underline(col = 0, underlined = false) ⇒ Object

Changes font underline settings of column



310
311
312
313
314
315
316
317
318
 
# File 'lib/rubyXL/worksheet.rb', line 310

def change_column_underline(col=0, underlined=false)
  # Get style object
  xf_id = xf_id(get_col_style(col))
  # Get copy of font object with modified underline settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_underline(font, underlined)
  # Update font and xf array
  change_column_font(col, Worksheet::UNDERLINE, underlined, font, xf_id)
end

#change_column_vertical_alignment(col = 0, alignment = 'center') ⇒ Object 



387
388
389
390
391
392
 
# File 'lib/rubyXL/worksheet.rb', line 387

def change_column_vertical_alignment(col=0,alignment='center')
  validate_workbook
  validate_nonnegative(col)
  validate_vertical_alignment(alignment)
  change_column_alignment(col,alignment,false)
end

#change_column_width(col = 0, width = 13) ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/rubyXL/worksheet.rb', line 331

def change_column_width(col=0,width=13)
  validate_workbook
  validate_nonnegative(col)
  increase_columns(col)

  i = get_cols_index(col)

  if width.to_i.to_s == width.to_s
    width = Integer(width)
  elsif width.to_f.to_s == width.to_s
    width = Float(width)
  else
    raise 'You must enter a number for the width'
  end

  change_cols(i,col)
  @cols.last[:attributes][:width] = width
  @cols.last[:attributes][:customWidth] = '1'
end

#change_row_bold(row = 0, bolded = false) ⇒ Object

Changes font bold settings of row



165
166
167
168
169
170
171
172
173
 
# File 'lib/rubyXL/worksheet.rb', line 165

def change_row_bold(row=0, bolded=false)
  # Get style object
  xf_id = xf_id(get_row_style(row))
  # Get copy of font object with modified bold settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_bold(font, bolded)
  # Update font and xf array
  change_row_font(row, Worksheet::BOLD, bolded, font, xf_id)
end

#change_row_border_bottom(row = 0, weight = 'thin') ⇒ Object 



245
246
247
 
# File 'lib/rubyXL/worksheet.rb', line 245

def change_row_border_bottom(row=0,weight='thin')
  change_row_border(row, :bottom, weight)
end

#change_row_border_diagonal(row = 0, weight = 'thin') ⇒ Object 



249
250
251
 
# File 'lib/rubyXL/worksheet.rb', line 249

def change_row_border_diagonal(row=0,weight='thin')
  change_row_border(row, :diagonal, weight)
end

#change_row_border_left(row = 0, weight = 'thin') ⇒ Object 



237
238
239
 
# File 'lib/rubyXL/worksheet.rb', line 237

def change_row_border_left(row=0,weight='thin')
  change_row_border(row, :left, weight)
end

#change_row_border_right(row = 0, weight = 'thin') ⇒ Object 



241
242
243
 
# File 'lib/rubyXL/worksheet.rb', line 241

def change_row_border_right(row=0,weight='thin')
  change_row_border(row, :right, weight)
end

#change_row_border_top(row = 0, weight = 'thin') ⇒ Object 



233
234
235
 
# File 'lib/rubyXL/worksheet.rb', line 233

def change_row_border_top(row=0,weight='thin')
  change_row_border(row, :top, weight)
end

#change_row_fill(row = 0, rgb = 'ffffff') ⇒ Object

changes color of fill in (zer0 indexed) row



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/rubyXL/worksheet.rb', line 100

def change_row_fill(row=0,rgb='ffffff')
  validate_workbook
  validate_nonnegative(row)
  increase_rows(row)
  Color.validate_color(rgb)
  if @row_styles[(Integer(row)+1).to_s].nil?
    @row_styles[(Integer(row)+1).to_s] = {}
    @row_styles[(Integer(row)+1).to_s][:style] = '0'
  end

  @row_styles[(Integer(row)+1).to_s][:style] = modify_fill(@workbook,Integer(@row_styles[(Integer(row)+1).to_s][:style]),rgb)

  @sheet_data[Integer(row)].each do |c|
    unless c.nil?
      c.change_fill(rgb)
    end
  end
end

#change_row_font_color(row = 0, font_color = '000000') ⇒ Object

Changes font color of row



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/rubyXL/worksheet.rb', line 142

def change_row_font_color(row=0, font_color='000000')
  Color.validate_color(font_color)
  # Get style object
  xf_id = xf_id(get_row_style(row))
  # Get copy of font object with modified color
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_color(font, font_color.to_s)
  # Update font and xf array
  change_row_font(row, Worksheet::COLOR, font_color, font, xf_id)
end

#change_row_font_name(row = 0, font_name = 'Verdana') ⇒ Object

Changes font name of row



120
121
122
123
124
125
126
127
128
 
# File 'lib/rubyXL/worksheet.rb', line 120

def change_row_font_name(row=0, font_name='Verdana')
  # Get style object
  xf_id = xf_id(get_row_style(row))
  # Get copy of font object with modified name
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font[:name][:attributes][:val] = font_name.to_s
  # Update font and xf array
  change_row_font(row, Worksheet::NAME, font_name, font, xf_id)
end

#change_row_font_size(row = 0, font_size = 10) ⇒ Object

Changes font size of row



131
132
133
134
135
136
137
138
139
 
# File 'lib/rubyXL/worksheet.rb', line 131

def change_row_font_size(row=0, font_size=10)
  # Get style object
  xf_id = xf_id(get_row_style(row))
  # Get copy of font object with modified size
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font[:sz][:attributes][:val] = font_size
  # Update font and xf array
  change_row_font(row, Worksheet::SIZE, font_size, font, xf_id)
end

#change_row_height(row = 0, height = 10) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/rubyXL/worksheet.rb', line 197

def change_row_height(row=0,height=10)
  validate_workbook
  validate_nonnegative(row)

  increase_rows(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

  if @row_styles[(row+1).to_s].nil?
    @row_styles[(row+1).to_s] = {}
    @row_styles[(row+1).to_s][:style] = '0'
  end
  @row_styles[(row+1).to_s][:height] = height
  @row_styles[(row+1).to_s][:customHeight] = '1'
end

#change_row_horizontal_alignment(row = 0, alignment = 'center') ⇒ Object 



219
220
221
222
223
224
 
# File 'lib/rubyXL/worksheet.rb', line 219

def change_row_horizontal_alignment(row=0,alignment='center')
  validate_workbook
  validate_nonnegative(row)
  validate_horizontal_alignment(alignment)
  change_row_alignment(row,alignment,true)
end

#change_row_italics(row = 0, italicized = false) ⇒ Object

Changes font italics settings of row



154
155
156
157
158
159
160
161
162
 
# File 'lib/rubyXL/worksheet.rb', line 154

def change_row_italics(row=0, italicized=false)
  # Get style object
  xf_id = xf_id(get_row_style(row))
  # Get copy of font object with modified italics settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_italics(font, italicized)
  # Update font and xf array
  change_row_font(row, Worksheet::ITALICS, italicized, font, xf_id)
end

#change_row_strikethrough(row = 0, struckthrough = false) ⇒ Object

Changes font strikethrough settings of row



187
188
189
190
191
192
193
194
195
 
# File 'lib/rubyXL/worksheet.rb', line 187

def change_row_strikethrough(row=0, struckthrough=false)
  # Get style object
  xf_id = xf_id(get_row_style(row))
  # Get copy of font object with modified strikethrough settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_strikethrough(font, struckthrough)
  # Update font and xf array
  change_row_font(row, Worksheet::STRIKETHROUGH, struckthrough, font, xf_id)
end

#change_row_underline(row = 0, underlined = false) ⇒ Object

Changes font underline settings of row



176
177
178
179
180
181
182
183
184
 
# File 'lib/rubyXL/worksheet.rb', line 176

def change_row_underline(row=0, underlined=false)
  # Get style object
  xf_id = xf_id(get_row_style(row))
  # Get copy of font object with modified underline settings
  font = deep_copy(@workbook.fonts[xf_id[:fontId].to_s][:font])
  font = modify_font_underline(font, underlined)
  # Update font and xf array
  change_row_font(row, Worksheet::UNDERLINE, underlined, font, xf_id)
end

#change_row_vertical_alignment(row = 0, alignment = 'center') ⇒ Object 



226
227
228
229
230
231
 
# File 'lib/rubyXL/worksheet.rb', line 226

def change_row_vertical_alignment(row=0,alignment='center')
  validate_workbook
  validate_nonnegative(row)
  validate_vertical_alignment(alignment)
  change_row_alignment(row,alignment,false)
end

#delete_cell(row = 0, col = 0, shift = nil) ⇒ Object

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



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/rubyXL/worksheet.rb', line 700

def delete_cell(row=0,col=0,shift=nil)
  validate_workbook
  validate_nonnegative(row)
  validate_nonnegative(col)
  if @sheet_data.size <= row || @sheet_data[row].size <= col
    return nil
  end

  cell = @sheet_data[row][col]
  @sheet_data[row][col]=nil

  if shift && shift != :left && shift != :up
    raise 'invalid shift option'
  end

  if shift == :left
    @sheet_data[row].delete_at(col)
    @sheet_data[row] << nil
    (col...(@sheet_data[row].size)).each do |index|
      if @sheet_data[row][index].is_a?(Cell)
        @sheet_data[row][index].column -= 1
      end
    end
  elsif shift == :up
    (row...(@sheet_data.size-1)).each do |index|
      @sheet_data[index][col] = @sheet_data[index+1][col]
      if @sheet_data[index][col].is_a?(Cell)
        @sheet_data[index][col].row -= 1
      end
    end
    if @sheet_data.last[col].is_a?(Cell)
      @sheet_data.last[col].row -= 1
    end
  end

  return cell
end

#delete_column(col_index = 0) ⇒ Object 



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/rubyXL/worksheet.rb', line 571

def delete_column(col_index=0)
  validate_workbook
  validate_nonnegative(col_index)

  if col_index >= @sheet_data[0].size
    return nil
  end

  #delete column
  @sheet_data.map {|r| r.delete_at(col_index)}

  #change column numbers for cells to right of deleted column
  @sheet_data.each_with_index do |row,row_index|
    (col_index...(row.size)).each do |index|
      if @sheet_data[row_index][index].is_a?(Cell)
        @sheet_data[row_index][index].column -= 1
      end
    end
  end

  #shift column styles
  #shift col styles 'left'
  @cols.each do |col|
    if Integer(col[:attributes][:min]) >= col_index
      col[:attributes][:min] = (Integer(col[:attributes][:min]) - 1).to_s
    end
    if Integer(col[:attributes][:max]) >= col_index
      col[:attributes][:max] = (Integer(col[:attributes][:max]) - 1).to_s
    end
  end
end

#delete_row(row_index = 0) ⇒ Object 



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/rubyXL/worksheet.rb', line 487

def delete_row(row_index=0)
  validate_workbook
  validate_nonnegative(row_index)

  if row_index >= @sheet_data.size
    return nil
  end

  deleted = @sheet_data.delete_at(row_index)
  row_num = row_index+1

  row_num.upto(@sheet_data.size) do |index|
    @row_styles[(index-1).to_s] = deep_copy(@row_styles[index.to_s])
  end
  @row_styles.delete(@sheet_data.size.to_s)

  #change row styles
  # raise row_styles.inspect

  #change cell row numbers
  (row_index...(@sheet_data.size-1)).each do |index|
    @sheet_data[index].map {|c| c.row -= 1 if c}
  end

  return deleted
end

#each ⇒ Object 



30
31
32
 
# File 'lib/rubyXL/worksheet.rb', line 30

def each
  @sheet_data.each {|i| yield i}
end

#extract_data(args = {}) ⇒ Object

returns 2d array of just the cell values (without style or formula information)



35
36
37
38
 
# File 'lib/rubyXL/worksheet.rb', line 35

def extract_data(args = {})
  raw_values = args.delete(:raw) || false
  return @sheet_data.map {|row| row.map {|c| if c.is_a?(Cell) then c.value(:raw => raw_values) else nil end}}
end

#get_column_border_bottom(col = 0) ⇒ Object 



988
989
990
 
# File 'lib/rubyXL/worksheet.rb', line 988

def get_column_border_bottom(col=0)
  return get_column_border(col,:bottom)
end

#get_column_border_diagonal(col = 0) ⇒ Object 



992
993
994
 
# File 'lib/rubyXL/worksheet.rb', line 992

def get_column_border_diagonal(col=0)
  return get_column_border(col,:diagonal)
end

#get_column_border_left(col = 0) ⇒ Object 



980
981
982
 
# File 'lib/rubyXL/worksheet.rb', line 980

def get_column_border_left(col=0)
  return get_column_border(col,:left)
end

#get_column_border_right(col = 0) ⇒ Object 



984
985
986
 
# File 'lib/rubyXL/worksheet.rb', line 984

def get_column_border_right(col=0)
  return get_column_border(col,:right)
end

#get_column_border_top(col = 0) ⇒ Object 



976
977
978
 
# File 'lib/rubyXL/worksheet.rb', line 976

def get_column_border_top(col=0)
  return get_column_border(col,:top)
end

#get_column_fill(col = 0) ⇒ Object 



951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/rubyXL/worksheet.rb', line 951

def get_column_fill(col=0)
  validate_workbook
  validate_nonnegative(col)

  if @sheet_data[0].size <= col
    return nil
  end

  style_index = get_cols_style_index(col)

  if style_index == 0
    return "ffffff" #default, white
  end

  return @workbook.get_fill_color(@workbook.cell_xfs[:xf][style_index][:attributes])
end

#get_column_font_color(col = 0) ⇒ Object 



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
# File 'lib/rubyXL/worksheet.rb', line 898

def get_column_font_color(col=0)
  validate_workbook
  validate_nonnegative(col)

  if @sheet_data[0].size <= col
    return nil
  end

  style_index = get_cols_style_index(col)

  font = @workbook.fonts[font_id( style_index ).to_s][:font]

  if font[:color].nil? || font[:color][:attributes].nil? || font[:color][:attributes][:rgb].nil?
    return '000000'
  end

  return font[:color][:attributes][:rgb]

end

#get_column_font_name(col = 0) ⇒ Object 



872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/rubyXL/worksheet.rb', line 872

def get_column_font_name(col=0)
  validate_workbook
  validate_nonnegative(col)

  if @sheet_data[0].size <= col
    return nil
  end

  style_index = get_cols_style_index(col)

  return @workbook.fonts[font_id( style_index ).to_s][:font][:name][:attributes][:val]
end

#get_column_font_size(col = 0) ⇒ Object 



885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/rubyXL/worksheet.rb', line 885

def get_column_font_size(col=0)
  validate_workbook
  validate_nonnegative(col)

  if @sheet_data[0].size <= col
    return nil
  end

  style_index = get_cols_style_index(col)

  return @workbook.fonts[font_id( style_index ).to_s][:font][:sz][:attributes][:val]
end

#get_column_horizontal_alignment(col = 0) ⇒ Object 



968
969
970
 
# File 'lib/rubyXL/worksheet.rb', line 968

def get_column_horizontal_alignment(col=0)
  get_column_alignment(col, :horizontal)
end

#get_column_vertical_alignment(col = 0) ⇒ Object 



972
973
974
 
# File 'lib/rubyXL/worksheet.rb', line 972

def get_column_vertical_alignment(col=0)
  get_column_alignment(col, :vertical)
end

#get_column_width(col = 0) ⇒ Object 



934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/rubyXL/worksheet.rb', line 934

def get_column_width(col=0)
  validate_workbook
  validate_nonnegative(col)

  if @sheet_data[0].size <= col
    return nil
  end

  cols_index = get_cols_index(col)

  if @cols[cols_index].nil? || @cols[cols_index][:attributes].nil? || @cols[cols_index][:attributes][:width].to_s == ''
    return 10
  end

  return @cols[cols_index][:attributes][:width]
end

#get_row_border_bottom(row = 0) ⇒ Object 



864
865
866
 
# File 'lib/rubyXL/worksheet.rb', line 864

def get_row_border_bottom(row=0)
  return get_row_border(row,:bottom)
end

#get_row_border_diagonal(row = 0) ⇒ Object 



868
869
870
 
# File 'lib/rubyXL/worksheet.rb', line 868

def get_row_border_diagonal(row=0)
  return get_row_border(row,:diagonal)
end

#get_row_border_left(row = 0) ⇒ Object 



856
857
858
 
# File 'lib/rubyXL/worksheet.rb', line 856

def get_row_border_left(row=0)
  return get_row_border(row,:left)
end

#get_row_border_right(row = 0) ⇒ Object 



860
861
862
 
# File 'lib/rubyXL/worksheet.rb', line 860

def get_row_border_right(row=0)
  return get_row_border(row,:right)
end

#get_row_border_top(row = 0) ⇒ Object 



852
853
854
 
# File 'lib/rubyXL/worksheet.rb', line 852

def get_row_border_top(row=0)
  return get_row_border(row,:top)
end

#get_row_fill(row = 0) ⇒ Object 



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/rubyXL/worksheet.rb', line 738

def get_row_fill(row=0)
  validate_workbook
  validate_nonnegative(row)

  if @sheet_data.size <= row
    return nil
  end

  if @row_styles[(row+1).to_s].nil?
    return "ffffff" #default, white
  end

  xf = xf_attr_row(row)

  return @workbook.get_fill_color(xf)
end

#get_row_font_color(row = 0) ⇒ Object 



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/rubyXL/worksheet.rb', line 789

def get_row_font_color(row=0)
  validate_workbook
  validate_nonnegative(row)

  if @sheet_data.size <= row
    return nil
  end

  if @row_styles[(row+1).to_s].nil?
    return '000000'
  end

  xf = xf_attr_row(row)

  color = @workbook.fonts[xf[:fontId].to_s][:font][:color]

  if color.nil? || color[:attributes].nil? || color[:attributes][:rgb].nil?
    return '000000'
  end

  return color[:attributes][:rgb]
end

#get_row_font_name(row = 0) ⇒ Object 



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/rubyXL/worksheet.rb', line 755

def get_row_font_name(row=0)
  validate_workbook
  validate_nonnegative(row)

  if @sheet_data.size <= row
    return nil
  end

  if @row_styles[(row+1).to_s].nil?
    return 'Verdana'
  end

  xf = xf_attr_row(row)

  return @workbook.fonts[xf[:fontId].to_s][:font][:name][:attributes][:val]
end

#get_row_font_size(row = 0) ⇒ Object 



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/rubyXL/worksheet.rb', line 772

def get_row_font_size(row=0)
  validate_workbook
  validate_nonnegative(row)

  if @sheet_data.size <= row
    return nil
  end

  if @row_styles[(row+1).to_s].nil?
    return '10'
  end

  xf = xf_attr_row(row)

  return @workbook.fonts[xf[:fontId].to_s][:font][:sz][:attributes][:val]
end

#get_row_height(row = 0) ⇒ Object 



829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/rubyXL/worksheet.rb', line 829

def get_row_height(row=0)
  validate_workbook
  validate_nonnegative(row)

  if @sheet_data.size <= row
    return nil
  end

  if @row_styles[(row+1).to_s].nil?
    return 13
  else
    @row_styles[(row+1).to_s][:height]
  end
end

#get_row_horizontal_alignment(row = 0) ⇒ Object 



844
845
846
 
# File 'lib/rubyXL/worksheet.rb', line 844

def get_row_horizontal_alignment(row=0)
  return get_row_alignment(row,true)
end

#get_row_vertical_alignment(row = 0) ⇒ Object 



848
849
850
 
# File 'lib/rubyXL/worksheet.rb', line 848

def get_row_vertical_alignment(row=0)
  return get_row_alignment(row,false)
end

#get_table(headers = [], opts = {}) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/rubyXL/worksheet.rb', line 40

def get_table(headers=[],opts={})
  validate_workbook

  if !headers.is_a?(Array)
    headers = [headers]
  end

  row_num = find_first_row_with_content(headers)

	if row_num.nil?
		return nil
	end

	table_hash = {}
	table_hash[:table] = []

  header_row = @sheet_data[row_num]
	header_row.each_with_index do |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

	  cell = @sheet_data[current_row][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].empty?

		  table_hash[header] << (cell_test ? cell.value : nil)

  		table_index = current_row - original_row

  		if table_hash[:table][table_index].nil?
  		  table_hash[:table][table_index] = {}
  		end

  		table_hash[:table][table_index][header] = cell.value if cell_test

  		current_row += 1
  		if @sheet_data[current_row].nil?
  		  cell = nil
		  else
    		cell = @sheet_data[current_row][index]
  		end
      cell_test= (!cell.nil? && !cell.value.nil?)
	  end
 end

 return table_hash
end

#insert_cell(row = 0, col = 0, data = nil, formula = nil, shift = nil) ⇒ Object 



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/rubyXL/worksheet.rb', line 668

def insert_cell(row=0,col=0,data=nil,formula=nil,shift=nil)
  validate_workbook
  validate_nonnegative(row)
  validate_nonnegative(col)

  increase_rows(row)
  increase_columns(col)

  if shift && shift != :right && shift != :down
    raise 'invalid shift option'
  end

  if shift == :right
    @sheet_data[row].insert(col,nil)
    (row...(@sheet_data[row].size)).each do |index|
      if @sheet_data[row][index].is_a?(Cell)
        @sheet_data[row][index].column += 1
      end
    end
  elsif shift == :down
    @sheet_data << Array.new(@sheet_data[row].size)
    (@sheet_data.size-1).downto(row+1) do |index|
      @sheet_data[index][col] = @sheet_data[index-1][col]
    end
  end

  return add_cell(row,col,data,formula)
end

#insert_column(col_index = 0) ⇒ Object

inserts column at col_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”



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/rubyXL/worksheet.rb', line 605

def insert_column(col_index=0)
  validate_workbook
  validate_nonnegative(col_index)
  increase_columns(col_index)

  old_index = col_index > 0 ? col_index-1 : col_index+1
  old_col = @cols[get_cols_index(old_index)]
  if old_index == 1
    old_col = nil
  end

  #go through each cell in column
  @sheet_data.each_with_index do |r,i|
    #insert "column" in each row
    r.insert(col_index, nil)

    #copy styles over to each cell
    old_cell = r[old_index]
    unless old_cell.nil?
      #only add cell if style exists, not copying content
      if old_cell.style_index != 0
        if !old_col.nil? && old_cell.style_index.to_s != old_col[:attributes][:style].to_s
          c = Cell.new(self,i,col_index)
          c.style_index = old_cell.style_index
          @sheet_data[i][col_index] = c
        end
      end
    end
  end

  #copy over column-level styles
  new_col = change_cols(get_cols_index(old_index),old_index)
  @cols[-1] = deep_copy(old_col)#-1 = last

  new_col = @cols.last
  if @cols.last.nil?
    @cols.pop
  end

  #shift col styles 'right'
  @cols.each do |col|
    if Integer(col[:attributes][:min]) > col_index
      col[:attributes][:min] = (1 + Integer(col[:attributes][:min])).to_s
    end
    if Integer(col[:attributes][:max]) > col_index
      col[:attributes][:max] = (1 + Integer(col[:attributes][:max])).to_s
    end
  end
  unless new_col.nil?
    new_col[:attributes][:min] = (1 + Integer(new_col[:attributes][:min])).to_s
    new_col[:attributes][:max] = (1 + Integer(new_col[:attributes][:max])).to_s
  end

  #update column numbers
  @sheet_data.each do |row|
    (col_index+1).upto(row.size) do |j|
      unless row[j].nil?
        row[j].column += 1
      end
    end
  end
end

#insert_row(row_index = 0) ⇒ Object

inserts row at row_index, pushes down, copies style from below (row previously at that index) USE OF THIS METHOD will break formulas which reference cells which are being “pushed down”



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/rubyXL/worksheet.rb', line 516

def insert_row(row_index=0)
  validate_workbook
  validate_nonnegative(row_index)

  increase_rows(row_index)

  @sheet_data.insert(row_index,Array.new(@sheet_data[row_index].size))

  row_num = row_index+1

  #copy cell styles from row above, (or below if first row)
  @sheet_data[row_index].each_index do |i|
    if row_index > 0
      old_cell = @sheet_data[row_index-1][i]
    else
      old_cell = @sheet_data[row_index+1][i]
    end

    unless old_cell.nil?
      #only add cell if style exists, not copying content

      if @row_styles[(row_num+1).to_s].nil?
        @row_styles[(row_num+1).to_s] = {:style=>0}
      end
      if old_cell.style_index != 0 && old_cell.style_index.to_s != @row_styles[(row_num+1).to_s][:style].to_s
        c = Cell.new(self,row_index,i)
        c.style_index = old_cell.style_index
        @sheet_data[row_index][i] = c
      end
    end
  end

  #copy row styles from row above, (or below if first row)
  (@row_styles.size+1).downto(row_num+1) do |i|
    @row_styles[i.to_s] = @row_styles[(i-1).to_s]
  end
  if row_index > 0
    @row_styles[row_num.to_s] = @row_styles[(row_num-1).to_s]
  else
    @row_styles[row_num.to_s] = nil#@row_styles[(row_num+1).to_s]
  end

  #update row value for all rows below
  (row_index+1).upto(@sheet_data.size-1) do |i|
    row = @sheet_data[i]
    row.each do |c|
      unless c.nil?
        c.row += 1
      end
    end
  end

  return @sheet_data[row_index]
end

#is_column_bolded(col = 0) ⇒ Object 



922
923
924
 
# File 'lib/rubyXL/worksheet.rb', line 922

def is_column_bolded(col=0)
  get_column_bool(col,:b)
end

#is_column_italicized(col = 0) ⇒ Object 



918
919
920
 
# File 'lib/rubyXL/worksheet.rb', line 918

def is_column_italicized(col=0)
  get_column_bool(col,:i)
end

#is_column_struckthrough(col = 0) ⇒ Object 



930
931
932
 
# File 'lib/rubyXL/worksheet.rb', line 930

def is_column_struckthrough(col=0)
  get_column_bool(col,:strike)
end

#is_column_underlined(col = 0) ⇒ Object 



926
927
928
 
# File 'lib/rubyXL/worksheet.rb', line 926

def is_column_underlined(col=0)
  get_column_bool(col,:u)
end

#is_row_bolded(row = 0) ⇒ Object 



816
817
818
 
# File 'lib/rubyXL/worksheet.rb', line 816

def is_row_bolded(row=0)
  return get_row_bool(row,:b)
end

#is_row_italicized(row = 0) ⇒ Object 



812
813
814
 
# File 'lib/rubyXL/worksheet.rb', line 812

def is_row_italicized(row=0)
  return get_row_bool(row,:i)
end

#is_row_struckthrough(row = 0) ⇒ Object 



824
825
826
 
# File 'lib/rubyXL/worksheet.rb', line 824

def is_row_struckthrough(row=0)
  return get_row_bool(row,:strike)
end

#is_row_underlined(row = 0) ⇒ Object 



820
821
822
 
# File 'lib/rubyXL/worksheet.rb', line 820

def is_row_underlined(row=0)
  return get_row_bool(row,:u)
end

#merge_cells(row1 = 0, col1 = 0, row2 = 0, col2 = 0) ⇒ Object

merges cells within a rectangular range



415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/rubyXL/worksheet.rb', line 415

def merge_cells(row1=0,col1=0,row2=0,col2=0)
  validate_workbook
  @merged_cells << {
    :attributes => {
      :ref => ''
    }
  }
  cell1 = Cell.convert_to_cell(row1,col1)
  cell2 = Cell.convert_to_cell(row2,col2)
  @merged_cells.last[:attributes][:ref] = cell1+':'+cell2
end