Class: Writexlsx::Worksheet

Inherits:
Object
  • Object
show all
Includes:
Utility
Defined in:
lib/write_xlsx/worksheet.rb

Overview

A new worksheet is created by calling the add_worksheet() method from a workbook object:

worksheet1 = workbook.add_worksheet
worksheet2 = workbook.add_worksheet

The following methods are available through a new worksheet:

write
write_number
write_string
write_rich_string
write_blank
write_row
write_col
write_date_time
write_url
write_url_range
write_formula
write_comment
show_comments
set_comments_author
insert_image
insert_chart
insert_shape
data_validation
conditional_formatting
add_sparkline
add_table
name
activate
select
hide
set_first_sheet
protect
set_selection
set_row
set_column
outline_settings
freeze_panes
split_panes
merge_range
merge_range_type
set_zoom
right_to_left
hide_zero
set_tab_color
autofilter
filter_column
filter_column_list

Cell notation

WriteXLSX supports two forms of notation to designate the position of cells: Row-column notation and A1 notation.

Row-column notation uses a zero based index for both row and column while A1 notation uses the standard Excel alphanumeric sequence of column letter and 1-based row. For example:

(0, 0)      # The top left cell in row-column notation.
('A1')      # The top left cell in A1 notation.

(1999, 29)  # Row-column notation.
('AD2000')  # The same cell in A1 notation.

Row-column notation is useful if you are referring to cells programmatically:

(0..9).each do |i|
  worksheet.write(i, 0, 'Hello')    # Cells A1 to A10
end

A1 notation is useful for setting up a worksheet manually and for working with formulas:

worksheet.write('H1', 200)
worksheet.write('H2', '=H1+1')

In formulas and applicable methods you can also use the A:A column notation:

worksheet.write('A1', '=SUM(B:B)')

The Writexlsx::Utility module that is included in the distro contains helper functions for dealing with A1 notation, for example:

include Writexlsx::Utility

row, col = xl_cell_to_rowcol('C2')    # (1, 2)
str      = xl_rowcol_to_cell(1, 2)    # C2

For simplicity, the parameter lists for the worksheet method calls in the following sections are given in terms of row-column notation. In all cases it is also possible to use A1 notation.

PAGE SET-UP METHODS

Page set-up methods affect the way that a worksheet looks when it is printed. They control features such as page headers and footers and margins. These methods are really just standard worksheet methods. They are documented here in a separate section for the sake of clarity.

The following methods are available for page set-up:

set_landscape()
set_portrait()
set_page_view()
set_paper()
center_horizontally()
center_vertically()
set_margins()
set_header()
set_footer()
repeat_rows()
repeat_columns()
hide_gridlines()
print_row_col_headers()
print_area()
print_across()
fit_to_pages()
set_start_page()
set_print_scale()
set_h_pagebreaks()
set_v_pagebreaks()

A common requirement when working with WriteXLSX is to apply the same page set-up features to all of the worksheets in a workbook. To do this you can use the sheets() method of the workbook class to access the array of worksheets in a workbook:

workbook.sheets.each do |worksheet|
  worksheet.set_landscape
end

Direct Known Subclasses

Chartsheet

Defined Under Namespace

Classes: BlankCellData, CellData, FormulaArrayCellData, FormulaCellData, HyperlinkCellData, NumberCellData, PrintStyle, StringCellData

Constant Summary

Constants included from Utility

Utility::COL_MAX, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utility

#absolute_char, #check_dimensions, #check_dimensions_and_update_max_min_values, #check_parameter, #convert_date_time, delete_files, #ptrue?, #put_deprecate_message, #row_col_notation, #store_col_max_min_values, #store_row_max_min_values, #substitute_cellref, #underline_attributes, #write_color, #xl_cell_to_rowcol, #xl_col_to_name, #xl_range, #xl_range_formula, #xl_rowcol_to_cell, #xml_str

Constructor Details

#initialize(workbook, index, name) ⇒ Worksheet

:nodoc:



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/write_xlsx/worksheet.rb', line 360

def initialize(workbook, index, name) #:nodoc:
  @writer = Package::XMLWriterSimple.new

  @workbook = workbook
  @index = index
  @name = name
  @colinfo = []
  @cell_data_table = {}
  @excel_version = 2007

  @print_style = PrintStyle.new

  @print_area    = ''

  @screen_gridlines = true
  @show_zeros = true
  @dim_rowmin = nil
  @dim_rowmax = nil
  @dim_colmin = nil
  @dim_colmax = nil
  @selections = []
  @panes = []

  @tab_color  = 0

  @set_cols = {}
  @set_rows = {}
  @zoom = 100
  @zoom_scale_normal = true
  @right_to_left = false

  @autofilter_area = nil
  @filter_on    = false
  @filter_range = []
  @filter_cols  = {}
  @filter_type  = {}

  @col_sizes = {}
  @row_sizes = {}
  @col_formats = {}

  @last_shape_id          = 1
  @rel_count              = 0
  @hlink_count            = 0
  @hlink_refs             = []
  @external_hyper_links   = []
  @external_drawing_links = []
  @external_comment_links = []
  @external_vml_links     = []
  @external_table_links   = []
  @drawing_links          = []
  @charts                 = []
  @images                 = []
  @tables                 = []
  @sparklines             = []
  @shapes                 = []
  @shape_hash             = {}

  @zoom = 100
  @outline_row_level = 0
  @outline_col_level = 0

  @merge = []

  @comments = Package::Comments.new(self)

  @validations = []

  @cond_formats = {}
  @dxf_priority = 1
end

Instance Attribute Details

#autofilter_area ⇒ Object (readonly)

:nodoc:



354
355
356
 
# File 'lib/write_xlsx/worksheet.rb', line 354

def autofilter_area
  @autofilter_area
end

#charts ⇒ Object (readonly)

:nodoc:



349
350
351
 
# File 'lib/write_xlsx/worksheet.rb', line 349

def charts
  @charts
end

#col_formats ⇒ Object (readonly)

:nodoc:



355
356
357
 
# File 'lib/write_xlsx/worksheet.rb', line 355

def col_formats
  @col_formats
end

#comments_author ⇒ Object (readonly)

:nodoc:



357
358
359
 
# File 'lib/write_xlsx/worksheet.rb', line 357

def comments_author
  @comments_author
end

#drawing ⇒ Object (readonly)

:nodoc:



349
350
351
 
# File 'lib/write_xlsx/worksheet.rb', line 349

def drawing
  @drawing
end

#drawing_links ⇒ Object (readonly)

:nodoc:



352
353
354
 
# File 'lib/write_xlsx/worksheet.rb', line 352

def drawing_links
  @drawing_links
end

#dxf_priority ⇒ Object

:nodoc:



358
359
360
 
# File 'lib/write_xlsx/worksheet.rb', line 358

def dxf_priority
  @dxf_priority
end

#external_comment_links ⇒ Object (readonly)

:nodoc:



352
353
354
 
# File 'lib/write_xlsx/worksheet.rb', line 352

def external_comment_links
  @external_comment_links
end

#external_drawing_links ⇒ Object (readonly)

:nodoc:



350
351
352
 
# File 'lib/write_xlsx/worksheet.rb', line 350

def external_drawing_links
  @external_drawing_links
end

#external_hyper_links ⇒ Object (readonly)

:nodoc:



350
351
352
 
# File 'lib/write_xlsx/worksheet.rb', line 350

def external_hyper_links
  @external_hyper_links
end

#external_table_links ⇒ Object (readonly)

:nodoc:



351
352
353
 
# File 'lib/write_xlsx/worksheet.rb', line 351

def external_table_links
  @external_table_links
end

#external_vml_links ⇒ Object (readonly)

:nodoc:



351
352
353
 
# File 'lib/write_xlsx/worksheet.rb', line 351

def external_vml_links
  @external_vml_links
end

#hlink_refs ⇒ Object

:nodoc:



356
357
358
 
# File 'lib/write_xlsx/worksheet.rb', line 356

def hlink_refs
  @hlink_refs
end

#images ⇒ Object (readonly)

:nodoc:



349
350
351
 
# File 'lib/write_xlsx/worksheet.rb', line 349

def images
  @images
end

#index ⇒ Object (readonly)

:nodoc:



348
349
350
 
# File 'lib/write_xlsx/worksheet.rb', line 348

def index
  @index
end

#rel_count ⇒ Object

:nodoc:



356
357
358
 
# File 'lib/write_xlsx/worksheet.rb', line 356

def rel_count
  @rel_count
end

#set_rows ⇒ Object (readonly)

:nodoc:



355
356
357
 
# File 'lib/write_xlsx/worksheet.rb', line 355

def set_rows
  @set_rows
end

#shapes ⇒ Object (readonly)

:nodoc:



349
350
351
 
# File 'lib/write_xlsx/worksheet.rb', line 349

def shapes
  @shapes
end

#tables ⇒ Object (readonly)

:nodoc:



349
350
351
 
# File 'lib/write_xlsx/worksheet.rb', line 349

def tables
  @tables
end

#vml_data_id ⇒ Object (readonly)

:nodoc:



353
354
355
 
# File 'lib/write_xlsx/worksheet.rb', line 353

def vml_data_id
  @vml_data_id
end

#vml_shape_id ⇒ Object

:nodoc:



356
357
358
 
# File 'lib/write_xlsx/worksheet.rb', line 356

def vml_shape_id
  @vml_shape_id
end

#writer ⇒ Object (readonly)

:nodoc:



355
356
357
 
# File 'lib/write_xlsx/worksheet.rb', line 355

def writer
  @writer
end

Instance Method Details

#activate ⇒ Object

Set this worksheet as the active worksheet, i.e. the worksheet that is displayed when the workbook is opened. Also set it as selected.

The activate() method is used to specify which worksheet is initially visible in a multi-sheet workbook:

worksheet1 = workbook.add_worksheet('To')
worksheet2 = workbook.add_worksheet('the')
worksheet3 = workbook.add_worksheet('wind')

worksheet3.activate

This is similar to the Excel VBA activate method. More than one worksheet can be selected via the select() method, see below, however only one worksheet can be active.

The default active worksheet is the first worksheet.



522
523
524
525
526
 
# File 'lib/write_xlsx/worksheet.rb', line 522

def activate
  @hidden = false
  @selected = true
  @workbook.activesheet = @index
end

#add_sparkline(param) ⇒ Object

Add sparklines to the worksheet.

The add_sparkline worksheet method is used to add sparklines to a cell or a range of cells.

worksheet.add_sparkline(
  {
    :location => 'F2',
    :range    => 'Sheet1!A2:E2',
    :type     => 'column',
    :style    => 12
  }
)

See also the sparklines1.rb and sparklines2.rb example programs in the examples directory of the distro.

Note: Sparklines are a feature of Excel 2010+ only. You can write them to an XLSX file that can be read by Excel 2007 but they won’t be displayed.

Sparklines are a feature of Excel 2010+ which allows you to add small charts to worksheet cells. These are useful for showing visual trends in data in a compact format.



3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
 
# File 'lib/write_xlsx/worksheet.rb', line 3766

def add_sparkline(param)
  sparkline = {}

  # Check for valid input parameters.
  param.each_key do |k|
    unless valid_sparkline_parameter[k]
      raise "Unknown parameter '#{k}' in add_sparkline()"
    end
  end
  [:location, :range].each do |required_key|
    unless param[required_key]
      raise "Parameter '#{required_key}' is required in add_sparkline()"
    end
  end

  # Handle the sparkline type.
  type = param[:type] || 'line'
  unless ['line', 'column', 'win_loss'].include?(type)
    raise "Parameter ':type' must be 'line', 'column' or 'win_loss' in add_sparkline()"
  end
  type = 'stacked' if type == 'win_loss'
  sparkline[:_type] = type

  # We handle single location/range values or array refs of values.
  sparkline[:_locations] = [param[:location]].flatten
  sparkline[:_ranges]    = [param[:range]].flatten

  if sparkline[:_ranges].size != sparkline[:_locations].size
    raise "Must have the same number of location and range parameters in add_sparkline()"
  end

  # Store the count.
  sparkline[:_count] = sparkline[:_locations].size

  # Get the worksheet name for the range conversion below.
  sheetname = quote_sheetname(@name)

  # Cleanup the input ranges.
  sparkline[:_ranges].collect! do |range|
    # Remove the absolute reference $ symbols.
    range = range.gsub(/\$/, '')
    # Convert a simiple range into a full Sheet1!A1:D1 range.
    range = "#{sheetname}!#{range}" unless range =~ /!/
    range
  end

  # Cleanup the input locations.
  sparkline[:_locations].collect! { |location| location.gsub(/\$/, '') }

  # Map options.
  sparkline[:_high]      = param[:high_point]
  sparkline[:_low]       = param[:low_point]
  sparkline[:_negative]  = param[:negative_points]
  sparkline[:_first]     = param[:first_point]
  sparkline[:_last]      = param[:last_point]
  sparkline[:_markers]   = param[:markers]
  sparkline[:_min]       = param[:min]
  sparkline[:_max]       = param[:max]
  sparkline[:_axis]      = param[:axis]
  sparkline[:_reverse]   = param[:reverse]
  sparkline[:_hidden]    = param[:show_hidden]
  sparkline[:_weight]    = param[:weight]

  # Map empty cells options.
  empty = param[:empty_cells] || ''
  sparkline[:_empty] = case empty
  when 'zero'
    0
  when 'connect'
    'span'
  else
    'gap'
  end

  # Map the date axis range.
  date_range = param[:date_axis]
  if ptrue?(date_range) && !(date_range =~ /!/)
    date_range = "#{sheetname}!#{date_range}"
  end
  sparkline[:_date_axis] = date_range

  # Set the sparkline styles.
  style_id = param[:style] || 0
  style = spark_styles[style_id]

  sparkline[:_series_color]   = style[:series]
  sparkline[:_negative_color] = style[:negative]
  sparkline[:_markers_color]  = style[:markers]
  sparkline[:_first_color]    = style[:first]
  sparkline[:_last_color]     = style[:last]
  sparkline[:_high_color]     = style[:high]
  sparkline[:_low_color]      = style[:low]

  # Override the style colours with user defined colors.
  set_spark_color(sparkline, param, :series_color)
  set_spark_color(sparkline, param, :negative_color)
  set_spark_color(sparkline, param, :markers_color)
  set_spark_color(sparkline, param, :first_color)
  set_spark_color(sparkline, param, :last_color)
  set_spark_color(sparkline, param, :high_color)
  set_spark_color(sparkline, param, :low_color)

  @sparklines << sparkline
end

#add_table(*args) ⇒ Object

Add an Excel table to a worksheet.

The add_table() method is used to group a range of cells into an Excel Table.

worksheet.add_table('B3:F7', { ... } )

This method contains a lot of parameters and is described in detail in a separate section “TABLES IN EXCEL”.

See also the tables.rb program in the examples directory of the distro



3734
3735
3736
3737
3738
3739
3740
3741
3742
 
# File 'lib/write_xlsx/worksheet.rb', line 3734

def add_table(*args)
  # Table count is a member of Workbook, global to all Worksheet.
  @workbook.table_count += 1
  table = Package::Table.new(self, @workbook.table_count, *args)

  @external_table_links << ['/table', "../tables/table#{table.id}.xml"]
  @tables << table
  table
end

#assemble_xml_file ⇒ Object

:nodoc:



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/write_xlsx/worksheet.rb', line 436

def assemble_xml_file #:nodoc:
  @writer.xml_decl
  write_worksheet
  write_sheet_pr
  write_dimension
  write_sheet_views
  write_sheet_format_pr
  write_cols
  write_sheet_data
  write_sheet_protection
  write_auto_filter
  write_merge_cells
  write_conditional_formats
  write_data_validations
  write_hyperlinks
  write_print_options
  write_page_margins
  write_page_setup
  write_header_footer
  write_row_breaks
  write_col_breaks
  write_drawings
  write_legacy_drawing
  write_table_parts
  write_ext_sparklines
  @writer.end_tag('worksheet')
  @writer.crlf
  @writer.close
end

#autofilter(*args) ⇒ Object

:call-seq:

autofilter(first_row, first_col, last_row, last_col)

Set the autofilter area in the worksheet.

This method allows an autofilter to be added to a worksheet. An autofilter is a way of adding drop down lists to the headers of a 2D range of worksheet data. This is turn allow users to filter the data based on simple criteria so that some data is shown and some is hidden.

To add an autofilter to a worksheet:

worksheet.autofilter(0, 0, 10, 3)
worksheet.autofilter('A1:D11')    # Same as above in A1 notation.

Filter conditions can be applied using the filter_column() or filter_column_list() method.

See the autofilter.rb program in the examples directory of the distro for a more detailed example.



4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
 
# File 'lib/write_xlsx/worksheet.rb', line 4450

def autofilter(*args)
  row1, col1, row2, col2 = row_col_notation(args)
  return if [row1, col1, row2, col2].include?(nil)

  # Reverse max and min values if necessary.
  row1, row2 = row2, row1 if row2 < row1
  col1, col2 = col2, col1 if col2 < col1

  @autofilter_area = convert_name_area(row1, col1, row2, col2)
  @autofilter_ref  = xl_range(row1, row2, col1, col2)
  @filter_range    = [col1, col2]
end

#center_horizontally ⇒ Object

Center the worksheet data horizontally between the margins on the printed page:



1253
1254
1255
1256
 
# File 'lib/write_xlsx/worksheet.rb', line 1253

def center_horizontally
  @print_options_changed = true
  @hcenter               = true
end

#center_vertically ⇒ Object

Center the worksheet data vertically between the margins on the printed page:



1261
1262
1263
1264
 
# File 'lib/write_xlsx/worksheet.rb', line 1261

def center_vertically
  @print_options_changed = true
  @vcenter               = true
end

#comments_array ⇒ Object

:nodoc:



4945
4946
4947
 
# File 'lib/write_xlsx/worksheet.rb', line 4945

def comments_array # :nodoc:
  @comments.sorted_comments
end

#comments_assemble_xml_file ⇒ Object

:nodoc:



4941
4942
4943
 
# File 'lib/write_xlsx/worksheet.rb', line 4941

def comments_assemble_xml_file # :nodoc:
  @comments.assemble_xml_file
end

#comments_count ⇒ Object

:nodoc:



4728
4729
4730
 
# File 'lib/write_xlsx/worksheet.rb', line 4728

def comments_count # :nodoc:
  @comments.size
end

#comments_visible? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


4933
4934
4935
 
# File 'lib/write_xlsx/worksheet.rb', line 4933

def comments_visible? # :nodoc:
  !!@comments_visible
end

#comments_xml_writer=(file) ⇒ Object

:nodoc:



4937
4938
4939
 
# File 'lib/write_xlsx/worksheet.rb', line 4937

def comments_xml_writer=(file) # :nodoc:
  @comments.set_xml_writer(file)
end

#conditional_formatting(*args) ⇒ Object

:call-seq:

conditional_formatting(cell_or_cell_range, options)

This method handles the interface to Excel conditional formatting.

This method contains a lot of parameters and is described in detail in the section below.

We allow the format to be called on one cell or a range of cells. The hashref contains the formatting parameters and must be the last param:

