writeexcel 0.1.0

data/examples/images.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to insert images into an Excel worksheet using the
+# Spreadsheet::WriteExcel insert_image() method.
+#
+# reverse('©'), October 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook called simple.xls and add a worksheet
+workbook   = Spreadsheet::WriteExcel.new("images.xls")
+worksheet1 = workbook.add_worksheet('Image 1')
+worksheet2 = workbook.add_worksheet('Image 2')
+worksheet3 = workbook.add_worksheet('Image 3')
+worksheet4 = workbook.add_worksheet('Image 4')
+bp=1
+
+# Insert a basic image
+worksheet1.write('A10', "Image inserted into worksheet.")
+worksheet1.insert_image('A1', 'republic.png')
+
+
+# Insert an image with an offset
+worksheet2.write('A10', "Image inserted with an offset.")
+worksheet2.insert_image('A1', 'republic.png', 32, 10)
+
+# Insert a scaled image
+worksheet3.write('A10', "Image scaled: width x 2, height x 0.8.")
+worksheet3.insert_image('A1', 'republic.png', 0, 0, 2, 0.8)
+
+# Insert an image over varied column and row sizes
+# This does not require any additional work
+
+# Set the cols and row sizes
+# NOTE: you must do this before you call insert_image()
+worksheet4.set_column('A:A', 5)
+worksheet4.set_column('B:B', nil, nil, 1) # Hidden
+worksheet4.set_column('C:D', 10)
+worksheet4.set_row(0, 30)
+worksheet4.set_row(3, 5)
+
+worksheet4.write('A10', "Image inserted over scaled rows and columns.")
+worksheet4.insert_image('A1', 'republic.png')
+
+workbook.close

data/examples/merge1.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Simple example of merging cells using the Spreadsheet::WriteExcel module.
+#
+# This merges three cells using the "Centre Across Selection" alignment.
+# This was the Excel 5 method of achieving a merge. Use the merge_range()
+# worksheet method instead. See merge3.pl - merge6.pl.
+#
+# reverse('©'), August 2002, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new('merge1.xls')
+worksheet = workbook.add_worksheet
+
+
+# Increase the cell size of the merged cells to highlight the formatting.
+worksheet.set_column('B:D', 20)
+worksheet.set_row(2, 30)
+
+
+# Create a merge format
+format = workbook.add_format(:center_across => 1)
+
+
+# Only one cell should contain text, the others should be blank.
+worksheet.write(2, 1, "Center across selection", format)
+worksheet.write_blank(2, 2,                 format)
+worksheet.write_blank(2, 3,                 format)
+
+workbook.close

data/examples/merge2.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Simple example of merging cells using the Spreadsheet::WriteExcel module
+#
+# This merges two formatted cells using the "Centre Across Selection" alignment.
+# This was the Excel 5 method of achieving a merge. Use the merge_range()
+# worksheet method instead. See merge3.pl - merge6.pl.
+#
+# reverse('©'), August 2002, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new("merge2.xls")
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+worksheet.set_column(1, 2, 30)
+worksheet.set_row(2, 40)
+
+# Create a merged format
+format = workbook.add_format(
+                                        :center_across   => 1,
+                                        :bold            => 1,
+                                        :size            => 15,
+                                        :pattern         => 1,
+                                        :border          => 6,
+                                        :color           => 'white',
+                                        :fg_color        => 'green',
+                                        :border_color    => 'yellow',
+                                        :align           => 'vcenter'
+                                  )
+
+# Only one cell should contain text, the others should be blank.
+worksheet.write(2, 1, "Center across selection", format)
+worksheet.write_blank(2, 2,                      format)
+workbook.close

