writeexcel 0.3.4 → 0.3.5

data/README.rdoc

@@ -4,6 +4,13 @@ Write to a cross-platform Excel binary file.
 
 == Recent Changes
 
+v0.3.5
+* Bug fix. Worksheet#write_comment() doesn't work when value arg is numeric.
+* Bug fix. TRUE/FALSE in formula was misundarstood as :NAME.
+* Bug fix. Worksheet#close() mis-handled @colinfo.
+* Bug fix. Worksheet#set_row() grbit mis-calculate by param hidden.
+* convert examples.(formula_result, indent, merge6, outline, outline_collapsed, panes, right_to_left, row_wrap)
+
 v0.3.4
 * Bug fix. add_comment doesn't work.
 * convert examples.(chess, colors, comment1, comment2)

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/examples/formula_result.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to write Spreadsheet::WriteExcel formulas with a user
+# specified result.
+#
+# This is generally only required when writing a spreadsheet for an
+# application other than Excel where the formula isn't evaluated.
+#
+# reverse('©'), August 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+workbook  = WriteExcel.new('formula_result.xls')
+worksheet = workbook.add_worksheet()
+format    = workbook.add_format(:color => 'blue')
+
+worksheet.write('A1', '=1+2')
+worksheet.write('A2', '=1+2',                     format, 4)
+worksheet.write('A3', '="ABC"',                   nil,    'DEF')
+worksheet.write('A4', '=IF(A1 > 1, TRUE, FALSE)', nil,    'TRUE')
+worksheet.write('A5', '=1/0',                     nil,    '#DIV/0!')
+
+workbook.close

data/examples/indent.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+
+##############################################################################
+#
+# A simple formatting example using Spreadsheet::WriteExcel.
+#
+# This program demonstrates the indentation cell format.
+#
+# reverse('©'), May 2004, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+
+require 'writeexcel'
+
+workbook  = WriteExcel.new('indent.xls')
+
+worksheet = workbook.add_worksheet()
+indent1   = workbook.add_format(:indent => 1)
+indent2   = workbook.add_format(:indent => 2)
+
+worksheet.set_column('A:A', 40)
+
+
+worksheet.write('A1', "This text is indented 1 level",  indent1)
+worksheet.write('A2', "This text is indented 2 levels", indent2)
+
+workbook.close

data/examples/merge6.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the Spreadsheet::WriteExcel merge_cells() workbook
+# method with Unicode strings.
+#
+#
+# reverse('©'), December 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = WriteExcel.new('merge6.xls')
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(2..9).each { |i| worksheet.set_row(i, 36) }
+worksheet.set_column('B:D', 25)
+
+# Format for the merged cells.
+format = workbook.add_format(
+           :border      => 6,
+           :bold        => 1,
+           :color       => 'red',
+           :size        => 20,
+           :valign      => 'vcentre',
+           :align       => 'left',
+           :indent      => 1
+  )
+
+###############################################################################
+#
+# Write an Ascii string.
+#
+
+worksheet.merge_range('B3:D4', 'ASCII: A simple string', format)
+
+###############################################################################
+#
+# Write a UTF-16 Unicode string.
+#
+
+# A phrase in Cyrillic encoded as UTF-16BE.
+utf16_str = [
+  '005500540046002d00310036003a0020' <<
+  '042d0442043e002004440440043004370430002004' <<
+  '3d043000200440044304410441043a043e043c0021'
+].pack("H*")
+
+# Note the extra parameter at the end to indicate UTF-16 encoding.
+worksheet.merge_range('B6:D7', utf16_str, format, 1)
+
+###############################################################################
+#
+# Write a UTF-8 Unicode string.
+#
+
+smiley = '☺'  # chr 0x263a in perl
+worksheet.merge_range('B9:D10', "UTF-8: A Unicode smiley #{smiley}", format)
+
+workbook.close

data/examples/outline.rb