conditional_formatting(row, col, {...})
conditional_formatting(first_row, first_col, last_row, last_col, {...})

The conditional_format() method is used to add formatting to a cell or range of cells based on user defined criteria.

worksheet.conditional_formatting('A1:J10',
    {
        :type     => 'cell',
        :criteria => '>=',
        :value    => 50,
        :format   => format1
    }
)

See also the conditional_format.rb program in the examples directory of the distro.

The conditional_formatting method is used to apply formatting based on user defined criteria to an write_xlsx file.

It can be applied to a single cell or a range of cells. You can pass 3 parameters such as (row, col, …) or 5 parameters such as (first_row, first_col, last_row, last_col, …). You can also use A1 style notation. For example:

worksheet.conditional_formatting( 0, 0,       {...} )
worksheet.conditional_formatting( 0, 0, 4, 1, {...} )

# Which are the same as:

worksheet.conditional_formatting( 'A1',       {...} )
worksheet.conditional_formatting( 'A1:B5',    {...} )

Using A1 style notation is is also possible to specify non-contiguous ranges, separated by a comma. For example:

worksheet.conditional_formatting( 'A1:D5,A8:D12', {...} )

The last parameter in conditional_formatting must be a hash containing the parameters that describe the type and style of the data validation.

The main parameters are:

:type
:format
:criteria
:value
:minimum
:maximum

Other, less commonly used parameters are:

:min_type
:mid_type
:max_type
:min_value
:mid_value
:max_value
:min_color
:mid_color
:max_color
:bar_color

Additional parameters which are used for specific conditional format types are shown in the relevant sections below.

:type

This parameter is passed in a hash to conditional_formatting.

The type parameter is used to set the type of conditional formatting that you wish to apply. It is always required and it has no default value. Allowable type values and their associated parameters are:

 Type             Parameters
======            ==========
'cell'            :criteria
                  :value
                  :minimum
                  :maximum

'date'            :criteria
                  :value
                  :minimum
                  :maximum

'time_period'     :criteria

'text'            :criteria
                  :value

'average'         :criteria

'duplicate'       (none)

'unique'          (none)

'top'             :criteria
                  :value

'bottom'          :criteria
                  :value

'blanks'          (none)

'no_blanks'       (none)

'errors'          (none)

'no_errors'       (none)

'2_color_scale'   (none)

'3_color_scale'   (none)

'data_bar'        (none)

'formula'         :criteria

All conditional formatting types have a format parameter, see below. Other types and parameters such as icon sets will be added in time.

:type => ‘cell’

This is the most common conditional formatting type. It is used when a format is applied to a cell based on a simple criterion. For example:

worksheet.conditional_formatting( 'A1',
    {
        :type     => 'cell',
        :criteria => 'greater than',
        :value    => 5,
        :format   => red_format
    }
)

Or, using the between criteria:

worksheet.conditional_formatting( 'C1:C4',
    {
        :type     => 'cell',
        :criteria => 'between',
        :minimum  => 20,
        :maximum  => 30,
        :format   => green_format
    }
)

:criteria

The criteria parameter is used to set the criteria by which the cell data will be evaluated. It has no default value. The most common criteria as applied to { type => ‘cell’ } are:

'between'
'not between'
'equal to'                  |  '=='  |  '='
'not equal to'              |  '!='  |  '<>'
'greater than'              |  '>'
'less than'                 |  '<'
'greater than or equal to'  |  '>='
'less than or equal to'     |  '<='

You can either use Excel’s textual description strings, in the first column above, or the more common symbolic alternatives.

Additional criteria which are specific to other conditional format types are shown in the relevant sections below.

:value

The value is generally used along with the criteria parameter to set the rule by which the cell data will be evaluated.

:type     => 'cell',
:criteria => '>',
:value    => 5
:format   => format

The value property can also be an cell reference.

:type     => 'cell',
:criteria => '>',
:value    => '$C$1',
:format   => format

:format

The format parameter is used to specify the format that will be applied to the cell when the conditional formatting criterion is met. The format is created using the add_format method in the same way as cell formats:

format = workbook.add_format( :bold => 1, :italic => 1 )

worksheet.conditional_formatting( 'A1',
    {
        :type     => 'cell',
        :criteria => '>',
        :value    => 5
        :format   => format
    }
)

The conditional format follows the same rules as in Excel: it is superimposed over the existing cell format and not all font and border properties can be modified. Font properties that can’t be modified are font name, font size, superscript and subscript. The border property that cannot be modified is diagonal borders.

Excel specifies some default formats to be used with conditional formatting. You can replicate them using the following write_xlsx formats:

# Light red fill with dark red text.

format1 = workbook.add_format(
  :bg_color => '#FFC7CE',
  :color    => '#9C0006'
)

# Light yellow fill with dark yellow text.

format2 = workbook.add_format(
  :bg_color => '#FFEB9C',
  :color    => '#9C6500'
)

# Green fill with dark green text.

format3 = workbook.add_format(
  :bg_color => '#C6EFCE',
  :color    => '#006100'
)

:minimum

The minimum parameter is used to set the lower limiting value when the criteria is either ‘between’ or ‘not between’:

:validate => 'integer',
:criteria => 'between',
:minimum  => 1,
:maximum  => 100

:maximum

The maximum parameter is used to set the upper limiting value when the criteria is either ‘between’ or ‘not between’. See the previous example.

:type => ‘date’

The date type is the same as the cell type and uses the same criteria and values. However it allows the value, minimum and maximum properties to be specified in the ISO8601 yyyy-mm-ddThh:mm:ss.sss date format which is detailed in the write_date_time() method.

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'date',
        :criteria => 'greater than',
        :value    => '2011-01-01T',
        :format   => format
    }
)

:type => ‘time_period’

The time_period type is used to specify Excel’s “Dates Occurring” style conditional format.

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'time_period',
        :criteria => 'yesterday',
        :format   => format
    }
)

The period is set in the criteria and can have one of the following values:

:criteria => 'yesterday',
:criteria => 'today',
:criteria => 'last 7 days',
:criteria => 'last week',
:criteria => 'this week',
:criteria => 'next week',
:criteria => 'last month',
:criteria => 'this month',
:criteria => 'next month'

:type => ‘text’

The text type is used to specify Excel’s “Specific Text” style conditional format. It is used to do simple string matching using the criteria and value parameters:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'text',
        :criteria => 'containing',
        :value    => 'foo',
        :format   => format
    }
)

The criteria can have one of the following values:

:criteria => 'containing',
:criteria => 'not containing',
:criteria => 'begins with',
:criteria => 'ends with'

The value parameter should be a string or single character.

:type => ‘average’

The average type is used to specify Excel’s “Average” style conditional format.

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'average',
        :criteria => 'above',
        :format   => format
    }
)

The type of average for the conditional format range is specified by the criteria:

:criteria => 'above',
:criteria => 'below',
:criteria => 'equal or above',
:criteria => 'equal or below',
:criteria => '1 std dev above',
:criteria => '1 std dev below',
:criteria => '2 std dev above',
:criteria => '2 std dev below',
:criteria => '3 std dev above',
:criteria => '3 std dev below'

:type => ‘duplicate’

The duplicate type is used to highlight duplicate cells in a range:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'duplicate',
        :format   => format
    }
)

:type => ‘unique’

The unique type is used to highlight unique cells in a range:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'unique',
        :format   => format
    }
)

:type => ‘top’

The top type is used to specify the top n values by number or percentage in a range:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'top',
        :value    => 10,
        :format   => format
    }
)

The criteria can be used to indicate that a percentage condition is required:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'top',
        :value    => 10,
        :criteria => '%',
        :format   => format
    }
)

:type => ‘bottom’

The bottom type is used to specify the bottom n values by number or percentage in a range.

It takes the same parameters as top, see above.

:type => ‘blanks’

The blanks type is used to highlight blank cells in a range:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'blanks',
        :format   => format
    }
)

:type => ‘no_blanks’

The no_blanks type is used to highlight non blank cells in a range:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'no_blanks',
        :format   => format
    }
)

:type => ‘errors’

The errors type is used to highlight error cells in a range:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'errors',
        :format   => format
    }
)

:type => ‘no_errors’

The no_errors type is used to highlight non error cells in a range:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'no_errors',
        :format   => format
    }
)

:type => ‘2_color_scale’

The 2_color_scale type is used to specify Excel’s “2 Color Scale” style conditional format.

worksheet.conditional_formatting( 'A1:A12',
    {
        :type  => '2_color_scale'
    }
)

At the moment only the default colors and properties can be used. These will be extended in time.

:type => ‘3_color_scale’

The 3_color_scale type is used to specify Excel’s “3 Color Scale” style conditional format.

worksheet.conditional_formatting( 'A1:A12',
    {
        :type  => '3_color_scale'
    }
)

At the moment only the default colors and properties can be used. These will be extended in time.

:type => ‘data_bar’

The data_bar type is used to specify Excel’s “Data Bar” style conditional format.

worksheet.conditional_formatting( 'A1:A12',
    {
        :type  => 'data_bar',
    }
)

At the moment only the default colors and properties can be used. These will be extended in time.

:type => ‘formula’

The formula type is used to specify a conditional format based on a user defined formula:

worksheet.conditional_formatting( 'A1:A4',
    {
        :type     => 'formula',
        :criteria => '=$A$1 > 5',
        :format   => format
    }
)

The formula is specified in the criteria.

:min_type, :mid_type, :max_type

The min_type and max_type properties are available when the conditional formatting type is 2_color_scale, 3_color_scale or data_bar. The mid_type is available for 3_color_scale. The properties are used as follows:

worksheet.conditional_formatting( 'A1:A12',
    {
        :type      => '2_color_scale',
        :min_type  => 'percent',
        :max_type  => 'percent'
    }
)

The available min/mid/max types are:

'num'
'percent'
'percentile'
'formula'

:min_value, :mid_value, :max_value

The min_value and max_value properties are available when the conditional formatting type is 2_color_scale, 3_color_scale or data_bar. The mid_value is available for 3_color_scale. The properties are used as follows:

worksheet.conditional_formatting( 'A1:A12',
    {
        :type       => '2_color_scale',
        :min_value  => 10,
        :max_value  => 90
    }
)

:min_color, :mid_color, :max_color, :bar_color

The min_color and max_color properties are available when the conditional formatting type is 2_color_scale, 3_color_scale or data_bar. The mid_color is available for 3_color_scale. The properties are used as follows:

worksheet.conditional_formatting( 'A1:A12',
    {
        ;type      => '2_color_scale',
        :min_color => "#C5D9F1",
        :max_color => "#538ED5"
    }
)

The color can be specifies as an Excel::Writer::XLSX color index or, more usefully, as a HTML style RGB hex number, as shown above.

Conditional Formatting Examples

Example 1. Highlight cells greater than an integer value.

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'cell',
        :criteria => 'greater than',
        :value    => 5,
        :format   => format
    }
)

Example 2. Highlight cells greater than a value in a reference cell.

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'cell',
        :criteria => 'greater than',
        :value    => '$H$1',
        :format   => format
    }
)

Example 3. Highlight cells greater than a certain date:

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'date',
        :criteria => 'greater than',
        :value    => '2011-01-01T',
        :format   => format
    }
)

Example 4. Highlight cells with a date in the last seven days:

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'time_period',
        :criteria => 'last 7 days',
        :format   => format
    }
)

Example 5. Highlight cells with strings starting with the letter b:

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'text',
        :criteria => 'begins with',
        :value    => 'b',
        :format   => format
    }
)

Example 6. Highlight cells that are 1 std deviation above the average for the range:

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'average',
        :format   => format
    }
)

Example 7. Highlight duplicate cells in a range:

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'duplicate',
        :format   => format
    }
)

Example 8. Highlight unique cells in a range.

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'unique',
        :format   => format
    }
)

Example 9. Highlight the top 10 cells.

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'top',
        :value    => 10,
        :format   => format
    }
)

Example 10. Highlight blank cells.

worksheet.conditional_formatting( 'A1:F10',
    {
        :type     => 'blanks',
        :format   => format
    }
)

See also the conditional_format.rb example program in EXAMPLES.



3715
3716
3717
3718
3719
 
# File 'lib/write_xlsx/worksheet.rb', line 3715

def conditional_formatting(*args)
  cond_format = Package::ConditionalFormat.factory(self, *args)
  @cond_formats[cond_format.range] ||= []
  @cond_formats[cond_format.range] << cond_format
end

#data_validation(*args) ⇒ Object

:call-seq:

data_validation(cell_or_cell_range, options)

Data validation is a feature of Excel which allows you to restrict the data that a users enters in a cell and to display help and warning messages. It also allows you to restrict input to values in a drop down list.

A typical use case might be to restrict data in a cell to integer values in a certain range, to provide a help message to indicate the required value and to issue a warning if the input data doesn’t meet the stated criteria. In WriteXLSX we could do that as follows:

worksheet.data_validation('B3',
    {
        :validate        => 'integer',
        :criteria        => 'between',
        :minimum         => 1,
        :maximum         => 100,
        :input_title     => 'Input an integer:',
        :input_message   => 'Between 1 and 100',
        :error_message   => 'Sorry, try again.'
    })

For more information on data validation see the following Microsoft support article “Description and examples of data validation in Excel”: support.microsoft.com/kb/211485.

The following sections describe how to use the data_validation() method and its various options.

The data_validation() method is used to construct an Excel data validation.

It can be applied to a single cell or a range of cells. You can pass 3 parameters such as (row, col, …) or 5 parameters such as (first_row, first_col, last_row, last_col, …). You can also use A1 style notation. For example:

worksheet.data_validation( 0, 0,       {...} )
worksheet.data_validation( 0, 0, 4, 1, {...} )

# Which are the same as:

worksheet.data_validation( 'A1',       {...} )
worksheet.data_validation( 'A1:B5',    {...} )

See also the note about “Cell notation” for more information.

The last parameter in data_validation() must be a hash ref containing the parameters that describe the type and style of the data validation. The allowable parameters are:

:validate
:criteria
:value | minimum | source
:maximum
:ignore_blank
:dropdown

:input_title
:input_message
:show_input

:error_title
:error_message
:error_type
:show_error

These parameters are explained in the following sections. Most of the parameters are optional, however, you will generally require the three main options validate, criteria and value.

worksheet.data_validation('B3',
    {
        :validate => 'integer',
        :criteria => '>',
        :value    => 100
    })

validate

This parameter is passed in a hash ref to data_validation().

The validate parameter is used to set the type of data that you wish to validate. It is always required and it has no default value. Allowable values are:

:any
:integer
:decimal
:list
:date
:time
:length
:custom

:any is used to specify that the type of data is unrestricted. This is the same as not applying a data validation. It is only provided for completeness and isn’t used very often in the context of WriteXLSX.

:integer restricts the cell to integer values. Excel refers to this as ‘whole number’.

:validate => 'integer',
:criteria => '>',
:value    => 100,

:decimal restricts the cell to decimal values.

:validate => 'decimal',
:criteria => '>',
:value    => 38.6,

:list restricts the cell to a set of user specified values. These can be passed in an array ref or as a cell range (named ranges aren’t currently supported):

:validate => 'list',
:value    => ['open', 'high', 'close'],
# Or like this:
:value    => 'B1:B3',

Excel requires that range references are only to cells on the same worksheet.

:date restricts the cell to date values. Dates in Excel are expressed as integer values but you can also pass an ISO860 style string as used in write_date_time(). See also “DATES AND TIME IN EXCEL” for more information about working with Excel’s dates.

:validate => 'date',
:criteria => '>',
:value    => 39653, # 24 July 2008
# Or like this:
:value    => '2008-07-24T',

:time restricts the cell to time values. Times in Excel are expressed as decimal values but you can also pass an ISO860 style string as used in write_date_time(). See also “DATES AND TIME IN EXCEL” for more information about working with Excel’s times.

:validate => 'time',
:criteria => '>',
:value    => 0.5, # Noon
# Or like this:
:value    => 'T12:00:00',

:length restricts the cell data based on an integer string length. Excel refers to this as ‘Text length’.

:validate => 'length',
:criteria => '>',
:value    => 10,

:custom restricts the cell based on an external Excel formula that returns a TRUE/FALSE value.

:validate => 'custom',
:value    => '=IF(A10>B10,TRUE,FALSE)',

criteria

This parameter is passed in a hash ref to data_validation().

The criteria parameter is used to set the criteria by which the data in the cell is validated. It is almost always required except for the list and custom validate options. It has no default value. Allowable values are:

'between'
'not between'
'equal to'                  |  '=='  |  '='
'not equal to'              |  '!='  |  '<>'
'greater than'              |  '>'
'less than'                 |  '<'
'greater than or equal to'  |  '>='
'less than or equal to'     |  '<='

You can either use Excel’s textual description strings, in the first column above, or the more common symbolic alternatives. The following are equivalent:

:validate => 'integer',
:criteria => 'greater than',
:value    => 100,

:validate => 'integer',
:criteria => '>',
:value    => 100,

The list and custom validate options don’t require a criteria. If you specify one it will be ignored.

:validate => 'list',
:value    => ['open', 'high', 'close'],

:validate => 'custom',
:value    => '=IF(A10>B10,TRUE,FALSE)',

value | minimum | source

This parameter is passed in a hash ref to data_validation().

The value parameter is used to set the limiting value to which the criteria is applied. It is always required and it has no default value. You can also use the synonyms minimum or source to make the validation a little clearer and closer to Excel’s description of the parameter:

# Use 'value'
:validate => 'integer',
:criteria => '>',
:value    => 100,

# Use 'minimum'
:validate => 'integer',
:criteria => 'between',
:minimum  => 1,
:maximum  => 100,

# Use 'source'
:validate => 'list',
:source   => '$B$1:$B$3',

maximum

This parameter is passed in a hash ref to data_validation().

The maximum parameter is used to set the upper limiting value when the criteria is either ‘between’ or ‘not between’:

:validate => 'integer',
:criteria => 'between',
:minimum  => 1,
:maximum  => 100,

ignore_blank

This parameter is passed in a hash ref to data_validation().

The ignore_blank parameter is used to toggle on and off the ‘Ignore blank’ option in the Excel data validation dialog. When the option is on the data validation is not applied to blank data in the cell. It is on by default.

:ignore_blank => 0,  # Turn the option off

dropdown

This parameter is passed in a hash ref to data_validation().

The dropdown parameter is used to toggle on and off the ‘In-cell dropdown’ option in the Excel data validation dialog. When the option is on a dropdown list will be shown for list validations. It is on by default.

:dropdown => 0,      # Turn the option off

input_title

This parameter is passed in a hash ref to data_validation().

The input_title parameter is used to set the title of the input message that is displayed when a cell is entered. It has no default value and is only displayed if the input message is displayed. See the input_message parameter below.

:input_title   => 'This is the input title',

The maximum title length is 32 characters.

input_message

This parameter is passed in a hash ref to data_validation().

The input_message parameter is used to set the input message that is displayed when a cell is entered. It has no default value.

:validate      => 'integer',
:criteria      => 'between',
:minimum       => 1,
:maximum       => 100,
:input_title   => 'Enter the applied discount:',
:input_message => 'between 1 and 100',