data/examples/merge3.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use Spreadsheet::WriteExcel to write a hyperlink in a
+# merged cell. There are two options write_url_range() with a standard merge
+# format or merge_range().
+#
+# reverse('©'), September 2002, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new("merge3.xls")
+worksheet = workbook.add_worksheet()
+
+# Increase the cell size of the merged cells to highlight the formatting.
+[1, 3,6,7].each { |row| worksheet.set_row(row, 30) }
+worksheet.set_column('B:D', 20)
+
+bp=1
+###############################################################################
+#
+# Example 1: Merge cells containing a hyperlink using write_url_range()
+# and the standard Excel 5+ merge property.
+#
+format1 = workbook.add_format(
+                                    :center_across   => 1,
+                                    :border          => 1,
+                                    :underline       => 1,
+                                    :color           => 'blue'
+                             )
+
+# Write the cells to be merged
+worksheet.write_url_range('B2:D2', 'http://www.perl.com', format1)
+worksheet.write_blank('C2', format1)
+worksheet.write_blank('D2', format1)
+
+
+
+###############################################################################
+#
+# Example 2: Merge cells containing a hyperlink using merge_range().
+#
+format2 = workbook.add_format(
+                                    :border      => 1,
+                                    :underline   => 1,
+                                    :color       => 'blue',
+                                    :align       => 'center',
+                                    :valign      => 'vcenter'
+                             )
+
+# Merge 3 cells
+worksheet.merge_range('B4:D4', 'http://www.perl.com', format2)
+
+
+# Merge 3 cells over two rows
+worksheet.merge_range('B7:D8', 'http://www.perl.com', format2)
+
+workbook.close

data/examples/merge4.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the Spreadsheet::WriteExcel merge_range() workbook
+# method with complex formatting.
+#
+# reverse('©'), September 2002, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new('merge4.xls')
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(1..11).each { |row| worksheet.set_row(row, 30) }
+worksheet.set_column('B:D', 20)
+
+###############################################################################
+#
+# Example 1: Text centered vertically and horizontally
+#
+format1 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'vcenter',
+                                    :align   => 'center'
+                                   )
+
+worksheet.merge_range('B2:D3', 'Vertical and horizontal', format1)
+
+
+###############################################################################
+#
+# Example 2: Text aligned to the top and left
+#
+format2 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'top',
+                                    :align   => 'left'
+                                  )
+
+worksheet.merge_range('B5:D6', 'Aligned to the top and left', format2)
+
+###############################################################################
+#
+# Example 3:  Text aligned to the bottom and right
+#
+format3 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'bottom',
+                                    :align   => 'right'
+                                  )
+
+worksheet.merge_range('B8:D9', 'Aligned to the bottom and right', format3)
+
+###############################################################################
+#
+# Example 4:  Text justified (i.e. wrapped) in the cell
+#
+format4 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'top',
+                                    :align   => 'justify'
+                                  )
+
+worksheet.merge_range('B11:D12', 'Justified: '+'so on and '*18, format4)
+
+workbook.close

data/examples/merge5.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the Spreadsheet::WriteExcel merge_cells() workbook
+# method with complex formatting and rotation.
+#
+#
+# reverse('©'), September 2002, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new('merge5.xls')
+worksheet = workbook.add_worksheet
+
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(3..8).each { |col| worksheet.set_row(col, 36) }
+[1, 3, 5].each { |n| worksheet.set_column(n, n, 15) }
+
+
+###############################################################################
+#
+# Rotation 1, letters run from top to bottom
+#
+format1 = workbook.add_format(
+                                    :border      => 6,
+                                    :bold        => 1,
+                                    :color       => 'red',
+                                    :valign      => 'vcentre',
+                                    :align       => 'centre',
+                                    :rotation    => 270
+                                  )
+
+
+worksheet.merge_range('B4:B9', 'Rotation 270', format1)
+
+
+###############################################################################
+#
+# Rotation 2, 90° anticlockwise
+#
+format2 = workbook.add_format(
+                                    :border      => 6,
+                                    :bold        => 1,
+                                    :color       => 'red',
+                                    :valign      => 'vcentre',
+                                    :align       => 'centre',
+                                    :rotation    => 90
+                                  )
+
+
+worksheet.merge_range('D4:D9', 'Rotation 90°', format2)
+
+
+
+###############################################################################
+#
+# Rotation 3, 90° clockwise
+#
+format3 = workbook.add_format(
+                                    :border      => 6,
+                                    :bold        => 1,
+                                    :color       => 'red',
+                                    :valign      => 'vcentre',
+                                    :align       => 'centre',
+                                    :rotation    => -90
+                                  )
+
+
+worksheet.merge_range('F4:F9', 'Rotation -90°', format3)
+
+workbook.close

data/examples/protection.rb

