write_xlsx 0.0.2

data/examples/defined_name.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook   = WriteXLSX.new('defined_name.xlsx')
+worksheet1 = workbook.add_worksheet
+worksheet2 = workbook.add_worksheet
+
+# Define some global/workbook names.
+workbook.define_name('Exchange_rate', '=0.96')
+workbook.define_name('Sales',         '=Sheet1!$G$1:$H$10')
+
+# Define a local/worksheet name.
+workbook.define_name('Sheet2!Sales', '=Sheet2!$G$1:$G$10')
+
+# Write some text in the file and one of the defined names in a formula.
+workbook.worksheets.each do |worksheet|
+    worksheet.set_column('A:A', 45)
+    worksheet.write('A1', 'This worksheet contains some defined names.')
+    worksheet.write('A2', 'See Formulas -> Name Manager above.')
+    worksheet.write('A3', 'Example formula in cell B3 ->')
+
+    worksheet.write('B3', '=Exchange_rate')
+end
+
+workbook.close

data/examples/demo.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook   = WriteXLSX.new('demo.xlsx')
+worksheet  = workbook.add_worksheet('Demo')
+worksheet2 = workbook.add_worksheet('Another sheet')
+worksheet3 = workbook.add_worksheet('And another')
+
+bold = workbook.add_format(:bold => 1)
+
+
+#######################################################################
+#
+# Write a general heading
+#
+worksheet.set_column('A:A', 36, bold)
+worksheet.set_column('B:B', 20)
+worksheet.set_row(0, 40)
+
+heading = workbook.add_format(
+    :bold  => 1,
+    :color => 'blue',
+    :size  => 16,
+    :merge => 1,
+    :align => 'vcenter'
+)
+
+hyperlink_format = workbook.add_format(
+    :color => 'blue',
+    :underline => 1
+)
+
+headings = ['Features of WriteXLSX', '']
+worksheet.write_row('A1', headings, heading)
+
+#######################################################################
+#
+# Some text examples
+#
+text_format = workbook.add_format(
+    :bold   => 1,
+    :italic => 1,
+    :color  => 'red',
+    :size   => 18,
+    :font   => 'Lucida Calligraphy'
+)
+
+worksheet.write('A2', "Text")
+worksheet.write('B2', "Hello Excel")
+worksheet.write('A3', "Formatted text")
+worksheet.write('B3', "Hello Excel", text_format)
+worksheet.write('A4', "Unicode text")
+worksheet.write('B4', "А Б В Г Д")
+
+#######################################################################
+#
+# Some numeric examples
+#
+num1_format = workbook.add_format(:num_format => '$#,##0.00')
+num2_format = workbook.add_format(:num_format => ' d mmmm yyy')
+
+worksheet.write('A5', "Numbers")
+worksheet.write('B5', 1234.56)
+worksheet.write('A6', "Formatted numbers")
+worksheet.write('B6', 1234.56, num1_format)
+worksheet.write('A7', "Formatted numbers")
+worksheet.write('B7', 37257, num2_format)
+
+#######################################################################
+#
+# Formulae
+#
+worksheet.set_selection('B8')
+worksheet.write('A8', 'Formulas and functions, "=SIN(PI()/4)"')
+worksheet.write('B8', '=SIN(PI()/4)')
+
+#######################################################################
+#
+# Hyperlinks
+#
+worksheet.write('A9', "Hyperlinks")
+worksheet.write('B9', 'http://www.ruby-lang.org/', hyperlink_format)
+
+#######################################################################
+#
+# Images
+#
+# Not implemented yet.
+#worksheet.write('A10', "Images")
+#worksheet.insert_image('B10', 'republic.png', 16, 8)
+
+
+#######################################################################
+#
+# Misc
+#
+worksheet.write('A18', "Page/printer setup")
+worksheet.write('A19', "Multiple worksheets")
+
+workbook.close
+

data/examples/diag_border.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('diag_border.xlsx')
+worksheet = workbook.add_worksheet()
+
+
+format1 = workbook.add_format(:diag_type => 1)
+format2 = workbook.add_format(:diag_type => 2)
+format3 = workbook.add_format(:diag_type => 3)
+
+format4 = workbook.add_format(
+    :diag_type   => 3,
+    :diag_border => 7,
+    :diag_color  => 'red'
+)
+
+worksheet.write('B3',  'Text', format1)
+worksheet.write('B6',  'Text', format2)
+worksheet.write('B9',  'Text', format3)
+worksheet.write('B12', 'Text', format4)
+
+workbook.close