The message can be split over several lines using newlines, “n” in double quoted strings.

input_message => "This is\na test.",

The maximum message length is 255 characters.

show_input

This parameter is passed in a hash ref to data_validation().

The show_input parameter is used to toggle on and off the ‘Show input message when cell is selected’ option in the Excel data validation dialog. When the option is off an input message is not displayed even if it has been set using input_message. It is on by default.

:show_input => 0,      # Turn the option off

error_title

This parameter is passed in a hash ref to data_validation().

The error_title parameter is used to set the title of the error message that is displayed when the data validation criteria is not met. The default error title is ‘Microsoft Excel’.

:error_title   => 'Input value is not valid',

The maximum title length is 32 characters.

error_message

This parameter is passed in a hash ref to data_validation().

The error_message parameter is used to set the error message that is displayed when a cell is entered. The default error message is “The value you entered is not valid.nA user has restricted values that can be entered into the cell.”.

:validate      => 'integer',
:criteria      => 'between',
:minimum       => 1,
:maximum       => 100,
:error_title   => 'Input value is not valid',
:error_message => 'It should be an integer between 1 and 100',

The message can be split over several lines using newlines, “n” in double quoted strings.

:input_message => "This is\na test.",

The maximum message length is 255 characters.

error_type

This parameter is passed in a hash ref to data_validation().

The error_type parameter is used to specify the type of error dialog that is displayed. There are 3 options:

'stop'
'warning'
'information'

The default is ‘stop’.

show_error

This parameter is passed in a hash ref to data_validation().

The show_error parameter is used to toggle on and off the ‘Show error alert after invalid data is entered’ option in the Excel data validation dialog. When the option is off an error message is not displayed even if it has been set using error_message. It is on by default.

:show_error => 0,      # Turn the option off

Data Validation Examples

Example 1. Limiting input to an integer greater than a fixed value.

worksheet.data_validation('A1',
    {
        :validate        => 'integer',
        :criteria        => '>',
        :value           => 0,
    });

Example 2. Limiting input to an integer greater than a fixed value where the value is referenced from a cell.

worksheet.data_validation('A2',
    {
        :validate        => 'integer',
        :criteria        => '>',
        :value           => '=E3',
    });

Example 3. Limiting input to a decimal in a fixed range.

worksheet.data_validation('A3',
    {
        :validate        => 'decimal',
        :criteria        => 'between',
        :minimum         => 0.1,
        :maximum         => 0.5,
    });

Example 4. Limiting input to a value in a dropdown list.

worksheet.data_validation('A4',
    {
        :validate        => 'list',
        :source          => ['open', 'high', 'close'],
    });

Example 5. Limiting input to a value in a dropdown list where the list is specified as a cell range.

worksheet.data_validation('A5',
    {
        :validate        => 'list',
        :source          => '=$E$4:$G$4',
    });

Example 6. Limiting input to a date in a fixed range.

worksheet.data_validation('A6',
    {
        :validate        => 'date',
        :criteria        => 'between',
        :minimum         => '2008-01-01T',
        :maximum         => '2008-12-12T',
    });

Example 7. Displaying a message when the cell is selected.

worksheet.data_validation('A7',
    {
        :validate      => 'integer',
        :criteria      => 'between',
        :minimum       => 1,
        :maximum       => 100,
        :input_title   => 'Enter an integer:',
        :input_message => 'between 1 and 100',
    });

See also the data_validate.rb program in the examples directory of the distro.

Raises:



4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
 
# File 'lib/write_xlsx/worksheet.rb', line 4277

def data_validation(*args)
  # Check for a cell reference in A1 notation and substitute row and column.
  row1, col1, row2, col2, options = row_col_notation(args)
  if row2.respond_to?(:keys)
    param = row2.dup
    row2, col2 = row1, col1
  elsif options.respond_to?(:keys)
    param = options.dup
  else
    raise WriteXLSXInsufficientArgumentError
  end
  raise WriteXLSXInsufficientArgumentError if [row1, col1, row2, col2, param].include?(nil)

  check_dimensions(row1, col1)
  check_dimensions(row2, col2)

  check_for_valid_input_params(param)

  param[:value] = param[:source]  if param[:source]
  param[:value] = param[:minimum] if param[:minimum]

  param[:validate] = valid_validation_type[param[:validate].downcase]
  return if param[:validate] == 'none'
  if ['list', 'custom'].include?(param[:validate])
    param[:criteria]  = 'between'
    param[:maximum]   = nil
  end

  check_criteria_required(param)
  check_valid_citeria_types(param)
  param[:criteria] = valid_criteria_type[param[:criteria].downcase]

  check_maximum_value_when_criteria_is_between_or_notbetween(param)
  param[:error_type] = param.has_key?(:error_type) ? error_type[param[:error_type].downcase] : 0

  convert_date_time_value_if_required(param)
  set_some_defaults(param)

  param[:cells] = [[row1, col1, row2, col2]]

  # A (for now) undocumented parameter to pass additional cell ranges.
  param[:other_cells].each { |cells| param[:cells] << cells } if param.has_key?(:other_cells)

  # Store the validation information until we close the worksheet.
  @validations << param
end

#date_1904? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


4974
4975
4976
 
# File 'lib/write_xlsx/worksheet.rb', line 4974

def date_1904? #:nodoc:
  @workbook.date_1904?
end

#filter_column(col, expression) ⇒ Object

Set the column filter criteria.

The filter_column method can be used to filter columns in a autofilter range based on simple conditions.

NOTE: It isn’t sufficient to just specify the filter condition. You must also hide any rows that don’t match the filter condition. Rows are hidden using the set_row() visible parameter. WriteXLSX cannot do this automatically since it isn’t part of the file format. See the autofilter.rb program in the examples directory of the distro for an example.

The conditions for the filter are specified using simple expressions:

worksheet.filter_column('A', 'x > 2000')
worksheet.filter_column('B', 'x > 2000 and x < 5000')

The column parameter can either be a zero indexed column number or a string column name.

The following operators are available:

Operator        Synonyms
   ==           =   eq  =~
   !=           <>  ne  !=
   >
   <
   >=
   <=

   and          &&
   or           ||

The operator synonyms are just syntactic sugar to make you more comfortable using the expressions. It is important to remember that the expressions will be interpreted by Excel and not by ruby.

An expression can comprise a single statement or two statements separated by the and and or operators. For example:

'x <  2000'
'x >  2000'
'x == 2000'
'x >  2000 and x <  5000'
'x == 2000 or  x == 5000'

Filtering of blank or non-blank data can be achieved by using a value of Blanks or NonBlanks in the expression:

'x == Blanks'
'x == NonBlanks'

Excel also allows some simple string matching operations:

'x =~ b*'   # begins with b
'x !~ b*'   # doesn't begin with b
'x =~ *b'   # ends with b
'x !~ *b'   # doesn't end with b
'x =~ *b*'  # contains b
'x !~ *b*'  # doesn't contains b

You can also use * to match any character or number and ? to match any single character or number. No other regular expression quantifier is supported by Excel’s filters. Excel’s regular expression characters can be escaped using ~.

The placeholder variable x in the above examples can be replaced by any simple string. The actual placeholder name is ignored internally so the following are all equivalent:

'x     < 2000'
'col   < 2000'
'Price < 2000'

Also, note that a filter condition can only be applied to a column in a range specified by the autofilter() Worksheet method.

See the autofilter.rb program in the examples directory of the distro for a more detailed example.

Note Spreadsheet::WriteExcel supports Top 10 style filters. These aren’t currently supported by WriteXLSX but may be added later.



4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
 
# File 'lib/write_xlsx/worksheet.rb', line 4547

def filter_column(col, expression)
  raise "Must call autofilter before filter_column" unless @autofilter_area

  col = prepare_filter_column(col)

  tokens = extract_filter_tokens(expression)

  unless tokens.size == 3 || tokens.size == 7
    raise "Incorrect number of tokens in expression '#{expression}'"
  end

  tokens = parse_filter_expression(expression, tokens)

  # Excel handles single or double custom filters as default filters. We need
  # to check for them and handle them accordingly.
  if tokens.size == 2 && tokens[0] == 2
    # Single equality.
    filter_column_list(col, tokens[1])
  elsif tokens.size == 5 && tokens[0] == 2 && tokens[2] == 1 && tokens[3] == 2
    # Double equality with "or" operator.
    filter_column_list(col, tokens[1], tokens[4])
  else
    # Non default custom filter.
    @filter_cols[col] = Array.new(tokens)
    @filter_type[col] = 0
  end

  @filter_on = 1
end

#filter_column_list(col, *tokens) ⇒ Object

Set the column filter criteria in Excel 2007 list style.

Prior to Excel 2007 it was only possible to have either 1 or 2 filter conditions such as the ones shown above in the filter_column method.

Excel 2007 introduced a new list style filter where it is possible to specify 1 or more ‘or’ style criteria. For example if your column contained data for the first six months the initial data would be displayed as all selected as shown on the left. Then if you selected ‘March’, ‘April’ and ‘May’ they would be displayed as shown on the right.

No criteria selected      Some criteria selected.

[/] (Select all)          [X] (Select all)
[/] January               [ ] January
[/] February              [ ] February
[/] March                 [/] March
[/] April                 [/] April
[/] May                   [/] May
[/] June                  [ ] June

The filter_column_list() method can be used to represent these types of filters:

worksheet.filter_column_list('A', 'March', 'April', 'May')

The column parameter can either be a zero indexed column number or a string column name.

One or more criteria can be selected:

worksheet.filter_column_list(0, 'March')
worksheet.filter_column_list(1, 100, 110, 120, 130)

NOTE: It isn’t sufficient to just specify the filter condition. You must also hide any rows that don’t match the filter condition. Rows are hidden using the set_row() visible parameter. WriteXLSX cannot do this automatically since it isn’t part of the file format. See the autofilter.rb program in the examples directory of the distro for an example. e conditions for the filter are specified using simple expressions:



4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
 
# File 'lib/write_xlsx/worksheet.rb', line 4620

def filter_column_list(col, *tokens)
  tokens.flatten!
  raise "Incorrect number of arguments to filter_column_list" if tokens.empty?
  raise "Must call autofilter before filter_column_list" unless @autofilter_area

  col = prepare_filter_column(col)

  @filter_cols[col] = tokens
  @filter_type[col] = 1           # Default style.
  @filter_on        = 1
end

#fit_to_pages(width = 1, height = 1) ⇒ Object

The fit_to_pages() method is used to fit the printed area to a specific number of pages both vertically and horizontally. If the printed area exceeds the specified number of pages it will be scaled down to fit. This guarantees that the printed area will always appear on the specified number of pages even if the page size or margins change.

worksheet1.fit_to_pages(1, 1)    # Fit to 1x1 pages
worksheet2.fit_to_pages(2, 1)    # Fit to 2x1 pages
worksheet3.fit_to_pages(1, 2)    # Fit to 1x2 pages

The print area can be defined using the print_area() method as described above.

A common requirement is to fit the printed output to n pages wide but have the height be as long as necessary. To achieve this set the height to zero:

worksheet1.fit_to_pages(1, 0)    # 1 page wide and as long as necessary

Note that although it is valid to use both fit_to_pages() and set_print_scale() on the same worksheet only one of these options can be active at a time. The last method call made will set the active option.

Note that fit_to_pages() will override any manual page breaks that are defined in the worksheet.



4421
4422
4423
4424
4425
4426
 
# File 'lib/write_xlsx/worksheet.rb', line 4421

def fit_to_pages(width = 1, height = 1)
  @print_style.fit_page   = true
  @print_style.fit_width  = width
  @print_style.fit_height  = height
  @print_style.page_setup_changed = true
end

#freeze_panes(*args) ⇒ Object

:call-seq:

freeze_panes(row, col [ , top_row, left_col ] )

This method can be used to divide a worksheet into horizontal or vertical regions known as panes and to also “freeze” these panes so that the splitter bars are not visible. This is the same as the Window->Freeze Panes menu command in Excel

The parameters row and col are used to specify the location of the split. It should be noted that the split is specified at the top or left of a cell and that the method uses zero based indexing. Therefore to freeze the first row of a worksheet it is necessary to specify the split at row 2 (which is 1 as the zero-based index). This might lead you to think that you are using a 1 based index but this is not the case.

You can set one of the row and col parameters as zero if you do not want either a vertical or horizontal split.

Examples:

worksheet.freeze_panes(1, 0)    # Freeze the first row
worksheet.freeze_panes('A2')    # Same using A1 notation
worksheet.freeze_panes(0, 1)    # Freeze the first column
worksheet.freeze_panes('B1')    # Same using A1 notation
worksheet.freeze_panes(1, 2)    # Freeze first row and first 2 columns
worksheet.freeze_panes('C2')    # Same using A1 notation

The parameters top_row and left_col are optional. They are used to specify the top-most or left-most visible row or column in the scrolling region of the panes. For example to freeze the first row and to have the scrolling region begin at row twenty:

worksheet.freeze_panes(1, 0, 20, 0)

You cannot use A1 notation for the top_row and left_col parameters.

See also the panes.rb program in the examples directory of the distribution.



902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/write_xlsx/worksheet.rb', line 902

def freeze_panes(*args)
  return if args.empty?

  # Check for a cell reference in A1 notation and substitute row and column.
  row, col, top_row, left_col, type = row_col_notation(args)

  col      ||= 0
  top_row  ||= row
  left_col ||= col
  type     ||= 0

  @panes   = [row, col, top_row, left_col, type ]
end

#get_palette_color(index) ⇒ Object

Convert from an Excel internal colour index to a XML style #RRGGBB index based on the default or user defined values in the Workbook palette.



4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
 
# File 'lib/write_xlsx/worksheet.rb', line 4982

def get_palette_color(index) #:nodoc:
  if index =~ /^#([0-9A-F]{6})$/i
    return "FF#{$~[1]}"
  end

  # Adjust the colour index.
  index -= 8

  # Palette is passed in from the Workbook class.
  rgb = @workbook.palette[index]

  # TODO Add the alpha part to the RGB.
  sprintf("FF%02X%02X%02X", *rgb[0, 3])
end

#get_range_data(row_start, col_start, row_end, col_end) ⇒ Object

Returns a range of data from the worksheet _table to be used in chart cached data. Strings are returned as SST ids and decoded in the workbook. Return nils for data that doesn’t exist since Excel can chart series with data missing.



4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
 
# File 'lib/write_xlsx/worksheet.rb', line 4808

def get_range_data(row_start, col_start, row_end, col_end) # :nodoc:
  # TODO. Check for worksheet limits.

  # Iterate through the table data.
  data = []
  (row_start .. row_end).each do |row_num|
    # Store nil if row doesn't exist.
    if !@cell_data_table[row_num]
      data << nil
      next
    end

    (col_start .. col_end).each do |col_num|
      if cell = @cell_data_table[row_num][col_num]
        data << cell.data
      else
        # Store nil if col doesn't exist.
        data << nil
      end
    end
  end

  return data
end

#has_comments? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


4732
4733
4734
 
# File 'lib/write_xlsx/worksheet.rb', line 4732

def has_comments? # :nodoc:
  !@comments.empty?
end

#hidden? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


554
555
556
 
# File 'lib/write_xlsx/worksheet.rb', line 554

def hidden? # :nodoc:
  @hidden
end

#hide ⇒ Object

Hide this worksheet.

The hide() method is used to hide a worksheet:

worksheet2.hide

You may wish to hide a worksheet in order to avoid confusing a user with intermediate data or calculations.

A hidden worksheet can not be activated or selected so this method is mutually exclusive with the activate() and select() methods. In addition, since the first worksheet will default to being the active worksheet, you cannot hide the first worksheet without activating another sheet:

worksheet2.activate
worksheet1.hide



547
548
549
550
551
552
 
# File 'lib/write_xlsx/worksheet.rb', line 547

def hide
  @hidden = true
  @selected = false
  @workbook.activesheet = 0
  @workbook.firstsheet  = 0
end

#hide_gridlines(option = 1) ⇒ Object

Set the option to hide gridlines on the screen and the printed page.

This was mainly useful for Excel 5 where printed gridlines were on by default.

This method is used to hide the gridlines on the screen and printed page. Gridlines are the lines that divide the cells on a worksheet. Screen and printed gridlines are turned on by default in an Excel worksheet. If you have defined your own cell borders you may wish to hide the default gridlines.

worksheet.hide_gridlines

The following values of option are valid:

0 : Don't hide gridlines
1 : Hide printed gridlines only
2 : Hide screen and printed gridlines

If you don’t supply an argument or use nil the default option is true, i.e. only the printed gridlines are hidden.



4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
 
# File 'lib/write_xlsx/worksheet.rb', line 4347

def hide_gridlines(option = 1)
  if option == 0 || !option
    @print_gridlines       = true    # 1 = display, 0 = hide
    @screen_gridlines      = true
    @print_options_changed = true
  elsif option == 1
    @print_gridlines  = false
    @screen_gridlines = true
  else
    @print_gridlines  = false
    @screen_gridlines = false
  end
end

#hide_zero(flag = true) ⇒ Object

Hide cell zero values.

The hide_zero() method is used to hide any zero values that appear in cells.

worksheet.hide_zero

In Excel this option is found under Tools->Options->View.



1597
1598
1599
 
# File 'lib/write_xlsx/worksheet.rb', line 1597

def hide_zero(flag = true)
    @show_zeros = !flag
end

#insert_chart(*args) ⇒ Object

:call-seq:

insert_chart(row, column, chart [ , x, y, scale_x, scale_y ] )

Insert a chart into a worksheet. The chart argument should be a Chart object or else it is assumed to be a filename of an external binary file. The latter is for backwards compatibility.

This method can be used to insert a Chart object into a worksheet. The Chart must be created by the add_chart() Workbook method and it must have the embedded option set.

chart = workbook.add_chart(:type => 'line', :embedded => 1)

# Configure the chart.
...

# Insert the chart into the a worksheet.
worksheet.insert_chart('E2', chart)

See add_chart() for details on how to create the Chart object and Writexlsx::Chart for details on how to configure it. See also the chart_*.rb programs in the examples directory of the distro.

The x, y, scale_x and scale_y parameters are optional.

The parameters x and y can be used to specify an offset from the top left hand corner of the cell specified by row and column. The offset values are in pixels.

worksheet1.insert_chart('E2', chart, 3, 3)

The parameters scale_x and scale_y can be used to scale the inserted image horizontally and vertically:

# Scale the width by 120% and the height by 150%
worksheet.insert_chart('E2', chart, 0, 0, 1.2, 1.5)

Raises:



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
 
# File 'lib/write_xlsx/worksheet.rb', line 2786

def insert_chart(*args)
  # Check for a cell reference in A1 notation and substitute row and column.
  row, col, chart, x_offset, y_offset, scale_x, scale_y = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, chart].include?(nil)

  x_offset ||= 0
  y_offset ||= 0
  scale_x  ||= 1
  scale_y  ||= 1

  raise "Not a Chart object in insert_chart()" unless chart.is_a?(Chart) || chart.is_a?(Chartsheet)
  raise "Not a embedded style Chart object in insert_chart()" if chart.respond_to?(:embedded) && chart.embedded == 0

  @charts << [row, col, chart, x_offset, y_offset, scale_x, scale_y]