@@ -0,0 +1,46 @@
+  #!/usr/bin/ruby -w
+
+########################################################################
+#
+# Example of cell locking and formula hiding in an Excel  worksheet via
+# the Spreadsheet::WriteExcel module.
+#
+# reverse('©'), August 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+workbook  = Spreadsheet::WriteExcel.new("protection.xls")
+worksheet = workbook.add_worksheet
+
+# Create some format objects
+locked    = workbook.add_format(:locked => 1)
+unlocked  = workbook.add_format(:locked => 0)
+hidden    = workbook.add_format(:hidden => 1)
+
+# Format the columns
+worksheet.set_column('A:A', 42)
+worksheet.set_selection('B3:B3')
+
+# Protect the worksheet
+worksheet.protect
+
+# Examples of cell locking and hiding
+worksheet.write('A1', 'Cell B1 is locked. It cannot be edited.')
+worksheet.write('B1', '=1+2', locked)
+
+worksheet.write('A2', 'Cell B2 is unlocked. It can be edited.')
+worksheet.write('B2', '=1+2', unlocked)
+
+worksheet.write('A3', "Cell B3 is hidden. The formula isn't visible.")
+worksheet.write('B3', '=1+2', hidden)
+
+worksheet.write('A5', 'Use Menu->Tools->Protection->Unprotect Sheet')
+worksheet.write('A6', 'to remove the worksheet protection.   ')
+
+workbook.close
+

data/examples/regions.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the WriteExcel module to write a basic multiple
+# worksheet Excel file.
+#
+# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+workbook = Spreadsheet::WriteExcel.new("regions.xls")
+
+# Add some worksheets
+north = workbook.add_worksheet("North")
+south = workbook.add_worksheet("South")
+east  = workbook.add_worksheet("East")
+west  = workbook.add_worksheet("West")
+
+# Add a Format
+format = workbook.add_format()
+format.set_bold()
+format.set_color('blue')
+
+# Add a caption to each worksheet
+workbook.sheets.each do |worksheet|
+    worksheet.write(0, 0, "Sales", format)
+end
+
+# Write some data
+north.write(0, 1, 200000)
+south.write(0, 1, 100000)
+east.write(0, 1, 150000)
+west.write(0, 1, 100000)
+
+# Set the active worksheet
+bp=1
+south.activate()
+
+# Set the width of the first column
+south.set_column(0, 0, 20)
+
+# Set the active cell
+south.set_selection(0, 1)
+
+workbook.close
+

data/examples/repeat.rb

@@ -0,0 +1,42 @@
+  #!/usr/bin/ruby -w
+
+######################################################################
+#
+# Example of writing repeated formulas.
+#
+# reverse('©'), August 2002, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+workbook  = Spreadsheet::WriteExcel.new("repeat.xls")
+worksheet = workbook.add_worksheet
+
+limit = 1000
+
+# Write a column of numbers
+0.upto(limit) do |row|
+  worksheet.write(row, 0,  row)
+end
+
+# Store a formula
+formula = worksheet.store_formula('=A1*5+4')
+
+# Write a column of formulas based on the stored formula
+0.upto(limit) do |row|
+  worksheet.repeat_formula(row, 1, formula, nil,
+                                      /A1/, 'A'+(row+1).to_s)
+end
+
+# Direct formula writing. As a speed comparison uncomment the
+# following and run the program again
+
+#for row (0..limit) {
+#    worksheet.write_formula(row, 2, '=A'.(row+1).'*5+4')
+#}
+
+workbook.close