@@ -0,0 +1,254 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how use Spreadsheet::WriteExcel to generate Excel outlines and
+# grouping.
+#
+#
+# Excel allows you to group rows or columns so that they can be hidden or
+# displayed with a single mouse click. This feature is referred to as outlines.
+#
+# Outlines can reduce complex data down to a few salient sub-totals or
+# summaries.
+#
+# This feature is best viewed in Excel but the following is an ASCII
+# representation of what a worksheet with three outlines might look like.
+# Rows 3-4 and rows 7-8 are grouped at level 2. Rows 2-9 are grouped at
+# level 1. The lines at the left hand side are called outline level bars.
+#
+#
+#             ------------------------------------------
+#      1 2 3 |   |   A   |   B   |   C   |   D   |  ...
+#             ------------------------------------------
+#       _    | 1 |   A   |       |       |       |  ...
+#      |  _  | 2 |   B   |       |       |       |  ...
+#      | |   | 3 |  (C)  |       |       |       |  ...
+#      | |   | 4 |  (D)  |       |       |       |  ...
+#      | -   | 5 |   E   |       |       |       |  ...
+#      |  _  | 6 |   F   |       |       |       |  ...
+#      | |   | 7 |  (G)  |       |       |       |  ...
+#      | |   | 8 |  (H)  |       |       |       |  ...
+#      | -   | 9 |   I   |       |       |       |  ...
+#      -     | . |  ...  |  ...  |  ...  |  ...  |  ...
+#
+#
+# Clicking the minus sign on each of the level 2 outlines will collapse and
+# hide the data as shown in the next figure. The minus sign changes to a plus
+# sign to indicate that the data in the outline is hidden.
+#
+#             ------------------------------------------
+#      1 2 3 |   |   A   |   B   |   C   |   D   |  ...
+#             ------------------------------------------
+#       _    | 1 |   A   |       |       |       |  ...
+#      |     | 2 |   B   |       |       |       |  ...
+#      | +   | 5 |   E   |       |       |       |  ...
+#      |     | 6 |   F   |       |       |       |  ...
+#      | +   | 9 |   I   |       |       |       |  ...
+#      -     | . |  ...  |  ...  |  ...  |  ...  |  ...
+#
+#
+# Clicking on the minus sign on the level 1 outline will collapse the remaining
+# rows as follows:
+#
+#             ------------------------------------------
+#      1 2 3 |   |   A   |   B   |   C   |   D   |  ...
+#             ------------------------------------------
+#            | 1 |   A   |       |       |       |  ...
+#      +     | . |  ...  |  ...  |  ...  |  ...  |  ...
+#
+# See the main Spreadsheet::WriteExcel documentation for more information.
+#
+# reverse('©'), April 2003, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+# Create a new workbook and add some worksheets
+workbook   = WriteExcel.new('outline.xls')
+worksheet1 = workbook.add_worksheet('Outlined Rows')
+worksheet2 = workbook.add_worksheet('Collapsed Rows')
+worksheet3 = workbook.add_worksheet('Outline Columns')
+worksheet4 = workbook.add_worksheet('Outline levels')
+
+# Add a general format
+bold = workbook.add_format(:bold => 1)
+
+
+
+###############################################################################
+#
+# Example 1: Create a worksheet with outlined rows. It also includes SUBTOTAL()
+# functions so that it looks like the type of automatic outlines that are
+# generated when you use the Excel Data->SubTotals menu item.
+#
+
+
+# For outlines the important parameters are $hidden and $level. Rows with the
+# same $level are grouped together. The group will be collapsed if $hidden is
+# non-zero. $height and $XF are assigned default values if they are undef.
+#
+# The syntax is: set_row($row, $height, $XF, $hidden, $level, $collapsed)
+#
+worksheet1.set_row(1,  nil, nil, 0, 2)
+worksheet1.set_row(2,  nil, nil, 0, 2)
+worksheet1.set_row(3,  nil, nil, 0, 2)
+worksheet1.set_row(4,  nil, nil, 0, 2)
+worksheet1.set_row(5,  nil, nil, 0, 1)
+
+worksheet1.set_row(6,  nil, nil, 0, 2)
+worksheet1.set_row(7,  nil, nil, 0, 2)
+worksheet1.set_row(8,  nil, nil, 0, 2)
+worksheet1.set_row(9,  nil, nil, 0, 2)
+worksheet1.set_row(10, nil, nil, 0, 1)
+
+
+# Add a column format for clarity
+worksheet1.set_column('A:A', 20)
+
+# Add the data, labels and formulas
+worksheet1.write('A1',  'Region', bold)
+worksheet1.write('A2',  'North')
+worksheet1.write('A3',  'North')
+worksheet1.write('A4',  'North')
+worksheet1.write('A5',  'North')
+worksheet1.write('A6',  'North Total', bold)
+
+worksheet1.write('B1',  'Sales',  bold)
+worksheet1.write('B2',  1000)
+worksheet1.write('B3',  1200)
+worksheet1.write('B4',  900)
+worksheet1.write('B5',  1200)
+worksheet1.write('B6',  '=SUBTOTAL(9,B2:B5)', bold)
+
+worksheet1.write('A7',  'South')
+worksheet1.write('A8',  'South')
+worksheet1.write('A9',  'South')
+worksheet1.write('A10', 'South')
+worksheet1.write('A11', 'South Total', bold)
+
+worksheet1.write('B7',  400)
+worksheet1.write('B8',  600)
+worksheet1.write('B9',  500)
+worksheet1.write('B10', 600)
+worksheet1.write('B11', '=SUBTOTAL(9,B7:B10)', bold)
+
+worksheet1.write('A12', 'Grand Total', bold)
+worksheet1.write('B12', '=SUBTOTAL(9,B2:B10)', bold)
+
+
+###############################################################################
+#
+# Example 2: Create a worksheet with outlined rows. This is the same as the
+# previous example except that the rows are collapsed.
+# Note: We need to indicate the row that contains the collapsed symbol '+'
+# with the optional parameter, $collapsed.
+
+# The group will be collapsed if $hidden is non-zero.
+# The syntax is: set_row($row, $height, $XF, $hidden, $level, $collapsed)
+#
+worksheet2.set_row(1,  nil, nil, 1, 2)
+worksheet2.set_row(2,  nil, nil, 1, 2)
+worksheet2.set_row(3,  nil, nil, 1, 2)
+worksheet2.set_row(4,  nil, nil, 1, 2)
+worksheet2.set_row(5,  nil, nil, 1, 1)
+
+worksheet2.set_row(6,  nil, nil, 1, 2)
+worksheet2.set_row(7,  nil, nil, 1, 2)
+worksheet2.set_row(8,  nil, nil, 1, 2)
+worksheet2.set_row(9,  nil, nil, 1, 2)
+worksheet2.set_row(10, nil, nil, 1, 1)
+worksheet2.set_row(11, nil, nil, 0, 0, 1)
+
+
+# Add a column format for clarity
+worksheet2.set_column('A:A', 20)
+
+# Add the data, labels and formulas
+worksheet2.write('A1',  'Region', bold)
+worksheet2.write('A2',  'North')
+worksheet2.write('A3',  'North')
+worksheet2.write('A4',  'North')
+worksheet2.write('A5',  'North')
+worksheet2.write('A6',  'North Total', bold)
+
+worksheet2.write('B1',  'Sales',  bold)
+worksheet2.write('B2',  1000)
+worksheet2.write('B3',  1200)
+worksheet2.write('B4',  900)
+worksheet2.write('B5',  1200)
+worksheet2.write('B6',  '=SUBTOTAL(9,B2:B5)', bold)
+
+worksheet2.write('A7',  'South')
+worksheet2.write('A8',  'South')
+worksheet2.write('A9',  'South')
+worksheet2.write('A10', 'South')
+worksheet2.write('A11', 'South Total', bold)
+
+worksheet2.write('B7',  400)
+worksheet2.write('B8',  600)
+worksheet2.write('B9',  500)
+worksheet2.write('B10', 600)
+worksheet2.write('B11', '=SUBTOTAL(9,B7:B10)', bold)
+
+worksheet2.write('A12', 'Grand Total', bold)
+worksheet2.write('B12', '=SUBTOTAL(9,B2:B10)', bold)
+
+
+
+###############################################################################
+#
+# Example 3: Create a worksheet with outlined columns.
+#
+data = [
+            ['Month', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', ' Total'],
+            ['North', 50,    20,    15,    25,    65,    80,    '=SUM(B2:G2)'],
+            ['South', 10,    20,    30,    50,    50,    50,    '=SUM(B3:G3)'],
+            ['East',  45,    75,    50,    15,    75,    100,   '=SUM(B4:G4)'],
+            ['West',  15,    15,    55,    35,    20,    50,    '=SUM(B5:G6)']
+        ]
+
+# Add bold format to the first row
+worksheet3.set_row(0, nil, bold)
+
+# Syntax: set_column(col1, col2, width, XF, hidden, level, collapsed)
+worksheet3.set_column('A:A', 10, bold      )
+worksheet3.set_column('B:G', 5,  nil, 0, 1)
+worksheet3.set_column('H:H', 10)
+
+# Write the data and a formula
+worksheet3.write_col('A1', data)
+worksheet3.write('H6', '=SUM(H2:H5)', bold)
+
+
+
+###############################################################################
+#
+# Example 4: Show all possible outline levels.
+#
+levels = [
+  "Level 1", "Level 2", "Level 3", "Level 4",
+  "Level 5", "Level 6", "Level 7", "Level 6",
+  "Level 5", "Level 4", "Level 3", "Level 2", "Level 1"
+]
+
+worksheet4.write_col('A1', levels)
+
+worksheet4.set_row(0,  nil, nil, nil, 1)
+worksheet4.set_row(1,  nil, nil, nil, 2)
+worksheet4.set_row(2,  nil, nil, nil, 3)
+worksheet4.set_row(3,  nil, nil, nil, 4)
+worksheet4.set_row(4,  nil, nil, nil, 5)
+worksheet4.set_row(5,  nil, nil, nil, 6)
+worksheet4.set_row(6,  nil, nil, nil, 7)
+worksheet4.set_row(7,  nil, nil, nil, 6)
+worksheet4.set_row(8,  nil, nil, nil, 5)
+worksheet4.set_row(9,  nil, nil, nil, 4)
+worksheet4.set_row(10, nil, nil, nil, 3)
+worksheet4.set_row(11, nil, nil, nil, 2)
+worksheet4.set_row(12, nil, nil, nil, 1)
+
+workbook.close

data/examples/outline_collapsed.rb

@@ -0,0 +1,208 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how use Spreadsheet::WriteExcel to generate Excel outlines and
+# grouping.
+#
+# These example focus mainly on collapsed outlines. See also the
+# outlines.pl example program for more general examples.
+#
+# reverse('©'), March 2008, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+# Create a new workbook and add some worksheets
+workbook   = WriteExcel.new('outline_collapsed.xls')
+worksheet1 = workbook.add_worksheet('Outlined Rows')
+worksheet2 = workbook.add_worksheet('Collapsed Rows 1')
+worksheet3 = workbook.add_worksheet('Collapsed Rows 2')
+worksheet4 = workbook.add_worksheet('Collapsed Rows 3')
+worksheet5 = workbook.add_worksheet('Outline Columns')
+worksheet6 = workbook.add_worksheet('Collapsed Columns')
+
+# Add a general format
+bold = workbook.add_format(:bold => 1)
+
+#
+# This function will generate the same data and sub-totals on each worksheet.
+#
+def create_sub_totals(worksheet, bold)
+  # Add a column format for clarity
+  worksheet.set_column('A:A', 20)
+
+  # Add the data, labels and formulas
+  worksheet.write('A1',  'Region', bold)
+  worksheet.write('A2',  'North')
+  worksheet.write('A3',  'North')
+  worksheet.write('A4',  'North')
+  worksheet.write('A5',  'North')
+  worksheet.write('A6',  'North Total', bold)
+
+  worksheet.write('B1',  'Sales',  bold)
+  worksheet.write('B2',  1000)
+  worksheet.write('B3',  1200)
+  worksheet.write('B4',  900)
+  worksheet.write('B5',  1200)
+  worksheet.write('B6',  '=SUBTOTAL(9,B2:B5)', bold)
+
+  worksheet.write('A7',  'South')
+  worksheet.write('A8',  'South')
+  worksheet.write('A9',  'South')
+  worksheet.write('A10', 'South')
+  worksheet.write('A11', 'South Total', bold)
+
+  worksheet.write('B7',  400)
+  worksheet.write('B8',  600)
+  worksheet.write('B9',  500)
+  worksheet.write('B10', 600)
+  worksheet.write('B11', '=SUBTOTAL(9,B7:B10)', bold)
+
+  worksheet.write('A12', 'Grand Total', bold)
+  worksheet.write('B12', '=SUBTOTAL(9,B2:B10)', bold)
+
+end
+
+
+###############################################################################
+#
+# Example 1: Create a worksheet with outlined rows. It also includes SUBTOTAL()
+# functions so that it looks like the type of automatic outlines that are
+# generated when you use the Excel Data.SubTotals menu item.
+#
+
+# The syntax is: set_row(row, height, XF, hidden, level, collapsed)
+worksheet1.set_row(1,  nil, nil, 0, 2)
+worksheet1.set_row(2,  nil, nil, 0, 2)
+worksheet1.set_row(3,  nil, nil, 0, 2)
+worksheet1.set_row(4,  nil, nil, 0, 2)
+worksheet1.set_row(5,  nil, nil, 0, 1)
+
+worksheet1.set_row(6,  nil, nil, 0, 2)
+worksheet1.set_row(7,  nil, nil, 0, 2)
+worksheet1.set_row(8,  nil, nil, 0, 2)
+worksheet1.set_row(9,  nil, nil, 0, 2)
+worksheet1.set_row(10, nil, nil, 0, 1)
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet1, bold)
+
+
+###############################################################################
+#
+# Example 2: Create a worksheet with collapsed outlined rows.
+# This is the same as the example 1  except that the all rows are collapsed.
+# Note: We need to indicate the row that contains the collapsed symbol '+' with
+# the optional parameter, collapsed.
+
+worksheet2.set_row(1,  nil, nil, 1, 2)
+worksheet2.set_row(2,  nil, nil, 1, 2)
+worksheet2.set_row(3,  nil, nil, 1, 2)
+worksheet2.set_row(4,  nil, nil, 1, 2)
+worksheet2.set_row(5,  nil, nil, 1, 1)
+
+worksheet2.set_row(6,  nil, nil, 1, 2)
+worksheet2.set_row(7,  nil, nil, 1, 2)
+worksheet2.set_row(8,  nil, nil, 1, 2)
+worksheet2.set_row(9,  nil, nil, 1, 2)
+worksheet2.set_row(10, nil, nil, 1, 1)
+
+worksheet2.set_row(11, nil, nil, 0, 0, 1)
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet2, bold)
+
+
+###############################################################################
+#
+# Example 3: Create a worksheet with collapsed outlined rows.
+# Same as the example 1  except that the two sub-totals are collapsed.
+
+worksheet3.set_row(1,  nil, nil, 1, 2)
+worksheet3.set_row(2,  nil, nil, 1, 2)
+worksheet3.set_row(3,  nil, nil, 1, 2)
+worksheet3.set_row(4,  nil, nil, 1, 2)
+worksheet3.set_row(5,  nil, nil, 0, 1, 1)
+
+worksheet3.set_row(6,  nil, nil, 1, 2)
+worksheet3.set_row(7,  nil, nil, 1, 2)
+worksheet3.set_row(8,  nil, nil, 1, 2)
+worksheet3.set_row(9,  nil, nil, 1, 2)
+worksheet3.set_row(10, nil, nil, 0, 1, 1)
+
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet3, bold)
+
+
+###############################################################################
+#
+# Example 4: Create a worksheet with outlined rows.
+# Same as the example 1  except that the two sub-totals are collapsed.
+
+worksheet4.set_row(1,  nil, nil, 1, 2)
+worksheet4.set_row(2,  nil, nil, 1, 2)
+worksheet4.set_row(3,  nil, nil, 1, 2)
+worksheet4.set_row(4,  nil, nil, 1, 2)
+worksheet4.set_row(5,  nil, nil, 1, 1, 1)
+
+worksheet4.set_row(6,  nil, nil, 1, 2)
+worksheet4.set_row(7,  nil, nil, 1, 2)
+worksheet4.set_row(8,  nil, nil, 1, 2)
+worksheet4.set_row(9,  nil, nil, 1, 2)
+worksheet4.set_row(10, nil, nil, 1, 1, 1)
+
+worksheet4.set_row(11, nil, nil, 0, 0, 1)
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet4, bold)
+
+
+
+###############################################################################
+#
+# Example 5: Create a worksheet with outlined columns.
+#
+data = [
+  ['Month', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',' Total'],
+  ['North', 50,    20,    15,    25,    65,    80,   '=SUM(B2:G2)'],
+  ['South', 10,    20,    30,    50,    50,    50,   '=SUM(B3:G3)'],
+  ['East',  45,    75,    50,    15,    75,    100,  '=SUM(B4:G4)'],
+  ['West',  15,    15,    55,    35,    20,    50,   '=SUM(B5:G6)']
+]
+
+# Add bold format to the first row
+worksheet5.set_row(0, nil, bold)
+
+# Syntax: set_column(col1, col2, width, XF, hidden, level, collapsed)
+worksheet5.set_column('A:A', 10, bold      )
+worksheet5.set_column('B:G', 5,  nil, 0, 1)
+worksheet5.set_column('H:H', 10             )
+
+# Write the data and a formula
+worksheet5.write_col('A1', data)
+worksheet5.write('H6', '=SUM(H2:H5)', bold)
+
+
+###############################################################################
+#
+# Example 6: Create a worksheet with collapsed outlined columns.
+# This is the same as the previous example except collapsed columns.
+
+# Add bold format to the first row
+worksheet6.set_row(0, nil, bold)
+
+# Syntax: set_column(col1, col2, width, XF, hidden, level, collapsed)
+worksheet6.set_column('A:A', 10, bold         )
+worksheet6.set_column('B:G', 5,  nil, 1, 1   )
+worksheet6.set_column('H:H', 10, nil, 0, 0, 1)
+
+# Write the data and a formula
+worksheet6.write_col('A1', data)
+worksheet6.write('H6', '=SUM(H2:H5)', bold)
+
+workbook.close