end

#insert_image(*args) ⇒ Object

:call-seq:

insert_image(row, column, filename [ , x, y, scale_x, scale_y ] )

Partially supported. Currently only works for 96 dpi images. This will be fixed in an upcoming release. – This method can be used to insert a image into a worksheet. The image can be in PNG, JPEG or BMP format. The x, y, scale_x and scale_y parameters are optional.

worksheet1.insert_image('A1', 'ruby.bmp')
worksheet2.insert_image('A1', '../images/ruby.bmp')
worksheet3.insert_image('A1', '.c:\images\ruby.bmp')

The parameters x and y can be used to specify an offset from the top left hand corner of the cell specified by row and column. The offset values are in pixels.

worksheet1.insert_image('A1', 'ruby.bmp', 32, 10)

The offsets can be greater than the width or height of the underlying cell. This can be occasionally useful if you wish to align two or more images relative to the same cell.

The parameters scale_x and scale_y can be used to scale the inserted image horizontally and vertically:

# Scale the inserted image: width x 2.0, height x 0.8
worksheet.insert_image('A1', 'perl.bmp', 0, 0, 2, 0.8)

See also the images.rb program in the examples directory of the distro.

Note: you must call set_row() or set_column() before insert_image() if you wish to change the default dimensions of any of the rows or columns that the image occupies. The height of a row can also change if you use a font that is larger than the default. This in turn will affect the scaling of your image. To avoid this you should explicitly set the height of the row using set_row() if it contains a font size that will change the row height.

BMP images must be 24 bit, true colour, bitmaps. In general it is best to avoid BMP images since they aren’t compressed. ++

Raises:



2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
 
# File 'lib/write_xlsx/worksheet.rb', line 2847

def insert_image(*args)
  # Check for a cell reference in A1 notation and substitute row and column.
  row, col, image, x_offset, y_offset, scale_x, scale_y = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, image].include?(nil)

  x_offset ||= 0
  y_offset ||= 0
  scale_x  ||= 1
  scale_y  ||= 1

  @images << [row, col, image, x_offset, y_offset, scale_x, scale_y]
end

#insert_shape(*args) ⇒ Object

Insert a shape into the worksheet.

This method can be used to insert a Shape object into a worksheet. The Shape must be created by the add_shape() Workbook method.

shape = workbook.add_shape(:name => 'My Shape', :type => 'plus')

# Configure the shape.
shape.set_text('foo')
...

# Insert the shape into the a worksheet.
worksheet.insert_shape('E2', shape)

See add_shape() for details on how to create the Shape object and Excel::Writer::XLSX::Shape for details on how to configure it.

The x, y, scale_x and scale_y parameters are optional.

The parameters x and y can be used to specify an offset from the top left hand corner of the cell specified by row and col. The offset values are in pixels.

worksheet1.insert_shape('E2', chart, 3, 3)

The parameters scale_x and scale_y can be used to scale the inserted shape horizontally and vertically:

# Scale the width by 120% and the height by 150%
worksheet.insert_shape('E2', shape, 0, 0, 1.2, 1.5)

See also the shape*.pl programs in the examples directory of the distro.



5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
 
# File 'lib/write_xlsx/worksheet.rb', line 5521

def insert_shape(*args)
  # Check for a cell reference in A1 notation and substitute row and column.
  row_start, column_start, shape, x_offset, y_offset, scale_x, scale_y =
    row_col_notation(args)
  if [row_start, column_start, shape].include?(nil)
    raise "Insufficient arguments in insert_shape()"
  end

  # Set the shape properties
  shape[:row_start]    = row_start
  shape[:column_start] = column_start
  shape[:x_offset]     = x_offset || 0
  shape[:y_offset]     = y_offset || 0

  # Override shape scale if supplied as an argument. Otherwise, use the
  # existing shape scale factors.
  shape[:scale_x] = scale_x if scale_x
  shape[:scale_y] = scale_y if scale_y

  # Assign a shape ID.
  while true
    id = shape[:id] || 0
    used = @shape_hash[id]

    # Test if shape ID is already used. Otherwise assign a new one.
    if !used && id != 0
      break
    else
      @last_shape_id += 1
      shape[:id] = @last_shape_id
    end
  end

  shape[:element] = @shapes.size

  # Allow lookup of entry into shape array by shape ID.
  @shape_hash[shape[:id]] = shape[:element]

  # Create link to Worksheet color palette.
  shape[:palette] = @workbook.palette

  if ptrue?(shape[:stencil])
    # Insert a copy of the shape, not a reference so that the shape is
    # used as a stencil. Previously stamped copies don't get modified
    # if the stencil is modified.
    insert = shape.dup

    # For connectors change x/y coords based on location of connected shapes.
    auto_locate_connectors(insert)

    @shapes << insert
    insert
  else
    # For connectors change x/y coords based on location of connected shapes.
    auto_locate_connectors(shape)

    # Insert a link to the shape on the list of shapes. Connection to
    # the parent shape is maintained.
    @shapes << shape
    return shape
  end
end

#is_chartsheet? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


4736
4737
4738
 
# File 'lib/write_xlsx/worksheet.rb', line 4736

def is_chartsheet? # :nodoc:
  !!@is_chartsheet
end

#margin_bottom=(margin) ⇒ Object

Set the bottom margin in inches. See margins=()



1339
1340
1341
 
# File 'lib/write_xlsx/worksheet.rb', line 1339

def margin_bottom=(margin)
  @print_style.margin_bottom = remove_white_space(margin)
end

#margin_left=(margin) ⇒ Object

Set the left margin in inches. See margins=()



1315
1316
1317
 
# File 'lib/write_xlsx/worksheet.rb', line 1315

def margin_left=(margin)
  @print_style.margin_left = remove_white_space(margin)
end

#margin_right=(margin) ⇒ Object

Set the right margin in inches. See margins=()



1323
1324
1325
 
# File 'lib/write_xlsx/worksheet.rb', line 1323

def margin_right=(margin)
  @print_style.margin_right = remove_white_space(margin)
end

#margin_top=(margin) ⇒ Object

Set the top margin in inches. See margins=()



1331
1332
1333
 
# File 'lib/write_xlsx/worksheet.rb', line 1331

def margin_top=(margin)
  @print_style.margin_top = remove_white_space(margin)
end

#margins=(margin) ⇒ Object

Set all the page margins to the same value in inches.

There are several methods available for setting the worksheet margins on the printed page:

margins=()                # Set all margins to the same value
margins_left_right=()     # Set left and right margins to the same value
margins_top_bottom=()     # Set top and bottom margins to the same value
margin_left=()            # Set left margin
margin_right=()           # Set right margin
margin_top=()             # Set top margin
margin_bottom=()          # Set bottom margin

All of these methods take a distance in inches as a parameter. Note: 1 inch = 25.4mm. ;-) The default left and right margin is 0.7 inch. The default top and bottom margin is 0.75 inch. Note, these defaults are different from the defaults used in the binary file format by writeexcel gem.



1286
1287
1288
1289
1290
1291
 
# File 'lib/write_xlsx/worksheet.rb', line 1286

def margins=(margin)
  self::margin_left   = margin
  self::margin_right  = margin
  self::margin_top    = margin
  self::margin_bottom = margin
end

#margins_left_right=(margin) ⇒ Object

Set the left and right margins to the same value in inches. See set_margins



1297
1298
1299
1300
 
# File 'lib/write_xlsx/worksheet.rb', line 1297

def margins_left_right=(margin)
  self::margin_left  = margin
  self::margin_right = margin
end

#margins_top_bottom=(margin) ⇒ Object

Set the top and bottom margins to the same value in inches. See set_margins



1306
1307
1308
1309
 
# File 'lib/write_xlsx/worksheet.rb', line 1306

def margins_top_bottom=(margin)
  self::margin_top    = margin
  self::margin_bottom = margin
end

#merge_range(*args) ⇒ Object

merge_range(first_row, first_col, last_row, last_col, string, format)

Merge a range of cells. The first cell should contain the data and the others should be blank. All cells should contain the same format.



3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
 
# File 'lib/write_xlsx/worksheet.rb', line 3013

def merge_range(*args)
  row_first, col_first, row_last, col_last, string, format, *extra_args = row_col_notation(args)

  raise "Incorrect number of arguments" if [row_first, col_first, row_last, col_last, format].include?(nil)
  raise "Fifth parameter must be a format object" unless format.respond_to?(:xf_index)
  raise "Can't merge single cell" if row_first == row_last && col_first == col_last

  # Swap last row/col with first row/col as necessary
  row_first,  row_last  = row_last,  row_first  if row_first > row_last
  col_first, col_last = col_last, col_first if col_first > col_last

  # Check that column number is valid and store the max value
  check_dimensions(row_last, col_last)
  store_row_col_max_min_values(row_last, col_last)

  # Store the merge range.
  @merge << [row_first, col_first, row_last, col_last]

  # Write the first cell
  write(row_first, col_first, string, format, *extra_args)

  # Pad out the rest of the area with formatted blank cells.
  write_formatted_blank_to_area(row_first, row_last, col_first, col_last, format)
end

#merge_range_type(type, *args) ⇒ Object

Same as merge_range() above except the type of write() is specified.



3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
 
# File 'lib/write_xlsx/worksheet.rb', line 3041

def merge_range_type(type, *args)
  case type
  when 'array_formula', 'blank', 'rich_string'
    row_first, col_first, row_last, col_last, *others = row_col_notation(args)
    format = others.pop
  else
    row_first, col_first, row_last, col_last, token, format, *others = row_col_notation(args)
  end

  raise "Format object missing or in an incorrect position" unless format.respond_to?(:xf_index)
  raise "Can't merge single cell" if row_first == row_last && col_first == col_last

  # Swap last row/col with first row/col as necessary
  row_first, row_last = row_last, row_first if row_first > row_last
  col_first, col_last = col_last, col_first if col_first > col_last

  # Check that column number is valid and store the max value
  check_dimensions(row_last, col_last)
  store_row_col_max_min_values(row_last, col_last)

  # Store the merge range.
  @merge << [row_first, col_first, row_last, col_last]

  # Write the first cell
  case type
  when 'blank', 'rich_string', 'array_formula'
    others << format
  end

  if type == 'string'
    write_string(row_first, col_first, token, format, *others)
  elsif type == 'number'
    write_number(row_first, col_first, token, format, *others)
  elsif type == 'blank'
    write_blank(row_first, col_first, *others)
  elsif type == 'date_time'
    write_date_time(row_first, col_first, token, format, *others)
  elsif type == 'rich_string'
    write_rich_string(row_first, col_first, *others)
  elsif type == 'url'
    write_url(row_first, col_first, token, format, *others)
  elsif type == 'formula'
    write_formula(row_first, col_first, token, format, *others)
  elsif type == 'array_formula'
    write_formula_array(row_first, col_first, *others)
  else
    raise "Unknown type '#{type}'"
  end

  # Pad out the rest of the area with formatted blank cells.
  write_formatted_blank_to_area(row_first, row_last, col_first, col_last, format)
end

#name ⇒ Object

The name() method is used to retrieve the name of a worksheet. For example:

workbook.sheets.each do |sheet|
  print sheet.name
end

For reasons related to the design of WriteXLSX and to the internals of Excel there is no set_name() method. The only way to set the worksheet name is via the add_worksheet() method.



478
479
480
 
# File 'lib/write_xlsx/worksheet.rb', line 478

def name
  @name
end

#outline_settings(visible = 1, symbols_below = 1, symbols_right = 1, auto_style = 0) ⇒ Object

The outline_settings() method is used to control the appearance of outlines in Excel. Outlines are described in “OUTLINES AND GROUPING IN EXCEL”.

The visible parameter is used to control whether or not outlines are visible. Setting this parameter to 0 will cause all outlines on the worksheet to be hidden. They can be unhidden in Excel by means of the “Show Outline Symbols” command button. The default setting is 1 for visible outlines.

worksheet.outline_settings(0)

The symbols_below parameter is used to control whether the row outline symbol will appear above or below the outline level bar. The default setting is 1 for symbols to appear below the outline level bar.

The symbols_right parameter is used to control whether the column outline symbol will appear to the left or the right of the outline level bar. The default setting is 1 for symbols to appear to the right of the outline level bar.

The auto_style parameter is used to control whether the automatic outline generator in Excel uses automatic styles when creating an outline. This has no effect on a file generated by WriteXLSX but it does have an effect on how the worksheet behaves after it is created. The default setting is 0 for “Automatic Styles” to be turned off.

The default settings for all of these parameters correspond to Excel’s default parameters.

The worksheet parameters controlled by outline_settings() are rarely used.



2524
2525
2526
2527
2528
2529
2530
2531
 
# File 'lib/write_xlsx/worksheet.rb', line 2524

def outline_settings(visible = 1, symbols_below = 1, symbols_right = 1, auto_style = 0)
  @outline_on    = visible
  @outline_below = symbols_below
  @outline_right = symbols_right
  @outline_style = auto_style

  @outline_changed = 1
end

#paper=(paper_size) ⇒ Object

Set the paper type. Ex. 1 = US Letter, 9 = A4

This method is used to set the paper format for the printed output of a worksheet. The following paper styles are available:

Index   Paper format            Paper size
=====   ============            ==========
  0     Printer default         -
  1     Letter                  8 1/2 x 11 in
  2     Letter Small            8 1/2 x 11 in
  3     Tabloid                 11 x 17 in
  4     Ledger                  17 x 11 in
  5     Legal                   8 1/2 x 14 in
  6     Statement               5 1/2 x 8 1/2 in
  7     Executive               7 1/4 x 10 1/2 in
  8     A3                      297 x 420 mm
  9     A4                      210 x 297 mm
 10     A4 Small                210 x 297 mm
 11     A5                      148 x 210 mm
 12     B4                      250 x 354 mm
 13     B5                      182 x 257 mm
 14     Folio                   8 1/2 x 13 in
 15     Quarto                  215 x 275 mm
 16     -                       10x14 in
 17     -                       11x17 in
 18     Note                    8 1/2 x 11 in
 19     Envelope  9             3 7/8 x 8 7/8
 20     Envelope 10             4 1/8 x 9 1/2
 21     Envelope 11             4 1/2 x 10 3/8
 22     Envelope 12             4 3/4 x 11
 23     Envelope 14             5 x 11 1/2
 24     C size sheet            -
 25     D size sheet            -
 26     E size sheet            -
 27     Envelope DL             110 x 220 mm
 28     Envelope C3             324 x 458 mm
 29     Envelope C4             229 x 324 mm
 30     Envelope C5             162 x 229 mm
 31     Envelope C6             114 x 162 mm
 32     Envelope C65            114 x 229 mm
 33     Envelope B4             250 x 353 mm
 34     Envelope B5             176 x 250 mm
 35     Envelope B6             176 x 125 mm
 36     Envelope                110 x 230 mm
 37     Monarch                 3.875 x 7.5 in
 38     Envelope                3 5/8 x 6 1/2 in
 39     Fanfold                 14 7/8 x 11 in
 40     German Std Fanfold      8 1/2 x 12 in
 41     German Legal Fanfold    8 1/2 x 13 in

Note, it is likely that not all of these paper types will be available to the end user since it will depend on the paper formats that the user’s printer supports. Therefore, it is best to stick to standard paper types.

worksheet.set_paper(1)    # US Letter
worksheet.set_paper(9)    # A4

If you do not specify a paper type the worksheet will print using the printer’s default paper.



1068
1069
1070
1071
1072
1073
 
# File 'lib/write_xlsx/worksheet.rb', line 1068

def paper=(paper_size)
  if paper_size
    @paper_size         = paper_size
    @print_style.page_setup_changed = true
  end
end

#position_object_pixels(col_start, row_start, x1, y1, width, height, is_drawing = false) ⇒ Object

Calculate the vertices that define the position of a graphical object within the worksheet in pixels.

      +------------+------------+
      |     A      |      B     |
+-----+------------+------------+
|     |(x1,y1)     |            |
|  1  |(A1)._______|______      |
|     |    |              |     |
|     |    |              |     |
+-----+----|    BITMAP    |-----+
|     |    |              |     |
|  2  |    |______________.     |
|     |            |        (B2)|
|     |            |     (x2,y2)|
+---- +------------+------------+

Example of an object that covers some of the area from cell A1 to cell B2.

Based on the width and height of the object we need to calculate 8 vars:

col_start, row_start, col_end, row_end, x1, y1, x2, y2.

We also calculate the absolute x and y position of the top left vertex of the object. This is required for images.

x_abs, y_abs

The width and height of the cells that the object occupies can be variable and have to be taken into account.

The values of col_start and row_start are passed in from the calling function. The values of col_end and row_end are calculated by subtracting the width and height of the object from the width and height of the underlying cells.

col_start    # Col containing upper left corner of object.
x1           # Distance to left side of object.
row_start    # Row containing top left corner of object.
y1           # Distance to top of object.
col_end      # Col containing lower right corner of object.
x2           # Distance to right side of object.
row_end      # Row containing bottom right corner of object.
y2           # Distance to bottom of object.
width        # Width of object frame.
height       # Height of object frame.



4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
 
# File 'lib/write_xlsx/worksheet.rb', line 4880

def position_object_pixels(col_start, row_start, x1, y1, width, height, is_drawing = false) #:nodoc:
  # Calculate the absolute x offset of the top-left vertex.
  if @col_size_changed
    x_abs = (1 .. col_start).inject(0) {|sum, col| sum += size_col(col)}
  else
    # Optimisation for when the column widths haven't changed.
    x_abs = 64 * col_start
  end
  x_abs += x1

  # Calculate the absolute y offset of the top-left vertex.
  # Store the column change to allow optimisations.
  if @row_size_changed
    y_abs = (1 .. row_start).inject(0) {|sum, row| sum += size_row(row)}
  else
    # Optimisation for when the row heights haven't changed.
    y_abs = 20 * row_start
  end
  y_abs += y1

  # Adjust start column for offsets that are greater than the col width.
  x1, col_start = adjust_column_offset(x1, col_start)

  # Adjust start row for offsets that are greater than the row height.
  y1, row_start = adjust_row_offset(y1, row_start)

  # Initialise end cell to the same as the start cell.
  col_end = col_start
  row_end = row_start

  width  += x1
  height += y1

  # Subtract the underlying cell widths to find the end cell of the object.
  width, col_end = adjust_column_offset(width, col_end)

  # Subtract the underlying cell heights to find the end cell of the object.
  height, row_end = adjust_row_offset(height, row_end)

  # The following is only required for positioning drawing/chart objects
  # and not comments. It is probably the result of a bug.
  if ptrue?(is_drawing)
    col_end -= 1 if width == 0
    row_end -= 1 if height == 0
  end

  # The end vertices are whatever is left from the width and height.
  x2 = width
  y2 = height

  [col_start, row_start, x1, y1, col_end, row_end, x2, y2, x_abs, y_abs]
end