data/examples/stats.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# This is a simple example of how to use functions with the
+# Spreadsheet::WriteExcel module.
+#
+# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+include Spreadsheet
+xlsfile = 'stats.xls'
+
+workbook = Spreadsheet::WriteExcel.new(xlsfile)
+worksheet = workbook.add_worksheet('Test data')
+
+# Set the column width for columns 1
+worksheet.set_column(0, 0, 20)
+
+
+# Create a format for the headings
+format = workbook.add_format
+format.set_bold
+
+
+# Write the sample data
+worksheet.write(0, 0, 'Sample', format)
+worksheet.write(0, 1, 1)
+worksheet.write(0, 2, 2)
+worksheet.write(0, 3, 3)
+worksheet.write(0, 4, 4)
+worksheet.write(0, 5, 5)
+worksheet.write(0, 6, 6)
+worksheet.write(0, 7, 7)
+worksheet.write(0, 8, 8)
+
+worksheet.write(1, 0, 'Length', format)
+worksheet.write(1, 1, 25.4)
+worksheet.write(1, 2, 25.4)
+worksheet.write(1, 3, 24.8)
+worksheet.write(1, 4, 25.0)
+worksheet.write(1, 5, 25.3)
+worksheet.write(1, 6, 24.9)
+worksheet.write(1, 7, 25.2)
+worksheet.write(1, 8, 24.8)
+
+# Write some statistical functions
+worksheet.write(4,  0, 'Count', format)
+worksheet.write(4,  1, '=COUNT(B1:I1)')
+
+worksheet.write(5,  0, 'Sum', format)
+worksheet.write(5,  1, '=SUM(B2:I2)')
+
+worksheet.write(6,  0, 'Average', format)
+worksheet.write(6,  1, '=AVERAGE(B2:I2)')
+
+worksheet.write(7,  0, 'Min', format)
+worksheet.write(7,  1, '=MIN(B2:I2)')
+
+worksheet.write(8,  0, 'Max', format)
+worksheet.write(8,  1, '=MAX(B2:I2)')
+
+worksheet.write(9,  0, 'Standard Deviation', format)
+worksheet.write(9,  1, '=STDEV(B2:I2)')
+
+worksheet.write(10, 0, 'Kurtosis', format)
+worksheet.write(10, 1, '=KURT(B2:I2)')
+
+workbook.close
+

data/examples/stocks.rb

@@ -0,0 +1,80 @@
+  #!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of formatting using the Spreadsheet::WriteExcel module
+#
+# This example shows how to use a conditional numerical format
+# with colours to indicate if a share price has gone up or down.
+#
+# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new("stocks.xls")
+worksheet = workbook.add_worksheet
+
+# Set the column width for columns 1, 2, 3 and 4
+worksheet.set_column(0, 3, 15)
+
+
+# Create a format for the column headings
+header = workbook.add_format
+header.set_bold
+header.set_size(12)
+header.set_color('blue')
+
+
+# Create a format for the stock price
+f_price = workbook.add_format
+f_price.set_align('left')
+f_price.set_num_format('$0.00')
+
+
+# Create a format for the stock volume
+f_volume = workbook.add_format
+f_volume.set_align('left')
+f_volume.set_num_format('#,##0')
+
+
+# Create a format for the price change. This is an example of a conditional
+# format. The number is formatted as a percentage. If it is positive it is
+# formatted in green, if it is negative it is formatted in red and if it is
+# zero it is formatted as the default font colour (in this case black).
+# Note: the [Green] format produces an unappealing lime green. Try
+# [Color 10] instead for a dark green.
+#
+f_change = workbook.add_format
+f_change.set_align('left')
+f_change.set_num_format('[Green]0.0%;[Red]-0.0%;0.0%')
+
+
+# Write out the data
+worksheet.write(0, 0, 'Company', header)
+worksheet.write(0, 1, 'Price',   header)
+worksheet.write(0, 2, 'Volume',  header)
+worksheet.write(0, 3, 'Change',  header)
+
+worksheet.write(1, 0, 'Damage Inc.'     )
+worksheet.write(1, 1, 30.25,     f_price)  # $30.25
+worksheet.write(1, 2, 1234567,   f_volume) # 1,234,567
+worksheet.write(1, 3, 0.085,     f_change) # 8.5% in green
+
+worksheet.write(2, 0, 'Dump Corp.'      )
+worksheet.write(2, 1, 1.56,      f_price)  # $1.56
+worksheet.write(2, 2, 7564,      f_volume) # 7,564
+worksheet.write(2, 3, -0.015,    f_change) # -1.5% in red
+
+worksheet.write(3, 0, 'Rev Ltd.'        )
+worksheet.write(3, 1, 0.13,      f_price)  # $0.13
+worksheet.write(3, 2, 321,       f_volume) # 321
+worksheet.write(3, 3, 0,         f_change) # 0 in the font color (black)
+
+
+workbook.close