write_xlsx 0.0.2

data/examples/merge3.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how to use Excel::Writer::XLSX to write a hyperlink in a
+# merged cell.
+#
+# reverse(c), September 2002, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+# Create a new workbook and add a worksheet
+workbook  = WriteXLSX.new('merge3.xlsx')
+worksheet = workbook.add_worksheet()
+
+# Increase the cell size of the merged cells to highlight the formatting.
+[3, 6, 7].each { |row| worksheet.set_row(row, 30) }
+worksheet.set_column('B:D', 20)
+
+###############################################################################
+#
+# Example: Merge cells containing a hyperlink using merge_range().
+#
+format = 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', format)
+
+
+# Merge 3 cells over two rows
+worksheet.merge_range('B7:D8', 'http://www.perl.com', format)
+
+workbook.close

data/examples/merge4.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how to use the Excel::Writer::XLSX merge_range workbook
+# method with complex formatting.
+#
+# reverse(c), September 2002, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+# Create a new workbook and add a worksheet
+workbook  = WriteXLSX.new('merge4.xlsx')
+worksheet = workbook.add_worksheet
+
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(1 .. 11).each { |i| worksheet.set_row(i, 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,70 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how to use the Excel::Writer::XLSX merge_cells workbook
+# method with complex formatting and rotation.
+#
+#
+# reverse(c), September 2002, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+# Create a new workbook and add a worksheet
+workbook  = WriteXLSX.new( 'merge5.xlsx' )
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(3 .. 8).each { |row|  worksheet.set_row(row, 36 ) }
+[1, 3, 5].each { |col| worksheet.set_column( col, col, 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/merge6.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how to use the Excel::Writer::XLSX merge_cells workbook
+# method with Unicode strings.
+#
+# reverse(c), December 2005, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+# Create a new workbook and add a worksheet
+workbook  = WriteXLSX.new('merge6.xlsx')
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(2 .. 9).each { |row| worksheet.set_row(row, 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-8 Unicode string.
+#
+smiley = '☺'
+worksheet.merge_range('B6:D7', "UTF-8: A Unicode smiley #{smiley}", format)
+
+workbook.close

data/examples/outline.rb

@@ -0,0 +1,252 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how use Excel::Writer::XLSX 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 Excel::Writer::XLSX documentation for more information.
+#
+# reverse(c), April 2003, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+# Create a new workbook and add some worksheets
+workbook   = WriteXLSX.new('outline.xlsx')
+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 nil.
+#
+# 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:G5)' ],
+]
+
+# 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