#prepare_chart(index, chart_id, drawing_id) ⇒ Object

Set up chart/drawings.



4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/write_xlsx/worksheet.rb', line 4771

def prepare_chart(index, chart_id, drawing_id) # :nodoc:
  drawing_type = 1

  row, col, chart, x_offset, y_offset, scale_x, scale_y  = @charts[index]
  chart.id = chart_id - 1
  scale_x ||= 0
  scale_y ||= 0

  width  = (0.5 + (480 * scale_x)).to_i
  height = (0.5 + (288 * scale_y)).to_i

  dimensions = position_object_emus(col, row, x_offset, y_offset, width, height)

  # Set the chart name for the embedded object if it has been specified.
  name = chart.name

  # Create a Drawing object to use with worksheet unless one already exists.
  if !drawing?
    drawing = Drawing.new
    drawing.add_drawing_object(drawing_type, dimensions, 0, 0, name)
    drawing.embedded = 1

    @drawing = drawing

    @external_drawing_links << ['/drawing', "../drawings/drawing#{drawing_id}.xml" ]
  else
    @drawing.add_drawing_object(drawing_type, dimensions, 0, 0, name)
  end
  @drawing_links << ['/chart', "../charts/chart#{chart_id}.xml"]
end

#prepare_image(index, image_id, drawing_id, width, height, name, image_type) ⇒ Object

Set up image/drawings.



5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
 
# File 'lib/write_xlsx/worksheet.rb', line 5455

def prepare_image(index, image_id, drawing_id, width, height, name, image_type) #:nodoc:
  drawing_type = 2
  drawing

  row, col, image, x_offset, y_offset, scale_x, scale_y = @images[index]

  width  *= scale_x
  height *= scale_y

  dimensions = position_object_emus(col, row, x_offset, y_offset, width, height)

  # Convert from pixels to emus.
  width  = (0.5 + (width  * 9_525)).to_i
  height = (0.5 + (height * 9_525)).to_i

  # Create a Drawing object to use with worksheet unless one already exists.
  if !drawing?
    drawing = Drawing.new
    drawing.embedded = 1

    @drawing = drawing

    @external_drawing_links << ['/drawing', "../drawings/drawing#{drawing_id}.xml"]
  else
    drawing = @drawing
  end

  drawing.add_drawing_object(drawing_type, dimensions, width, height, name)

  @drawing_links << ['/image', "../media/image#{image_id}.#{image_type}"]
end

#prepare_shape(index, drawing_id) ⇒ Object

Set up drawing shapes



5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
 
# File 'lib/write_xlsx/worksheet.rb', line 5588

def prepare_shape(index, drawing_id)
  shape = @shapes[index]
  drawing_type = 3

  # Create a Drawing object to use with worksheet unless one already exists.
  unless drawing?
    @drawing = Drawing.new
    @drawing.embedded = 1
    @external_drawing_links << ['/drawing', "../drawings/drawing#{drawing_id}.xml"]
  end

  # Validate the he shape against various rules.
  validate_shape(shape, index)
  position_shape_emus(shape)

  dimensions = [
                shape[:column_start], shape[:row_start],
                shape[:x1],           shape[:y1],
                shape[:column_end],   shape[:row_end],
                shape[:x2],           shape[:y2],
                shape[:x_abs],        shape[:y_abs],
                shape[:width_emu],    shape[:height_emu]
               ]

  drawing.add_drawing_object(drawing_type, dimensions, shape[:name], shape)
end

#print_across(across = true) ⇒ Object

Set the order in which pages are printed.

The print_across method is used to change the default print direction. This is referred to by Excel as the sheet “page order”.

worksheet.print_across

The default page order is shown below for a worksheet that extends over 4 pages. The order is called “down then across”:

[1] [3]
[2] [4]

However, by using the print_across method the print order will be changed to “across then down”:

[1] [2]
[3] [4]



1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'lib/write_xlsx/worksheet.rb', line 1621

def print_across(across = true)
  if across
    @print_style.across             = true
    @print_style.page_setup_changed = true
  else
    @print_style.across = false
  end
end

#print_area(*args) ⇒ Object

:call-seq:

print_area(first_row, first_col, last_row, last_col)

This method is used to specify the area of the worksheet that will be printed. All four parameters must be specified. You can also use A1 notation, see the note about “Cell notation”.

worksheet1.print_area( 'A1:H20' );    # Cells A1 to H20
worksheet2.print_area( 0, 0, 19, 7 ); # The same
worksheet2.print_area( 'A:H' );       # Columns A to H if rows have data



1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/write_xlsx/worksheet.rb', line 1506

def print_area(*args)
  return @print_area.dup if args.empty?
  row1, col1, row2, col2 = row_col_notation(args)
  return if [row1, col1, row2, col2].include?(nil)

  # Ignore max print area since this is the same as no print area for Excel.
  if row1 == 0 && col1 == 0 && row2 == ROW_MAX - 1 && col2 == COL_MAX - 1
    return
  end

  # Build up the print area range "=Sheet2!R1C1:R2C1"
  @print_area = convert_name_area(row1, col1, row2, col2)
end

#print_repeat_cols ⇒ Object

:nodoc:



1490
1491
1492
 
# File 'lib/write_xlsx/worksheet.rb', line 1490

def print_repeat_cols  # :nodoc:
  @print_style.repeat_cols
end

#print_repeat_rows ⇒ Object

:nodoc:



1456
1457
1458
 
# File 'lib/write_xlsx/worksheet.rb', line 1456

def print_repeat_rows   # :nodoc:
  @print_style.repeat_rows
end

#print_row_col_headers(headers = 1) ⇒ Object

Set the option to print the row and column headers on the printed page.

An Excel worksheet looks something like the following;

 ------------------------------------------
|   |   A   |   B   |   C   |   D   |  ...
 ------------------------------------------
| 1 |       |       |       |       |  ...
| 2 |       |       |       |       |  ...
| 3 |       |       |       |       |  ...
| 4 |       |       |       |       |  ...
|...|  ...  |  ...  |  ...  |  ...  |  ...

The headers are the letters and numbers at the top and the left of the worksheet. Since these headers serve mainly as a indication of position on the worksheet they generally do not appear on the printed page. If you wish to have them printed you can use the print_row_col_headers() method :

worksheet.print_row_col_headers

Do not confuse these headers with page headers as described in the set_header() section above.



4385
4386
4387
4388
4389
4390
4391
4392
 
# File 'lib/write_xlsx/worksheet.rb', line 4385

def print_row_col_headers(headers = 1)
  if headers
    @print_headers         = 1
    @print_options_changed = 1
  else
    @print_headers = 0
  end
end

#print_scale=(scale = 100) ⇒ Object

Set the scale factor of the printed page. Scale factors in the range 10 <= scale <= 400 are valid:

worksheet1.print_scale =  50
worksheet2.print_scale =  75
worksheet3.print_scale = 300
worksheet4.print_scale = 400

The default scale factor is 100. Note, print_scale=() does not affect the scale of the visible page in Excel. For that you should use set_zoom().

Note also that although it is valid to use both fit_to_pages() and print_scale=() on the same worksheet only one of these options can be active at a time. The last method call made will set the active option.



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/write_xlsx/worksheet.rb', line 1551

def print_scale=(scale = 100)
  scale_val = scale.to_i
  # Confine the scale to Excel's range
  scale_val = 100 if scale_val < 10 || scale_val > 400

  # Turn off "fit to page" option.
  @print_style.fit_page = false

  @print_style.scale              = scale_val
  @print_style.page_setup_changed = true
end

#protect(password = nil, options = {}) ⇒ Object

Set the worksheet protection flags to prevent modification of worksheet objects.

The protect() method is used to protect a worksheet from modification:

worksheet.protect

The protect() method also has the effect of enabling a cell’s locked and hidden properties if they have been set. A locked cell cannot be edited and this property is on by default for all cells. A hidden cell will display the results of a formula but not the formula itself.

See the protection.rb program in the examples directory of the distro for an illustrative example and the set_locked and set_hidden format methods in “CELL FORMATTING”.

You can optionally add a password to the worksheet protection:

worksheet.protect('drowssap')

Passing the empty string ” is the same as turning on protection without a password.

Note, the worksheet level password in Excel provides very weak protection. It does not encrypt your data and is very easy to deactivate. Full workbook encryption is not supported by WriteXLSX since it requires a completely different file format and would take several man months to implement.

You can specify which worksheet elements that you which to protect by passing a hash_ref with any or all of the following keys:

# Default shown.
options = {
    :objects               => false,
    :scenarios             => false,
    :format_cells          => false,
    :format_columns        => false,
    :format_rows           => false,
    :insert_columns        => false,
    :insert_rows           => false,
    :insert_hyperlinks     => false,
    :delete_columns        => false,
    :delete_rows           => false,
    :select_locked_cells   => true,
    :sort                  => false,
    :autofilter            => false,
    :pivot_tables          => false,
    :select_unlocked_cells => true
}

The default boolean values are shown above. Individual elements can be protected as follows:

worksheet.protect('drowssap', { :insert_rows => true } )



639
640
641
642
643
644
645
646
 
# File 'lib/write_xlsx/worksheet.rb', line 639

def protect(password = nil, options = {})
  check_parameter(options, protect_default_settings.keys, 'protect')
  @protect = protect_default_settings.merge(options)

  # Set the password after the user defined values.
  @protect[:password] =
    sprintf("%X", encode_password(password)) if password && password != ''
end

#repeat_columns(*args) ⇒ Object

:call-seq:

repeat_columns(first_col, last_col = nil)

Set the columns to repeat at the left hand side of each printed page.

For large Excel documents it is often desirable to have the first column or columns of the worksheet print out at the left hand side of each page. This can be achieved by using the repeat_columns() method. The parameters first_column and last_column are zero based. The last_column parameter is optional if you only wish to specify one column. You can also specify the columns using A1 column notation, see the note about “Cell notation”.

worksheet1.repeat_columns(0)        # Repeat the first column
worksheet2.repeat_columns(0, 1)     # Repeat the first two columns
worksheet3.repeat_columns('A:A')    # Repeat the first column
worksheet4.repeat_columns('A:B')    # Repeat the first two columns



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/write_xlsx/worksheet.rb', line 1478

def repeat_columns(*args)
  if args[0] =~ /^\D/
    dummy, first_col, dummy, last_col = substitute_cellref(*args)
  else
    first_col, last_col = args
  end
  last_col ||= first_col

  area = "#{xl_col_to_name(first_col, 1)}:#{xl_col_to_name(last_col, 1)}"
  @print_style.repeat_cols = "#{quote_sheetname(@name)}!#{area}"
end

#repeat_formula(*args) ⇒ Object

:call-seq:

repeat_formula(row, column, formula [ , format ] )

Deprecated. This is a writeexcel gem’s method that is no longer required by WriteXLSX.

In writeexcel it was computationally expensive to write formulas since they were parsed by a recursive descent parser. The store_formula() and repeat_formula() methods were used as a way of avoiding the overhead of repeated formulas by reusing a pre-parsed formula.

In WriteXLSX this is no longer necessary since it is just as quick to write a formula as it is to write a string or a number.

The methods remain for backward compatibility but new WriteXLSX programs shouldn’t use them.

Raises:



2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
 
# File 'lib/write_xlsx/worksheet.rb', line 2878

def repeat_formula(*args)
  # Check for a cell reference in A1 notation and substitute row and column.
  row, col, formula, format, *pairs = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col].include?(nil)

  raise "Odd number of elements in pattern/replacement list" unless pairs.size % 2 == 0
  raise "Not a valid formula" unless formula.respond_to?(:to_ary)

  tokens  = formula.join("\t").split("\t")
  raise "No tokens in formula" if tokens.empty?

  value = nil
  if pairs[-2] == 'result'
    value = pairs.pop
    pairs.pop
  end
  while !pairs.empty?
    pattern = pairs.shift
    replace = pairs.shift

    tokens.each do |token|
      break if token.sub!(pattern, replace)
    end
  end
  formula = tokens.join('')
  write_formula(row, col, formula, format, value)
end

#repeat_rows(row_min, row_max = nil) ⇒ Object

Set the number of rows to repeat at the top of each printed page.

For large Excel documents it is often desirable to have the first row or rows of the worksheet print out at the top of each page. This can be achieved by using the repeat_rows() method. The parameters first_row and last_row are zero based. The last_row parameter is optional if you only wish to specify one row:

worksheet1.repeat_rows(0)    # Repeat the first row
worksheet2.repeat_rows(0, 1) # Repeat the first two rows



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
 
# File 'lib/write_xlsx/worksheet.rb', line 1442

def repeat_rows(row_min, row_max = nil)
  row_max ||= row_min

  # Convert to 1 based.
  row_min += 1
  row_max += 1

  area = "$#{row_min}:$#{row_max}"

  # Build up the print titles "Sheet1!$1:$2"
  sheetname = quote_sheetname(name)
  @print_style.repeat_rows = "#{sheetname}!#{area}"
end

#right_to_left(flag = true) ⇒ Object

Display the worksheet right to left for some eastern versions of Excel.

The right_to_left() method is used to change the default direction of the worksheet from left-to-right, with the A1 cell in the top left, to right-to-left, with the he A1 cell in the top right.

worksheet.right_to_left

This is useful when creating Arabic, Hebrew or other near or far eastern worksheets that use right-to-left as the default direction.



1583
1584
1585
 
# File 'lib/write_xlsx/worksheet.rb', line 1583

def right_to_left(flag = true)
  @right_to_left = !!flag
end

#select ⇒ Object

Set this worksheet as a selected worksheet, i.e. the worksheet has its tab highlighted.

The select() method is used to indicate that a worksheet is selected in a multi-sheet workbook:

worksheet1.activate
worksheet2.select
worksheet3.select

A selected worksheet has its tab highlighted. Selecting worksheets is a way of grouping them together so that, for example, several worksheets could be printed in one go. A worksheet that has been activated via the activate() method will also appear as selected.



498
499
500
501
 
# File 'lib/write_xlsx/worksheet.rb', line 498

def select
  @hidden   = false  # Selected worksheet can't be hidden.
  @selected = true
end

#set_column(*args) ⇒ Object

:call-seq:

set_column(firstcol, lastcol, width, format, hidden, level)

This method can be used to change the default properties of a single column or a range of columns. All parameters apart from first_col and last_col are optional.

If set_column() is applied to a single column the value of first_col and last_col should be the same. In the case where last_col is zero it is set to the same value as first_col.

It is also possible, and generally clearer, to specify a column range using the form of A1 notation used for columns. See the note about “Cell notation”.

Examples:

worksheet.set_column(0, 0, 20)    # Column  A   width set to 20
worksheet.set_column(1, 3, 30)    # Columns B-D width set to 30
worksheet.set_column('E:E', 20)   # Column  E   width set to 20
worksheet.set_column('F:H', 30)   # Columns F-H width set to 30

The width corresponds to the column width value that is specified in Excel. It is approximately equal to the length of a string in the default font of Arial 10. Unfortunately, there is no way to specify “AutoFit” for a column in the Excel file format. This feature is only available at runtime from within Excel.

As usual the format parameter is optional, for additional information, see “CELL FORMATTING”. If you wish to set the format without changing the width you can pass nil as the width parameter:

worksheet.set_column(0, 0, nil, format)

The format parameter will be applied to any cells in the column that don’t have a format. For example

worksheet.set_column( 'A:A', nil, format1 )    # Set format for col 1
worksheet.write( 'A1', 'Hello' )                  # Defaults to format1
worksheet.write( 'A2', 'Hello', format2 )        # Keeps format2

If you wish to define a column format in this way you should call the method before any calls to write(). If you call it afterwards it won’t have any effect.

A default row format takes precedence over a default column format

worksheet.set_row( 0, nil, format1 )           # Set format for row 1
worksheet.set_column( 'A:A', nil, format2 )    # Set format for col 1
worksheet.write( 'A1', 'Hello' )               # Defaults to format1
worksheet.write( 'A2', 'Hello' )               # Defaults to format2

The hidden parameter should be set to 1 if you wish to hide a column. This can be used, for example, to hide intermediary steps in a complicated calculation:

worksheet.set_column( 'D:D', 20,  format, 1 )
worksheet.set_column( 'E:E', nil, nil,    1 )

The level parameter is used to set the outline level of the column. Outlines are described in “OUTLINES AND GROUPING IN EXCEL”. Adjacent columns with the same outline level are grouped together into a single outline.

The following example sets an outline level of 1 for columns B to G:

worksheet.set_column( 'B:G', nil, nil, 0, 1 )

The hidden parameter can also be used to hide collapsed outlined columns when used in conjunction with the level parameter.

worksheet.set_column( 'B:G', nil, nil, 1, 1 )

For collapsed outlines you should also indicate which row has the collapsed + symbol using the optional collapsed parameter.

worksheet.set_column( 'H:H', nil, nil, 0, 0, 1 )

For a more complete example see the outline.rb and outline_collapsed.rb programs in the examples directory of the distro.

Excel allows up to 7 outline levels. Therefore the level parameter should be in the range 0 <= level <= 7.



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/write_xlsx/worksheet.rb', line 756