data/examples/headers.rb

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+######################################################################
+#
+# This program shows several examples of how to set up headers and
+# footers with Excel::Writer::XLSX.
+#
+# The control characters used in the header/footer strings 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
+#
+#     &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 &
+#
+# See the main Excel::Writer::XLSX documentation for more information.
+#
+# reverse(c), March 2002, John McNamara, jmcnamara@cpan.org
+#
+# converted to ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook = WriteXLSX.new('headers.xlsx')
+preview  = 'Select Print Preview to see the header and footer'
+
+
+######################################################################
+#
+# A simple example to start
+#
+worksheet1 = workbook.add_worksheet('Simple')
+header1    = '&CHere is some centred text.'
+footer1    = '&LHere is some left aligned text.'
+
+worksheet1.set_header(header1)
+worksheet1.set_footer(footer1)
+
+worksheet1.set_column('A:A', 50)
+worksheet1.write('A1', preview)
+
+
+######################################################################
+#
+# This is an example of some of the header/footer variables.
+#
+worksheet2 = workbook.add_worksheet('Variables')
+header2    = '&LPage &P of &N' + '&CFilename: &F' + '&RSheetname: &A'
+footer2    = '&LCurrent date: &D' + '&RCurrent time: &T'
+
+worksheet2.set_header(header2)
+worksheet2.set_footer(footer2)
+
+worksheet2.set_column('A:A', 50)
+worksheet2.write('A1',  preview)
+worksheet2.write('A21', 'Next sheet')
+worksheet2.set_h_pagebreaks(20)
+
+
+######################################################################
+#
+# This example shows how to use more than one font
+#
+worksheet3 = workbook.add_worksheet('Mixed fonts')
+header3    = %q(&C&"Courier New,Bold"Hello &"Arial,Italic"World)
+footer3    = %q(&C&"Symbol"e&"Arial" = mc&X2)
+
+worksheet3.set_header(header3)
+worksheet3.set_footer(footer3)
+
+worksheet3.set_column('A:A', 50)
+worksheet3.write('A1', preview)
+
+
+######################################################################
+#
+# Example of line wrapping
+#
+worksheet4 = workbook.add_worksheet('Word wrap')
+header4    = "&CHeading 1\nHeading 2"
+
+worksheet4.set_header(header4)
+
+worksheet4.set_column('A:A', 50)
+worksheet4.write('A1', preview)
+
+
+######################################################################
+#
+# Example of inserting a literal ampersand &
+#
+worksheet5 = workbook.add_worksheet('Ampersand')
+header5    = '&CCuriouser && Curiouser - Attorneys at Law'
+
+worksheet5.set_header(header5)
+
+worksheet5.set_column('A:A', 50)
+worksheet5.write('A1', preview)
+
+workbook.close

data/examples/hide_sheet.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of how to hide a worksheet with Excel::Writer::XLSX.
+#
+# reverse('c'), April 2005, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo, Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+require 'rubygems'
+require 'write_xlsx'
+
+workbook   = WriteXLSX.new('hide_sheet.xlsx')
+worksheet1 = workbook.add_worksheet
+worksheet2 = workbook.add_worksheet
+worksheet3 = workbook.add_worksheet
+
+worksheet1.set_column('A:A', 30)
+worksheet2.set_column('A:A', 30)
+worksheet3.set_column('A:A', 30)
+
+# Sheet2 won't be visible until it is unhidden in Excel.
+worksheet2.hide
+
+worksheet1.write(0, 0, 'Sheet2 is hidden')
+worksheet2.write(0, 0, "Now it's my turn to find you.")
+worksheet3.write(0, 0, 'Sheet2 is hidden')
+
+workbook.close

data/examples/hyperlink1.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how to use the Excel::Writer::XLSX module to write hyperlinks
+#
+# See also hyperlink2.pl for worksheet URL examples.
+#
+# reverse(c), May 2004, 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( 'hyperlink.xlsx')
+
+worksheet = workbook.add_worksheet('Hyperlinks')
+
+# Format the first column
+worksheet.set_column('A:A', 30)
+worksheet.set_selection('B1')
+
+
+# Add the standard url link format.
+url_format = workbook.add_format(
+    :color     => 'blue',
+    :underline => 1
+)
+
+# Add a sample format.
+red_format = workbook.add_format(
+    :color     => 'red',
+    :bold      => 1,
+    :underline => 1,
+    :size      => 12
+)
+
+# Add an alternate description string to the URL.
+str = 'Perl home.'
+
+# Add a "tool tip" to the URL.
+tip = 'Get the latest Perl news here.'
+
+
+# Write some hyperlinks
+worksheet.write('A1', 'http://www.perl.com/', url_format)
+worksheet.write('A3', 'http://www.perl.com/', url_format, str)
+worksheet.write('A5', 'http://www.perl.com/', url_format, str, tip)
+worksheet.write('A7', 'http://www.perl.com/', red_format)
+worksheet.write('A9', 'mailto:jmcnamara@cpan.org', url_format, 'Mail me')
+
+# Write a URL that isn't a hyperlink
+worksheet.write_string('A11', 'http://www.perl.com/')
+
+workbook.close

data/examples/indent.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+##############################################################################
+#
+# A simple formatting example using Excel::Writer::XLSX.
+#
+# This program demonstrates the indentation cell format.
+#
+# reverse(c), May 2004, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook = WriteXLSX.new('indent.xlsx')
+
+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/merge1.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Simple example of merging cells using the Excel::Writer::XLSX module.
+#
+# This example merges three cells using the "Centre Across Selection"
+# alignment which was the Excel 5 method of achieving a merge. For a more
+# modern approach use the merge_range() worksheet method instead.
+# See the merge3.pl - merge6.pl programs.
+#
+# reverse(c), August 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('merge1.xlsx')
+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,48 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Simple example of merging cells using the Excel::Writer::XLSX module
+#
+# This example merges three cells using the "Centre Across Selection"
+# alignment which was the Excel 5 method of achieving a merge. For a more
+# modern approach use the merge_range() worksheet method instead.
+# See the merge3.pl - merge6.pl programs.
+#
+# reverse(c), August 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('merge2.xlsx')
+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