def set_column(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  if args[0] =~ /^\D/
    row1, firstcol, row2, lastcol, *data = substitute_cellref(*args)
  else
    firstcol, lastcol, *data = args
  end

  # Ensure at least firstcol, lastcol and width
  return unless firstcol && lastcol && !data.empty?

  # Assume second column is the same as first if 0. Avoids KB918419 bug.
  lastcol = firstcol unless ptrue?(lastcol)

  # Ensure 2nd col is larger than first. Also for KB918419 bug.
  firstcol, lastcol = lastcol, firstcol if firstcol > lastcol

  width, format, hidden, level = data

  # Check that cols are valid and store max and min values with default row.
  # NOTE: The check shouldn't modify the row dimensions and should only modify
  #       the column dimensions in certain cases.
  ignore_row = 1
  ignore_col = 1
  ignore_col = 0 if format.respond_to?(:xf_index)   # Column has a format.
  ignore_col = 0 if width && ptrue?(hidden)         # Column has a width but is hidden

  check_dimensions_and_update_max_min_values(0, firstcol, ignore_row, ignore_col)
  check_dimensions_and_update_max_min_values(0, lastcol,  ignore_row, ignore_col)

  # Set the limits for the outline levels (0 <= x <= 7).
  level ||= 0
  level = 0 if level < 0
  level = 7 if level > 7

  @outline_col_level = level if level > @outline_col_level

  # Store the column data.
  @colinfo.push([firstcol, lastcol] + data)

  # Store the column change to allow optimisations.
  @col_size_changed = 1

  # Store the col sizes for use when calculating image vertices taking
  # hidden columns into account. Also store the column formats.
  width  ||= 0                        # Ensure width isn't nil.
  width = 0 if ptrue?(hidden)         # Set width to zero if col is hidden

  (firstcol .. lastcol).each do |col|
    @col_sizes[col]   = width
    @col_formats[col] = format if format
  end
end

#set_comments_author(author = '') ⇒ Object

Set the default author of the cell comments.

This method is used to set the default author of all cell comments.

worksheet.set_comments_author('Ruby')

Individual comment authors can be set using the author parameter of the write_comment method.

The default comment author is an empty string, ”, if no author is specified.



4724
4725
4726
 
# File 'lib/write_xlsx/worksheet.rb', line 4724

def set_comments_author(author = '')
  @comments_author = author if author
end

#set_external_comment_links(comment_id) ⇒ Object

:nodoc:



4763
4764
4765
4766
 
# File 'lib/write_xlsx/worksheet.rb', line 4763

def set_external_comment_links(comment_id) # :nodoc:
  @external_comment_links <<
    ['/comments',   "../comments#{comment_id}.xml"]
end

#set_external_vml_links(comment_id) ⇒ Object

:nodoc:



4758
4759
4760
4761
 
# File 'lib/write_xlsx/worksheet.rb', line 4758

def set_external_vml_links(comment_id) # :nodoc:
  @external_vml_links <<
    ['/vmlDrawing', "../drawings/vmlDrawing#{comment_id}.vml"]
end

#set_first_sheet ⇒ Object

Set this worksheet as the first visible sheet. This is necessary when there are a large number of worksheets and the activated worksheet is not visible on the screen.

The activate() method determines which worksheet is initially selected. However, if there are a large number of worksheets the selected worksheet may not appear on the screen. To avoid this you can select which is the leftmost visible worksheet using set_first_sheet():

20.times { workbook.add_worksheet }

worksheet21 = workbook.add_worksheet
worksheet22 = workbook.add_worksheet

worksheet21.set_first_sheet
worksheet22.activate

This method is not required very often. The default value is the first worksheet.



578
579
580
581
 
# File 'lib/write_xlsx/worksheet.rb', line 578

def set_first_sheet
  @hidden = false
  @workbook.firstsheet = self
end

#set_footer(string = '', margin = 0.3) ⇒ Object

Set the page footer caption and optional margin.

The syntax of the set_footer() method is the same as set_header()



1242
1243
1244
1245
1246
1247
1248
 
# File 'lib/write_xlsx/worksheet.rb', line 1242

def set_footer(string = '', margin = 0.3)
  raise 'Footer string must be less than 255 characters' if string.length >= 255

  @footer                = string
  @print_style.margin_footer = margin
  @header_footer_changed = true
end

#set_h_pagebreaks(*args) ⇒ Object

Store the horizontal page breaks on a worksheet.

Add horizontal page breaks to a worksheet. A page break causes all the data that follows it to be printed on the next page. Horizontal page breaks act between rows. To create a page break between rows 20 and 21 you must specify the break at row 21. However in zero index notation this is actually row 20. So you can pretend for a small while that you are using 1 index notation:

worksheet1.set_h_pagebreaks( 20 )    # Break between row 20 and 21

The set_h_pagebreaks() method will accept a list of page breaks and you can call it more than once:

worksheet2.set_h_pagebreaks( 20,  40,  60,  80,  100 )    # Add breaks
worksheet2.set_h_pagebreaks( 120, 140, 160, 180, 200 )    # Add some more

Note: If you specify the “fit to page” option via the fit_to_pages() method it will override all manual page breaks.

There is a silent limitation of about 1000 horizontal page breaks per worksheet in line with an Excel internal limitation.



4656
4657
4658
4659
4660
4661
 
# File 'lib/write_xlsx/worksheet.rb', line 4656

def set_h_pagebreaks(*args)
  breaks = args.collect do |brk|
    brk.respond_to?(:to_a) ? brk.to_a : brk
  end.flatten
  @print_style.hbreaks += breaks
end

#set_header(string = '', margin = 0.3) ⇒ Object

Set the page header caption and optional margin.

Headers and footers are generated using a string which is a combination of plain text and control characters. The margin parameter is optional.

The available control character are:

Control             Category            Description
=======             ========            ===========
&L                  Justification       Left
&C                                      Center
&R                                      Right

&P                  Information         Page number
&N                                      Total number of pages
&D                                      Date
&T                                      Time
&F                                      File name
&A                                      Worksheet name
&Z                                      Workbook path

&fontsize           Font                Font size
&"font,style"                           Font name and style
&U                                      Single underline
&E                                      Double underline
&S                                      Strikethrough
&X                                      Superscript
&Y                                      Subscript

&&                  Miscellaneous       Literal ampersand &

Text in headers and footers can be justified (aligned) to the left, center and right by prefixing the text with the control characters &L, &C and &R.

For example (with ASCII art representation of the results):

worksheet.set_header('&LHello')

 ---------------------------------------------------------------
|                                                               |
| Hello                                                         |
|                                                               |

worksheet.set_header('&CHello')

 ---------------------------------------------------------------
|                                                               |
|                          Hello                                |
|                                                               |

worksheet.set_header('&RHello')

 ---------------------------------------------------------------
|                                                               |
|                                                         Hello |
|                                                               |

For simple text, if you do not specify any justification the text will be centred. However, you must prefix the text with &C if you specify a font name or any other formatting:

worksheet.set_header('Hello')

 ---------------------------------------------------------------
|                                                               |
|                          Hello                                |
|                                                               |

You can have text in each of the justification regions:

worksheet.set_header('&LCiao&CBello&RCielo')

 ---------------------------------------------------------------
|                                                               |
| Ciao                     Bello                          Cielo |
|                                                               |

The information control characters act as variables that Excel will update as the workbook or worksheet changes. Times and dates are in the users default format:

worksheet.set_header('&CPage &P of &N')

 ---------------------------------------------------------------
|                                                               |
|                        Page 1 of 6                            |
|                                                               |

worksheet.set_header('&CUpdated at &T')

 ---------------------------------------------------------------
|                                                               |
|                    Updated at 12:30 PM                        |
|                                                               |

You can specify the font size of a section of the text by prefixing it with the control character &n where n is the font size:

worksheet1.set_header('&C&30Hello Big' )
worksheet2.set_header('&C&10Hello Small' )

You can specify the font of a section of the text by prefixing it with the control sequence &“font,style” where fontname is a font name such as “Courier New” or “Times New Roman” and style is one of the standard Windows font descriptions: “Regular”, “Italic”, “Bold” or “Bold Italic”:

worksheet1.set_header('&C&"Courier New,Italic"Hello')
worksheet2.set_header('&C&"Courier New,Bold Italic"Hello')
worksheet3.set_header('&C&"Times New Roman,Regular"Hello')

It is possible to combine all of these features together to create sophisticated headers and footers. As an aid to setting up complicated headers and footers you can record a page set-up as a macro in Excel and look at the format strings that VBA produces. Remember however that VBA uses two double quotes “” to indicate a single double quote. For the last example above the equivalent VBA code looks like this:

.LeftHeader   = ""
.CenterHeader = "&""Times New Roman,Regular""Hello"
.RightHeader  = ""

To include a single literal ampersand & in a header or footer you should use a double ampersand &&:

worksheet1.set_header('&CCuriouser && Curiouser - Attorneys at Law')

As stated above the margin parameter is optional. As with the other margins the value should be in inches. The default header and footer margin is 0.3 inch. Note, the default margin is different from the default used in the binary file format by Spreadsheet::WriteExcel. The header and footer margin size can be set as follows:

worksheet.set_header('&CHello', 0.75)

The header and footer margins are independent of the top and bottom margins.

Note, the header or footer string must be less than 255 characters. Strings longer than this will not be written and a warning will be generated.

See, also the headers.rb program in the examples directory of the distribution.



1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/write_xlsx/worksheet.rb', line 1229

def set_header(string = '', margin = 0.3)
  raise 'Header string must be less than 255 characters' if string.length >= 255

  @header                = string
  @print_style.margin_header = margin
  @header_footer_changed = true
end

#set_landscape ⇒ Object

Set the page orientation as landscape.



977
978
979
980
 
# File 'lib/write_xlsx/worksheet.rb', line 977

def set_landscape
  @print_style.orientation         = false
  @print_style.page_setup_changed  = true
end

#set_margin_bottom(margin = 0.75) ⇒ Object

this method is deprecated. use margin_bottom=() Set the bottom margin in inches. See set_margins



1425
1426
1427
1428
 
# File 'lib/write_xlsx/worksheet.rb', line 1425

def set_margin_bottom(margin = 0.75)
  put_deprecate_message("#{self}.set_margin_bottom")
  self::margin_bottom = margin
end

#set_margin_left(margin = 0.7) ⇒ Object

this method is deprecated. use margin_left=() Set the left margin in inches. See set_margins



1395
1396
1397
1398
 
# File 'lib/write_xlsx/worksheet.rb', line 1395

def set_margin_left(margin = 0.7)
  put_deprecate_message("#{self}.set_margin_left")
  self::margin_left = margin
end

#set_margin_right(margin = 0.7) ⇒ Object

this method is deprecated. use margin_right=() Set the right margin in inches. See set_margins



1405
1406
1407
1408
 
# File 'lib/write_xlsx/worksheet.rb', line 1405

def set_margin_right(margin = 0.7)
  put_deprecate_message("#{self}.set_margin_right")
  self::margin_right = margin
end

#set_margin_top(margin = 0.75) ⇒ Object

this method is deprecated. use margin_top=() Set the top margin in inches. See set_margins



1415
1416
1417
1418
 
# File 'lib/write_xlsx/worksheet.rb', line 1415

def set_margin_top(margin = 0.75)
  put_deprecate_message("#{self}.set_margin_top")
  self::margin_top = margin
end

#set_margins(margin) ⇒ Object

set_margin_* methods are deprecated. use margin_*=().

Set all the page margins to the same value in inches.

There are several methods available for setting the worksheet margins on the printed page:

set_margins()        # Set all margins to the same value
set_margins_LR()     # Set left and right margins to the same value
set_margins_TB()     # Set top and bottom margins to the same value
set_margin_left()    # Set left margin
set_margin_right()   # Set right margin
set_margin_top()     # Set top margin
set_margin_bottom()  # Set bottom margin

All of these methods take a distance in inches as a parameter. Note: 1 inch = 25.4mm. ;-) The default left and right margin is 0.7 inch. The default top and bottom margin is 0.75 inch. Note, these defaults are different from the defaults used in the binary file format by writeexcel gem.



1365
1366
1367
1368
 
# File 'lib/write_xlsx/worksheet.rb', line 1365

def set_margins(margin)
  put_deprecate_message("#{self}.set_margins")
  self::margin = margin
end

#set_margins_LR(margin) ⇒ Object

this method is deprecated. use margin_left_right=(). Set the left and right margins to the same value in inches. See set_margins



1375
1376
1377
1378
 
# File 'lib/write_xlsx/worksheet.rb', line 1375

def set_margins_LR(margin)
  put_deprecate_message("#{self}.set_margins_LR")
  self::margins_left_right = margin
end

#set_margins_TB(margin) ⇒ Object

this method is deprecated. use margin_top_bottom=(). Set the top and bottom margins to the same value in inches. See set_margins



1385
1386
1387
1388
 
# File 'lib/write_xlsx/worksheet.rb', line 1385

def set_margins_TB(margin)
  put_deprecate_message("#{self}.set_margins_TB")
  self::margins_top_bottom = margin
end

#set_page_view(flag = true) ⇒ Object

This method is used to display the worksheet in “Page View/Layout” mode.



985
986
987
 
# File 'lib/write_xlsx/worksheet.rb', line 985

def set_page_view(flag = true)
  @page_view = !!flag
end

#set_paper(paper_size) ⇒ Object 



1075
1076
1077
1078
 
# File 'lib/write_xlsx/worksheet.rb', line 1075

def set_paper(paper_size)
  put_deprecate_message("#{self}.set_paper")
  self::paper = paper_size
end

#set_portrait ⇒ Object

Set the page orientation as portrait. The default worksheet orientation is portrait, so you won’t generally need to call this method.



969
970
971
972
 
# File 'lib/write_xlsx/worksheet.rb', line 969

def set_portrait
  @print_style.orientation        = true
  @print_style.page_setup_changed = true
end

#set_print_scale(scale = 100) ⇒ Object

This method is deprecated. use print_scale=().



1566
1567
1568
1569
 
# File 'lib/write_xlsx/worksheet.rb', line 1566

def set_print_scale(scale = 100)
  put_deprecate_message("#{self}.set_print_scale")
  self::print_scale = (scale)
end

#set_row(*args) ⇒ Object

:call-seq:

set_row(row [ , height, format, hidden, level, collapsed ] )

This method can be used to change the default properties of a row. All parameters apart from row are optional.

The most common use for this method is to change the height of a row:

worksheet.set_row(0, 20)    # Row 1 height set to 20

If you wish to set the format without changing the height you can pass nil as the height parameter:

worksheet.set_row(0, nil, format)

The format parameter will be applied to any cells in the row that don’t have a format. For example

worksheet.set_row(0, nil, format1)      # Set the format for row 1
worksheet.write('A1', 'Hello')          # Defaults to format1
worksheet.write('B1', 'Hello', format2) # Keeps format2

If you wish to define a row format in this way you should call the method before any calls to write(). Calling it afterwards will overwrite any format that was previously specified.

The hidden parameter should be set to 1 if you wish to hide a row. This can be used, for example, to hide intermediary steps in a complicated calculation:

worksheet.set_row(0, 20,  format, 1)
worksheet.set_row(1, nil, nil,    1)

The level parameter is used to set the outline level of the row. Outlines are described in “OUTLINES AND GROUPING IN EXCEL”. Adjacent rows with the same outline level are grouped together into a single outline.

The following example sets an outline level of 1 for rows 1 and 2 (zero-indexed):

worksheet.set_row(1, nil, nil, 0, 1)
worksheet.set_row(2, nil, nil, 0, 1)

The hidden parameter can also be used to hide collapsed outlined rows when used in conjunction with the level parameter.

worksheet.set_row(1, nil, nil, 1, 1)
worksheet.set_row(2, nil, nil, 1, 1)

For collapsed outlines you should also indicate which row has the collapsed + symbol using the optional collapsed parameter.

worksheet.set_row(3, nil, nil, 0, 0, 1)

For a more complete example see the outline.rb and outline_collapsed.rb programs in the examples directory of the distro.

Excel allows up to 7 outline levels. Therefore the level parameter should be in the range 0 <= level <= 7.



2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
 
# File 'lib/write_xlsx/worksheet.rb', line 2968

def set_row(*args)
  row = args[0]
  height = args[1] || 15
  xf     = args[2]
  hidden = args[3] || 0
  level  = args[4] || 0
  collapsed = args[5] || 0

  return if row.nil?

  # Use min col in check_dimensions. Default to 0 if undefined.
  min_col = @dim_colmin || 0

  # Check that row and col are valid and store max and min values.
  check_dimensions(row, min_col)
  store_row_col_max_min_values(row, min_col)

  # If the height is 0 the row is hidden and the height is the default.
  if height == 0
    hidden = 1
    height = 15
  end

  # Set the limits for the outline levels (0 <= x <= 7).
  level = 0 if level < 0
  level = 7 if level > 7

  @outline_row_level = level if level > @outline_row_level

  # Store the row properties.
  @set_rows[row] = [height, xf, hidden, level, collapsed]

  # Store the row change to allow optimisations.
  @row_size_changed = true

  # Store the row sizes for use when calculating image vertices.
  @row_sizes[row] = height
end

#set_selection(*args) ⇒ Object

:call-seq:

set_selection(cell_or_cell_range)

Set which cell or cells are selected in a worksheet.

This method can be used to specify which cell or cells are selected in a worksheet. The most common requirement is to select a single cell, in which case last_row and last_col can be omitted. The active cell within a selected range is determined by the order in which first and last are specified. It is also possible to specify a cell or a range using A1 notation. See the note about “Cell notation”.

Examples:

worksheet1.set_selection(3, 3)          # 1. Cell D4.
worksheet2.set_selection(3, 3, 6, 6)    # 2. Cells D4 to G7.
worksheet3.set_selection(6, 6, 3, 3)    # 3. Cells G7 to D4.
worksheet4.set_selection('D4')          # Same as 1.
worksheet5.set_selection('D4:G7')       # Same as 2.
worksheet6.set_selection('G7:D4')       # Same as 3.

The default cell selections is (0, 0), ‘A1’.



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/write_xlsx/worksheet.rb', line 834

def set_selection(*args)
  return if args.empty?

  row_first, col_first, row_last, col_last = row_col_notation(args)
  active_cell = xl_rowcol_to_cell(row_first, col_first)

  if row_last.nil?   # Single cell selection.
    sqref = active_cell
  else               # Range selection.
    # Swap last row/col for first row/col as necessary
    row_first, row_last = row_last, row_first if row_first > row_last
    col_first, col_last = col_last, col_first if col_first > col_last

    # If the first and last cell are the same write a single cell.
    if row_first == row_last && col_first == col_last
      sqref = active_cell
    else
      sqref = xl_range(row_first, col_first, row_last, col_last)
    end
  end

  # Selection isn't set for cell A1.
  return if sqref == 'A1'

  @selections = [ [ nil, active_cell, sqref ] ]
end

#set_start_page(page_start) ⇒ Object

Not implememt yet. – The set_start_page() method is used to set the number of the starting page when the worksheet is printed out. The default value is 1.

worksheet.set_start_page(2)

++



1640
1641
1642
1643
 
# File 'lib/write_xlsx/worksheet.rb', line 1640

def set_start_page(page_start)
  @page_start   = page_start
  @custom_start = 1
end

#set_tab_color(color) ⇒ Object

Set the colour of the worksheet tab.

The set_tab_color() method is used to change the colour of the worksheet tab. This feature is only available in Excel 2002 and later. You can use one of the standard colour names provided by the Format object or a colour index. See “COLOURS IN EXCEL” and the set_custom_color() method.

worksheet1.set_tab_color('red')
worksheet2.set_tab_color(0x0C)

See the tab_colors.rb program in the examples directory of the distro.



1002
1003
1004
 
# File 'lib/write_xlsx/worksheet.rb', line 1002

def set_tab_color(color)
  @tab_color = Colors.new.get_color(color)
end

#set_v_pagebreaks(*args) ⇒ Object

Store the vertical page breaks on a worksheet.

Add vertical page breaks to a worksheet. A page break causes all the data that follows it to be printed on the next page. Vertical page breaks act between columns. To create a page break between columns 20 and 21 you must specify the break at column 21. However in zero index notation this is actually column 20. So you can pretend for a small while that you are using 1 index notation:

worksheet1.set_v_pagebreaks(20) # Break between column 20 and 21

The set_v_pagebreaks() method will accept a list of page breaks and you can call it more than once:

worksheet2.set_v_pagebreaks( 20,  40,  60,  80,  100 )    # Add breaks
worksheet2.set_v_pagebreaks( 120, 140, 160, 180, 200 )    # Add some more

Note: If you specify the “fit to page” option via the fit_to_pages() method it will override all manual page breaks.



4684
4685
4686
 
# File 'lib/write_xlsx/worksheet.rb', line 4684

def set_v_pagebreaks(*args)
  @print_style.vbreaks += args
end

#set_vml_data_id(vml_data_id) ⇒ Object

Turn the HoH that stores the comments into an array for easier handling and set the external links.



4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
 
# File 'lib/write_xlsx/worksheet.rb', line 4744

def set_vml_data_id(vml_data_id) # :nodoc:
  count = @comments.sorted_comments.size
  start_data_id = vml_data_id

  # The VML o:idmap data id contains a comma separated range when there is
  # more than one 1024 block of comments, like this: data="1,2".
  (1 .. (count / 1024)).each do |i|
    vml_data_id = "#{vml_data_id},#{start_data_id + i}"
  end
  @vml_data_id = vml_data_id

  count
end

#set_xml_writer(filename) ⇒ Object

:nodoc:



432
433
434
 
# File 'lib/write_xlsx/worksheet.rb', line 432

def set_xml_writer(filename) #:nodoc:
  @writer.set_xml_writer(filename)
end

#set_zoom(scale = 100) ⇒ Object

Set the worksheet zoom factor.



1523
1524
1525
1526
1527
1528
1529
1530
1531
 
# File 'lib/write_xlsx/worksheet.rb', line 1523

def set_zoom(scale = 100)
  # Confine the scale to Excel's range
  if scale < 10 or scale > 400
    # carp "Zoom factor scale outside range: 10 <= zoom <= 400"
    scale = 100
  end

  @zoom = scale.to_i
end

#show_comments(visible = true) ⇒ Object

Make any comments in the worksheet visible.

This method is used to make all cell comments visible when a worksheet is opened.

worksheet.show_comments

Individual comments can be made visible using the visible parameter of the write_comment method (see above):

worksheet.write_comment('C3', 'Hello', :visible => 1)

If all of the cell comments have been made visible you can hide individual comments as follows:

worksheet.show_comments
worksheet.write_comment('C3', 'Hello', :visible => 0)



4707
4708
4709
 
# File 'lib/write_xlsx/worksheet.rb', line 4707

def show_comments(visible = true)
  @comments_visible = visible
end

#split_panes(*args) ⇒ Object

:call-seq:

split_panes(y, x, top_row, left_col, offset_row, offset_col)

Set panes and mark them as split. – Implementers note. The API for this method doesn’t map well from the XLS file format and isn’t sufficient to describe all cases of split panes. It should probably be something like:

split_panes(y, x, top_row, left_col, offset_row, offset_col)

I’ll look at changing this if it becomes an issue. ++ This method can be used to divide a worksheet into horizontal or vertical regions known as panes. This method is different from the freeze_panes() method in that the splits between the panes will be visible to the user and each pane will have its own scroll bars.

The parameters y and x are used to specify the vertical and horizontal position of the split. The units for y and x are the same as those used by Excel to specify row height and column width. However, the vertical and horizontal units are different from each other. Therefore you must specify the y and x parameters in terms of the row heights and column widths that you have set or the default values which are 15 for a row and 8.43 for a column.

You can set one of the y and x parameters as zero if you do not want either a vertical or horizontal split. The parameters top_row and left_col are optional. They are used to specify the top-most or left-most visible row or column in the bottom-right pane.

Example:

worksheet.split_panes(15, 0   )    # First row
worksheet.split_panes( 0, 8.43)    # First column
worksheet.split_panes(15, 8.43)    # First row and column

You cannot use A1 notation with this method.

See also the freeze_panes() method and the panes.rb program in the examples directory of the distribution.



959
960
961
962
 
# File 'lib/write_xlsx/worksheet.rb', line 959

def split_panes(*args)
  # Call freeze panes but add the type flag for split panes.
  freeze_panes(args[0], args[1], args[2], args[3], 2)
end

#store_formula(string) ⇒ Object

Deprecated. This is a writeexcel method that is no longer required by WriteXLSX. See below.



2537
2538
2539
 
# File 'lib/write_xlsx/worksheet.rb', line 2537

def store_formula(string)
  string.split(/(\$?[A-I]?[A-Z]\$?\d+)/)
end

#write(*args) ⇒ Object

:call-seq:

write(row, column [ , token [ , format ] ])

Excel makes a distinction between data types such as strings, numbers, blanks, formulas and hyperlinks. To simplify the process of writing data the write() method acts as a general alias for several more specific methods:

write_string
write_number
write_blank
write_formula
write_url
write_row
write_col

The general rule is that if the data looks like a something then a something is written. Here are some examples in both row-column and A1 notation:

                                                # Same as:
worksheet.write(0, 0, 'Hello'                ) # write_string()
worksheet.write(1, 0, 'One'                  ) # write_string()
worksheet.write(2, 0,  2                     ) # write_number()
worksheet.write(3, 0,  3.00001               ) # write_number()
worksheet.write(4, 0,  ""                    ) # write_blank()
worksheet.write(5, 0,  ''                    ) # write_blank()
worksheet.write(6, 0,  nil                   ) # write_blank()
worksheet.write(7, 0                         ) # write_blank()
worksheet.write(8, 0,  'http://www.ruby.com/') # write_url()
worksheet.write('A9',  'ftp://ftp.ruby.org/' ) # write_url()
worksheet.write('A10', 'internal:Sheet1!A1'  ) # write_url()
worksheet.write('A11', 'external:c:\foo.xlsx') # write_url()
worksheet.write('A12', '=A3 + 3*A4'          ) # write_formula()
worksheet.write('A13', '=SIN(PI()/4)'        ) # write_formula()
worksheet.write('A14', [1, 2]                ) # write_row()
worksheet.write('A15', [ [1, 2] ]            ) # write_col()

# Write an array formula. Not available in writeexcel gem.
worksheet.write('A16', '{=SUM(A1:B1*A2:B2)}' ) # write_formula()

The format parameter is optional. It should be a valid Format object.

format = workbook.add_format
format.set_bold
format.set_color('red')
format.set_align('center')

worksheet.write(4, 0, 'Hello', format)    # Formatted string

The write() method will ignore empty strings or nil tokens unless a format is also supplied. As such you needn’t worry about special handling for empty or nil in your data. See also the write_blank() method.

One problem with the write() method is that occasionally data looks like a number but you don’t want it treated as a number. For example, zip codes or ID numbers often start with a leading zero. If you want to write this data with leading zero(s), use write_string.

The write methods return:

0 for success.



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'lib/write_xlsx/worksheet.rb', line 1708

def write(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  token = row_col_notation(args)[2] || ''

  # Match an array ref.
  if token.respond_to?(:to_ary)
    write_row(*args)
  elsif token.respond_to?(:coerce)  # Numeric
    write_number(*args)
  elsif token =~ /^\d+$/
    write_number(*args)
  # Match http, https or ftp URL
  elsif token =~ %r|^[fh]tt?ps?://|
    write_url(*args)
  # Match mailto:
  elsif token =~ %r|^mailto:|
    write_url(*args)
  # Match internal or external sheet link
  elsif token =~ %r!^(?:in|ex)ternal:!
    write_url(*args)
  # Match formula
  elsif token =~ /^=/
    write_formula(*args)
  # Match array formula
  elsif token =~ /^\{=.*\}$/
    write_formula(*args)
  # Match blank
  elsif token == ''
    args.delete_at(2)     # remove the empty string from the parameter list
    write_blank(*args)
  else
    write_string(*args)
  end
end

#write_array_formula(*args) ⇒ Object

:call-seq:

write_array_formula(row1, col1, row2, col2, formula [ , format [ , value ] ] )

Write an array formula to the specified row and column (zero indexed).

format is optional.

In Excel an array formula is a formula that performs a calculation on a set of values. It can return a single value or a range of values.

An array formula is indicated by a pair of braces around the formula: =SUM(A1:B1*A2:B2). If the array formula returns a single value then the first and last parameters should be the same:

worksheet.write_array_formula('A1:A1', '{=SUM(B1:C1*B2:C2)}')

It this case however it is easier to just use the write_formula() or write() methods:

# Same as above but more concise.
worksheet.write('A1', '{=SUM(B1:C1*B2:C2)}')
worksheet.write_formula('A1', '{=SUM(B1:C1*B2:C2)}')

For array formulas that return a range of values you must specify the range that the return values will be written to:

worksheet.write_array_formula('A1:A3',    '{=TREND(C1:C3,B1:B3)}')
worksheet.write_array_formula(0, 0, 2, 0, '{=TREND(C1:C3,B1:B3)}')

If required, it is also possible to specify the calculated value of the formula. This is occasionally necessary when working with non-Excel applications that don’t calculate the value of the formula. The calculated value is added at the end of the argument list:

worksheet.write_array_formula('A1:A3', '{=TREND(C1:C3,B1:B3)}', format, 105)

In addition, some early versions of Excel 2007 don’t calculate the values of array formulas when they aren’t supplied. Installing the latest Office Service Pack should fix this issue.

See also the array_formula.rb program in the examples directory of the distro.

Note: Array formulas are not supported by writeexcel gem.

Raises:



2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
 
# File 'lib/write_xlsx/worksheet.rb', line 2458

def write_array_formula(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row1, col1, row2, col2, formula, xf, value = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row1, col1, row2, col2, formula].include?(nil)

  # Swap last row/col with first row/col as necessary
  row1, row2 = row2, row1 if row1 > row2
  col1, col2 = col2, col1 if col1 > col2

  # Check that row and col are valid and store max and min values
  check_dimensions(row2, col2)
  store_row_col_max_min_values(row2, col2)

  # Define array range
  if row1 == row2 && col1 == col2
    range = xl_rowcol_to_cell(row1, col1)
  else
    range ="#{xl_rowcol_to_cell(row1, col1)}:#{xl_rowcol_to_cell(row2, col2)}"
  end

  # Remove array formula braces and the leading =.
  formula.sub!(/^\{(.*)\}$/, '\1')
  formula.sub!(/^=/, '')

  store_data_to_table(FormulaArrayCellData.new(self, row1, col1, formula, xf, range, value))

  # Pad out the rest of the area with formatted zeroes.
  (row1..row2).each do |row|
    (col1..col2).each do |col|
      next if row == row1 && col == col1
      write_number(row, col, 0, xf)
    end
  end
end

#write_blank(*args) ⇒ Object

:call-seq:

write_blank(row, col, format)

Write a blank cell to the specified row and column (zero indexed). A blank cell is used to specify formatting without adding a string or a number.

A blank cell without a format serves no purpose. Therefore, we don’t write a BLANK record unless a format is specified. This is mainly an optimisation for the write_row() and write_col() methods.

Excel differentiates between an “Empty” cell and a “Blank” cell. An “Empty” cell is a cell which doesn’t contain data whilst a “Blank” cell is a cell which doesn’t contain data but does contain formatting. Excel stores “Blank” cells but ignores “Empty” cells.

As such, if you write an empty cell without formatting it is ignored:

worksheet.write('A1', nil, format )    # write_blank()
worksheet.write('A2', nil )            # Ignored

This seemingly uninteresting fact means that you can write arrays of data without special treatment for nil or empty string values.

See the note about “Cell notation”.

Raises:



2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
 
# File 'lib/write_xlsx/worksheet.rb', line 2350

def write_blank(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, xf = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col].include?(nil)

  # Don't write a blank cell unless it has a format
  return unless xf

  # Check that row and col are valid and store max and min values
  check_dimensions(row, col)
  store_row_col_max_min_values(row, col)

  store_data_to_table(BlankCellData.new(self, row, col,  nil, xf))
end

#write_cell_array_formula(formula, range) ⇒ Object

Write the cell array formula <f> element.



4968
4969
4970
4971
4972
 
# File 'lib/write_xlsx/worksheet.rb', line 4968

def write_cell_array_formula(formula, range) #:nodoc:
  attributes = ['t', 'array', 'ref', range]

  @writer.data_element('f', formula, attributes)
end

#write_cell_formula(formula = '') ⇒ Object

Write the cell formula <f> element.



4961
4962
4963
 
# File 'lib/write_xlsx/worksheet.rb', line 4961

def write_cell_formula(formula = '') #:nodoc:
  @writer.data_element('f', formula)
end

#write_cell_value(value = '') ⇒ Object

Write the cell value <v> element.



4952
4953
4954
4955
4956
 
# File 'lib/write_xlsx/worksheet.rb', line 4952

def write_cell_value(value = '') #:nodoc:
  value ||= ''
  value = value.to_i if value == value.to_i
  @writer.data_element('v', value)
end

#write_col(*args) ⇒ Object

:call-seq:

write_col(row, col, array [ , format ] )

Write a column of data starting from (row, col). Call write_row() if any of the elements of the array are in turn array. This allows the writing of 1D or 2D arrays of data in one go.

The write_col() method can be used to write a 1D or 2D array of data in one go. This is useful for converting the results of a database query into an Excel worksheet. You must pass a reference to the array of data rather than the array itself. The write() method is then called for each element of the data. For example:

array = [ 'awk', 'gawk', 'mawk' ]

worksheet.write_col(0, 0, array)

# The above example is equivalent to:
worksheet.write(0, 0, array[0])
worksheet.write(1, 0, array[1])
worksheet.write(2, 0, array[2])

As with all of the write methods the format parameter is optional. If a format is specified it is applied to all the elements of the data array.

Array references within the data will be treated as rows. This allows you to write 2D arrays of data in one go. For example:

eec =  [
            ['maggie', 'milly', 'molly', 'may'  ],
            [13,       14,      15,      16     ],
            ['shell',  'star',  'crab',  'stone']
       ]

worksheet.write_col('A1', eec)

Would produce a worksheet as follows:

 -----------------------------------------------------------
|   |    A    |    B    |    C    |    D    |    E    | ...
 -----------------------------------------------------------
| 1 | maggie  | milly   | molly   | may     |  ...    | ...
| 2 | 13      | 14      | 15      | 16      |  ...    | ...
| 3 | shell   | star    | crab    | stone   |  ...    | ...
| 4 | ...     | ...     | ...     | ...     |  ...    | ...
| 5 | ...     | ...     | ...     | ...     |  ...    | ...
| 6 | ...     | ...     | ...     | ...     |  ...    | ...

To write the data in a column-row order refer to the write_row() method above.

Any nil in the data will be ignored unless a format is applied to the data, in which case a formatted blank cell will be written. In either case the appropriate row or column value will still be incremented.

As noted above the write() method can be used as a synonym for write_row() and write_row() handles nested array refs as columns. Therefore, the following two method calls are equivalent although the more explicit call to write_col() would be preferable for maintainability:

worksheet.write_col('A1', array     ) # Write a column of data
worksheet.write(    'A1', [ array ] ) # Same thing

The write_col() method returns the first error encountered when writing the elements of the data or zero if no errors were encountered. See the return values described for the write() method above.

See also the write_arrays.rb program in the examples directory of the distro.



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'lib/write_xlsx/worksheet.rb', line 1905

def write_col(*args)
  row, col, tokens, *options = row_col_notation(args)
  raise "Not an array ref in call to write_col()$!" unless tokens.respond_to?(:to_ary)

  tokens.each do |token|
    # write() will deal with any nested arrays
    write(row, col, token, *options)
    row += 1
  end
end

#write_comment(*args) ⇒ Object

:call-seq:

write_comment(row, column, string, options = {})

Write a comment to the specified row and column (zero indexed).

write_comment methods return:

Returns  0 : normal termination

The write_comment() method is used to add a comment to a cell. A cell comment is indicated in Excel by a small red triangle in the upper right-hand corner of the cell. Moving the cursor over the red triangle will reveal the comment.

The following example shows how to add a comment to a cell:

worksheet.write(        2, 2, 'Hello')
worksheet.write_comment(2, 2, 'This is a comment.')

As usual you can replace the row and column parameters with an A1 cell reference. See the note about “Cell notation”.

worksheet.write(        'C3', 'Hello')
worksheet.write_comment('C3', 'This is a comment.')

The write_comment() method will also handle strings in UTF-8 format.

worksheet.write_comment('C3', "\x{263a}")       # Smiley
worksheet.write_comment('C4', 'Comment ca va?')

In addition to the basic 3 argument form of write_comment() you can pass in several optional key/value pairs to control the format of the comment. For example:

worksheet.write_comment('C3', 'Hello', :visible => 1, :author => 'Perl')

Most of these options are quite specific and in general the default comment behaviour will be all that you need. However, should you need greater control over the format of the cell comment the following options are available:

:author
:visible
:x_scale
:width
:y_scale
:height
:color
:start_cell
:start_row
:start_col
:x_offset
:y_offset

Option: author

This option is used to indicate who is the author of the cell comment. Excel displays the author of the comment in the status bar at the bottom of the worksheet. This is usually of interest in corporate environments where several people might review and provide comments to a workbook.

worksheet.write_comment('C3', 'Atonement', :author => 'Ian McEwan')

The default author for all cell comments can be set using the set_comments_author() method.

worksheet.set_comments_author('Ruby')

Option: visible

This option is used to make a cell comment visible when the worksheet is opened. The default behaviour in Excel is that comments are initially hidden. However, it is also possible in Excel to make individual or all comments visible. In WriteXLSX individual comments can be made visible as follows:

worksheet.write_comment('C3', 'Hello', :visible => 1 )

It is possible to make all comments in a worksheet visible using the show_comments() worksheet method. Alternatively, if all of the cell comments have been made visible you can hide individual comments:

worksheet.write_comment('C3', 'Hello', :visible => 0)

Option: x_scale

This option is used to set the width of the cell comment box as a factor of the default width.

worksheet.write_comment('C3', 'Hello', :x_scale => 2)
worksheet.write_comment('C4', 'Hello', :x_scale => 4.2)

Option: width

This option is used to set the width of the cell comment box explicitly in pixels.

worksheet.write_comment('C3', 'Hello', :width => 200)

Option: y_scale

This option is used to set the height of the cell comment box as a factor of the default height.

worksheet.write_comment('C3', 'Hello', :y_scale => 2)
worksheet.write_comment('C4', 'Hello', :y_scale => 4.2)

Option: height

This option is used to set the height of the cell comment box explicitly in pixels.

worksheet.write_comment('C3', 'Hello', :height => 200)

Option: color

This option is used to set the background colour of cell comment box. You can use one of the named colours recognised by WriteXLSX or a colour index. See “COLOURS IN EXCEL”.

worksheet.write_comment('C3', 'Hello', :color => 'green')
worksheet.write_comment('C4', 'Hello', :color => 0x35)      # Orange

Option: start_cell

This option is used to set the cell in which the comment will appear. By default Excel displays comments one cell to the right and one cell above the cell to which the comment relates. However, you can change this behaviour if you wish. In the following example the comment which would appear by default in cell D2 is moved to E2.

worksheet.write_comment('C3', 'Hello', :start_cell => 'E2')

Option: start_row

This option is used to set the row in which the comment will appear. See the start_cell option above. The row is zero indexed.

worksheet.write_comment('C3', 'Hello', :start_row => 0)

Option: start_col

This option is used to set the column in which the comment will appear. See the start_cell option above. The column is zero indexed.

worksheet.write_comment('C3', 'Hello', :start_col => 4)

Option: x_offset

This option is used to change the x offset, in pixels, of a comment within a cell:

worksheet.write_comment('C3', comment, :x_offset => 30)

Option: y_offset

This option is used to change the y offset, in pixels, of a comment within a cell:

worksheet.write_comment('C3', comment, :x_offset => 30)

You can apply as many of these options as you require.

Note about using options that adjust the position of the cell comment such as start_cell, start_row, start_col, x_offset and y_offset: Excel only displays offset cell comments when they are displayed as “visible”. Excel does not display hidden cells as moved when you mouse over them.

Note about row height and comments. If you specify the height of a row that contains a comment then WriteXLSX will adjust the height of the comment to maintain the default or user specified dimensions. However, the height of a row can also be adjusted automatically by Excel if the text wrap property is set or large fonts are used in the cell. This means that the height of the row is unknown to the module at run time and thus the comment box is stretched with the row. Use the set_row() method to specify the row height explicitly and avoid this problem.

Raises:



2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
 
# File 'lib/write_xlsx/worksheet.rb', line 2096

def write_comment(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, string, options = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, string].include?(nil)

  # Check that row and col are valid and store max and min values
  check_dimensions(row, col)
  store_row_col_max_min_values(row, col)

  # Process the properties of the cell comment.
  @comments.add(Package::Comment.new(@workbook, self, row, col, string, options))
end

#write_date_time(*args) ⇒ Object

:call-seq:

write_date_time (row, col, date_string [ , format ] )

Write a datetime string in ISO8601 “yyyy-mm-ddThh:mm:ss.ss” format as a number representing an Excel date. format is optional.

The write_date_time() method can be used to write a date or time to the cell specified by row and column:

worksheet.write_date_time('A1', '2004-05-13T23:20', date_format)

The date_string should be in the following format:

yyyy-mm-ddThh:mm:ss.sss

This conforms to an ISO8601 date but it should be noted that the full range of ISO8601 formats are not supported.

The following variations on the date_string parameter are permitted:

yyyy-mm-ddThh:mm:ss.sss         # Standard format
yyyy-mm-ddT                     # No time
          Thh:mm:ss.sss         # No date
yyyy-mm-ddThh:mm:ss.sssZ        # Additional Z (but not time zones)
yyyy-mm-ddThh:mm:ss             # No fractional seconds
yyyy-mm-ddThh:mm                # No seconds

Note that the T is required in all cases.

A date should always have a format, otherwise it will appear as a number, see “DATES AND TIME IN EXCEL” and “CELL FORMATTING”. Here is a typical example:

date_format = workbook.add_format(:num_format => 'mm/dd/yy')
worksheet.write_date_time('A1', '2004-05-13T23:20', date_format)

Valid dates should be in the range 1900-01-01 to 9999-12-31, for the 1900 epoch and 1904-01-01 to 9999-12-31, for the 1904 epoch. As with Excel, dates outside these ranges will be written as a string.

See also the date_time.rb program in the examples directory of the distro.

Raises:



2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
 
# File 'lib/write_xlsx/worksheet.rb', line 2729

def write_date_time(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, str, xf = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, str].include?(nil)

  # Check that row and col are valid and store max and min values
  check_dimensions(row, col)
  store_row_col_max_min_values(row, col)

  date_time = convert_date_time(str)

  if date_time
    store_data_to_table(NumberCellData.new(self, row, col, date_time, xf))
  else
    # If the date isn't valid then write it as a string.
    write_string(*args)
  end
end

#write_formula(*args) ⇒ Object

:call-seq:

write_formula(row, column, formula [ , format [ , value ] ] )

Write a formula or function to the cell specified by row and column:

worksheet.write_formula(0, 0, '=$B$3 + B4')
worksheet.write_formula(1, 0, '=SIN(PI()/4)')
worksheet.write_formula(2, 0, '=SUM(B1:B5)')
worksheet.write_formula('A4', '=IF(A3>1,"Yes", "No")')
worksheet.write_formula('A5', '=AVERAGE(1, 2, 3, 4)')
worksheet.write_formula('A6', '=DATEVALUE("1-Jan-2001")')

Array formulas are also supported:

worksheet.write_formula('A7', '{=SUM(A1:B1*A2:B2)}')

See also the write_array_formula() method.

See the note about “Cell notation”. For more information about writing Excel formulas see “FORMULAS AND FUNCTIONS IN EXCEL”

If required, it is also possible to specify the calculated value of the formula. This is occasionally necessary when working with non-Excel applications that don’t calculate the value of the formula. The calculated value is added at the end of the argument list:

worksheet.write('A1', '=2+2', format, 4)

However, this probably isn’t something that will ever need to do. If you do use this feature then do so with care.

Raises:



2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
 
# File 'lib/write_xlsx/worksheet.rb', line 2396

def write_formula(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, formula, format, value = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, formula].include?(nil)

  if formula =~ /^\{=.*\}$/
    write_array_formula(row, col, row, col, formula, format, value)
  else
    check_dimensions(row, col)
    store_row_col_max_min_values(row, col)
    formula.sub!(/^=/, '')

    store_data_to_table(FormulaCellData.new(self, row, col, formula, format, value))
  end
end

#write_number(*args) ⇒ Object

:call-seq:

write_number(row, column, number [ , format ] )

Write an integer or a float to the cell specified by row and column:

worksheet.write_number(0, 0, 123456)
worksheet.write_number('A2', 2.3451)

See the note about “Cell notation”. The format parameter is optional.

In general it is sufficient to use the write() method.

Note: some versions of Excel 2007 do not display the calculated values of formulas written by WriteXLSX. Applying all available Service Packs to Excel should fix this.

Raises:



2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
 
# File 'lib/write_xlsx/worksheet.rb', line 2127

def write_number(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, num, xf = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, num].include?(nil)

  # Check that row and col are valid and store max and min values
  check_dimensions(row, col)
  store_row_col_max_min_values(row, col)

  store_data_to_table(NumberCellData.new(self, row, col, num, xf))
end

#write_rich_string(*args) ⇒ Object

:call-seq:

write_rich_string(row, column, (string | format, string)+,  [,cell_format] )

The write_rich_string() method is used to write strings with multiple formats. The method receives string fragments prefixed by format objects. The final format object is used as the cell format.

write_rich_string methods return:

For example to write the string “This is bold and this is italic” you would use the following:

bold   = workbook.add_format(:bold   => 1)
italic = workbook.add_format(:italic => 1)

worksheet.write_rich_string('A1',
    'This is ', bold, 'bold', ' and this is ', italic, 'italic')

The basic rule is to break the string into fragments and put a format object before the fragment that you want to format. For example:

# Unformatted string.
  'This is an example string'

# Break it into fragments.
  'This is an ', 'example', ' string'

# Add formatting before the fragments you want formatted.
  'This is an ', format, 'example', ' string'

# In WriteXLSX.
worksheet.write_rich_string('A1',
    'This is an ', format, 'example', ' string')

String fragments that don’t have a format are given a default format. So for example when writing the string “Some bold text” you would use the first example below but it would be equivalent to the second:

# With default formatting:
bold    = workbook.add_format(:bold => 1)

worksheet.write_rich_string('A1',
    'Some ', bold, 'bold', ' text')

# Or more explicitly:
bold    = workbook.add_format(:bold => 1)
default = workbook.add_format

worksheet.write_rich_string('A1',
    default, 'Some ', bold, 'bold', default, ' text')

As with Excel, only the font properties of the format such as font name, style, size, underline, color and effects are applied to the string fragments. Other features such as border, background and alignment must be applied to the cell.

The write_rich_string() method allows you to do this by using the last argument as a cell format (if it is a format object). The following example centers a rich string in the cell:

bold   = workbook.add_format(:bold  => 1)
center = workbook.add_format(:align => 'center')

worksheet.write_rich_string('A5',
    'Some ', bold, 'bold text', ' centered', center)

See the rich_strings.rb example in the distro for more examples.

bold   = workbook.add_format(:bold        => 1)
italic = workbook.add_format(:italic      => 1)
red    = workbook.add_format(:color       => 'red')
blue   = workbook.add_format(:color       => 'blue')
center = workbook.add_format(:align       => 'center')
super  = workbook.add_format(:font_script => 1)

# Write some strings with multiple formats.
worksheet.write_rich_string('A1',
    'This is ', bold, 'bold', ' and this is ', italic, 'italic')

worksheet.write_rich_string('A3',
    'This is ', red, 'red', ' and this is ', blue, 'blue')

worksheet.write_rich_string('A5',
    'Some ', bold, 'bold text', ' centered', center)

worksheet.write_rich_string('A7',
    italic, 'j = k', super, '(n-1)', center)

As with write_sting() the maximum string size is 32767 characters. See also the note about “Cell notation”.

Raises:



2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
 
# File 'lib/write_xlsx/worksheet.rb', line 2274

def write_rich_string(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, *rich_strings = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, rich_strings[0]].include?(nil)

  # If the last arg is a format we use it as the cell format.
  if rich_strings[-1].respond_to?(:xf_index)
    xf = rich_strings.pop
  else
    xf = nil
  end

  # Check that row and col are valid and store max and min values
  check_dimensions(row, col)
  store_row_col_max_min_values(row, col)

  # Create a temp XML::Writer object and use it to write the rich string
  # XML to a string.
  writer = Package::XMLWriterSimple.new

  fragments, length = rich_strings_fragments(rich_strings)
  # can't allow 2 formats in a row
  return -4 unless fragments

  # If the first token is a string start the <r> element.
  writer.start_tag('r') if !fragments[0].respond_to?(:xf_index)

  # Write the XML elements for the format string fragments.
  fragments.each do |token|
    if token.respond_to?(:xf_index)
      # Write the font run.
      writer.start_tag('r')
      write_font(writer, token)
    else
      # Write the string fragment part, with whitespace handling.
      attributes = []

      attributes << 'xml:space' << 'preserve' if token =~ /^\s/ || token =~ /\s$/
      writer.data_element('t', token, attributes)
      writer.end_tag('r')
    end
  end

  # Add the XML string to the shared string table.
  index = shared_string_index(writer.string)

  store_data_to_table(StringCellData.new(self, row, col, index, xf))
end

#write_row(*args) ⇒ Object

:call-seq:

write_row(row, col, array [ , format ] )

Write a row of data starting from (row, col). Call write_col() if any of the elements of the array are in turn array. This allows the writing of 1D or 2D arrays of data in one go.

The write_row() method can be used to write a 1D or 2D array of data in one go. This is useful for converting the results of a database query into an Excel worksheet. You must pass a reference to the array of data rather than the array itself. The write() method is then called for each element of the data. For example:

array = ['awk', 'gawk', 'mawk']

worksheet.write_row(0, 0, array)

# The above example is equivalent to:
worksheet.write(0, 0, array[0])
worksheet.write(0, 1, array[1])
worksheet.write(0, 2, array[2])

Note: For convenience the write() method behaves in the same way as write_row() if it is passed an array reference. Therefore the following two method calls are equivalent:

worksheet.write_row('A1', array)    # Write a row of data
worksheet.write(    'A1', array)    # Same thing

As with all of the write methods the format parameter is optional. If a format is specified it is applied to all the elements of the data array.

Array references within the data will be treated as columns. This allows you to write 2D arrays of data in one go. For example:

eec =  [
            ['maggie', 'milly', 'molly', 'may'  ],
            [13,       14,      15,      16     ],
            ['shell',  'star',  'crab',  'stone']
       ]

worksheet.write_row('A1', eec)

Would produce a worksheet as follows:

 -----------------------------------------------------------
|   |    A    |    B    |    C    |    D    |    E    | ...
 -----------------------------------------------------------
| 1 | maggie  | 13      | shell   | ...     |  ...    | ...
| 2 | milly   | 14      | star    | ...     |  ...    | ...
| 3 | molly   | 15      | crab    | ...     |  ...    | ...
| 4 | may     | 16      | stone   | ...     |  ...    | ...
| 5 | ...     | ...     | ...     | ...     |  ...    | ...
| 6 | ...     | ...     | ...     | ...     |  ...    | ...

To write the data in a row-column order refer to the write_col() method below.

Any nil in the data will be ignored unless a format is applied to the data, in which case a formatted blank cell will be written. In either case the appropriate row or column value will still be incremented.

The write_row() method returns the first error encountered when writing the elements of the data or zero if no errors were encountered. See the return values described for the write() method.

See also the write_arrays.rb program in the examples directory of the distro.



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'lib/write_xlsx/worksheet.rb', line 1815

def write_row(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, tokens, *options = row_col_notation(args)
  raise "Not an array ref in call to write_row()$!" unless tokens.respond_to?(:to_ary)

  tokens.each do |token|
    # Check for nested arrays
    if token.respond_to?(:to_ary)
      write_col(row, col, token, *options)
    else
      write(row, col, token, *options)
    end
    col += 1
  end
end

#write_string(*args) ⇒ Object

:call-seq:

write_string(row, column, string [, format ] )

Write a string to the specified row and column (zero indexed). format is optional.

worksheet.write_string(0, 0, 'Your text here')
worksheet.write_string('A2', 'or here')

The maximum string size is 32767 characters. However the maximum string segment that Excel can display in a cell is 1000. All 32767 characters can be displayed in the formula bar.

In general it is sufficient to use the write() method. However, you may sometimes wish to use the write_string() method to write data that looks like a number but that you don’t want treated as a number. For example, zip codes or phone numbers:

# Write as a plain string
worksheet.write_string('A1', '01209')

However, if the user edits this string Excel may convert it back to a number. To get around this you can use the Excel text format @:

# Format as a string. Doesn't change to a number when edited
format1 = workbook.add_format(:num_format => '@')
worksheet.write_string('A2', '01209', format1)

Raises:



2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
 
# File 'lib/write_xlsx/worksheet.rb', line 2168

def write_string(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, str, xf = row_col_notation(args)
  raise WriteXLSXInsufficientArgumentError if [row, col, str].include?(nil)

  # Check that row and col are valid and store max and min values
  check_dimensions(row, col)
  store_row_col_max_min_values(row, col)

  index = shared_string_index(str[0, STR_MAX])

  store_data_to_table(StringCellData.new(self, row, col, index, xf))
end

#write_url(*args) ⇒ Object

:call-seq:

write_url(row, column, url [ , format, string, tool_tip ] )

Write a hyperlink to a URL in the cell specified by row and column. The hyperlink is comprised of two elements: the visible label and the invisible link. The visible label is the same as the link unless an alternative label is specified. The label parameter is optional. The label is written using the write() method. Therefore it is possible to write strings, numbers or formulas as labels.

The hyperlink can be to a http, ftp, mail, internal sheet, or external directory url.

The format parameter is also optional, however, without a format the link won’t look like a format.

The suggested format is:

format = workbook.add_format(:color => 'blue', :underline => 1)

Note, this behaviour is different from writeexcel gem which provides a default hyperlink format if one isn’t specified by the user.

There are four web style URI’s supported:

http://, https://, ftp:// and mailto

worksheet.write_url(0, 0, ‘www.ruby.org/’, format) worksheet.write_url(1, 0, ‘www.ruby.com/’, format, ‘Ruby’) worksheet.write_url(‘A3’, ‘www.ruby.com/’, format) worksheet.write_url(‘A4’, ‘[email protected]’, format)

There are two local URIs supported: internal: and external:. These are used for hyperlinks to internal worksheet references or external workbook and worksheet references:

worksheet.write_url('A6',  'internal:Sheet2!A1',              format)
worksheet.write_url('A7',  'internal:Sheet2!A1',              format)
worksheet.write_url('A8',  'internal:Sheet2!A1:B2',           format)
worksheet.write_url('A9',  %q{internal:'Sales Data'!A1},      format)
worksheet.write_url('A10', 'external:c:\temp\foo.xlsx',       format)
worksheet.write_url('A11', 'external:c:\foo.xlsx#Sheet2!A1',  format)
worksheet.write_url('A12', 'external:..\foo.xlsx',            format)
worksheet.write_url('A13', 'external:..\foo.xlsx#Sheet2!A1',  format)
worksheet.write_url('A13', 'external:\\\\NET\share\foo.xlsx', format)

All of the these URI types are recognised by the write() method, see above.

Worksheet references are typically of the form Sheet1!A1. You can also refer to a worksheet range using the standard Excel notation: Sheet1!A1:B2.

In external links the workbook and worksheet name must be separated by the # character: external:Workbook.xlsx#Sheet1!A1’.

You can also link to a named range in the target worksheet. For example say you have a named range called my_name in the workbook c:tempfoo.xlsx you could link to it as follows:

worksheet.write_url('A14', 'external:c:\temp\foo.xlsx#my_name')

Excel requires that worksheet names containing spaces or non alphanumeric characters are single quoted as follows ‘Sales Data’!A1.

Raises:



2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
 
# File 'lib/write_xlsx/worksheet.rb', line 2606

def write_url(*args)
  # Check for a cell reference in A1 notation and substitute row and column
  row, col, url, xf, str, tip = row_col_notation(args)
  xf, str = str, xf if str.respond_to?(:xf_index) || !xf.respond_to?(:xf_index)
  raise WriteXLSXInsufficientArgumentError if [row, col, url].include?(nil)

  link_type = 1

  # Remove the URI scheme from internal links.
  if url =~ /^internal:/
    url.sub!(/^internal:/, '')
    link_type = 2
  # Remove the URI scheme from external links.
  elsif url =~ /^external:/
    url.sub!(/^external:/, '')
    link_type = 3
  end

  # The displayed string defaults to the url string.
  str ||= url.dup

  # For external links change the directory separator from Unix to Dos.
  if link_type == 3
    url.gsub!(%r|/|, '\\')
    str.gsub!(%r|/|, '\\')
  end

  # Strip the mailto header.
  str.sub!(/^mailto:/, '')

  # Check that row and col are valid and store max and min values
  check_dimensions(row, col)
  store_row_col_max_min_values(row, col)

  # Store the URL displayed text in the shared string table.
  index = shared_string_index(str[0, STR_MAX])

  # External links to URLs and to other Excel workbooks have slightly
  # different characteristics that we have to account for.
  if link_type == 1
    # Substiture white space in url.
    url = url.sub(/[\s\x00]/, '%20')

    # Ordinary URL style external links don't have a "location" string.
    str = nil
  elsif link_type == 3
    # External Workbook links need to be modified into the right format.
    # The URL will look something like 'c:\temp\file.xlsx#Sheet!A1'.
    # We need the part to the left of the # as the URL and the part to
    # the right as the "location" string (if it exists).
    url, str = url.split(/#/)

    # Add the file:/// URI to the url if non-local.
    if url =~ %r![:]! ||        # Windows style "C:/" link.
        url =~ %r!^\\\\!        # Network share.
      url = "file:///#{url}"
    end

    # Convert a ./dir/file.xlsx link to dir/file.xlsx.
    url = url.sub(%r!^.\\!, '')

    # Treat as a default external link now that the data has been modified.
    link_type = 1
  end

  # Excel limits escaped URL to 255 characters.
  if url.bytesize > 255
    raise "URL '#{url}' > 255 characters, it exceeds Excel's limit for URLS."
  end

  # Check the limit of URLS per worksheet.
  @hlink_count += 1

  if @hlink_count > 65_530
    raise "URL '#{url}' added but number of URLS is over Excel's limit of 65,530 URLS per worksheet."
  end

  store_data_to_table(HyperlinkCellData.new(self, row, col, index, xf, link_type, url, str, tip))
end