write_xlsx 0.0.4 → 0.51.0

data/examples/stats.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A Simple example of how to use functions with the WriteXLSX gem.
+#
+# reverse(c), March 2001, 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('stats.xlsx')
+worksheet = workbook.add_worksheet('Test data')
+
+# Set the column width for column 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/stats_ext.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of how to use functions with the WriteXLSX gem.
+#
+# This is a simple example of how to use functions that reference cells in
+# other worksheets within the same workbook.
+#
+# reverse(c), March 2001, 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('stats_ext.xlsx')
+worksheet1 = workbook.add_worksheet('Test results')
+worksheet2 = workbook.add_worksheet('Data')
+
+# Set the column width for column 1
+worksheet1.set_column(0, 0, 20)
+
+# Create a format for the headings
+headings = workbook.add_format
+headings.set_bold
+
+# Create a numerical format
+numformat = workbook.add_format
+numformat.set_num_format('0.00')
+
+# Write some statistical functions
+worksheet1.write(0, 0, 'Count', headings)
+worksheet1.write(0, 1, '=COUNT(Data!B2:B9)')
+
+worksheet1.write(1, 0, 'Sum', headings)
+worksheet1.write(1, 1, '=SUM(Data!B2:B9)')
+
+worksheet1.write(2, 0, 'Average', headings)
+worksheet1.write(2, 1, '=AVERAGE(Data!B2:B9)')
+
+worksheet1.write(3, 0, 'Min', headings)
+worksheet1.write(3, 1, '=MIN(Data!B2:B9)')
+
+worksheet1.write(4, 0, 'Max', headings)
+worksheet1.write(4, 1, '=MAX(Data!B2:B9)')
+
+worksheet1.write(5, 0, 'Standard Deviation', headings)
+worksheet1.write(5, 1, '=STDEV(Data!B2:B9)')
+
+worksheet1.write(6, 0, 'Kurtosis', headings)
+worksheet1.write(6, 1, '=KURT(Data!B2:B9)')
+
+# Write the sample data
+worksheet2.write(0, 0, 'Sample', headings)
+worksheet2.write(1, 0, 1)
+worksheet2.write(2, 0, 2)
+worksheet2.write(3, 0, 3)
+worksheet2.write(4, 0, 4)
+worksheet2.write(5, 0, 5)
+worksheet2.write(6, 0, 6)
+worksheet2.write(7, 0, 7)
+worksheet2.write(8, 0, 8)
+
+worksheet2.write(0, 1, 'Length', headings)
+worksheet2.write(1, 1, 25.4, numformat)
+worksheet2.write(2, 1, 25.4, numformat)
+worksheet2.write(3, 1, 24.8, numformat)
+worksheet2.write(4, 1, 25.0, numformat)
+worksheet2.write(5, 1, 25.3, numformat)
+worksheet2.write(6, 1, 24.9, numformat)
+worksheet2.write(7, 1, 25.2, numformat)
+worksheet2.write(8, 1, 24.8, numformat)
+
+workbook.close

data/examples/stocks.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of formatting using the WriteXLSX gem
+#
+# This example shows how to use a conditional numerical format
+# with colours to indicate if a share price has gone up or down.
+#
+# reverse(c), March 2001, 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 called simple.xls and add a worksheet
+workbook  = WriteXLSX.new('stock.xlsx')
+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

data/examples/tables.rb

@@ -0,0 +1,360 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of how to add tables to an WriteXLSX worksheet.
+#
+# Tables in Excel are use to group rows and columns of data into a single
+# structure that can be references in a formula or formatted collectively.
+#
+# reverse(c), March 2001, 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 called simple.xls and add a worksheet
+workbook    = WriteXLSX.new('tables.xlsx')
+worksheet1  = workbook.add_worksheet
+worksheet2  = workbook.add_worksheet
+worksheet3  = workbook.add_worksheet
+worksheet4  = workbook.add_worksheet
+worksheet5  = workbook.add_worksheet
+worksheet6  = workbook.add_worksheet
+worksheet7  = workbook.add_worksheet
+worksheet8  = workbook.add_worksheet
+worksheet9  = workbook.add_worksheet
+worksheet10 = workbook.add_worksheet
+worksheet11 = workbook.add_worksheet
+worksheet12 = workbook.add_worksheet
+
+currency_format = workbook.add_format(:num_format => '$#,##0')
+
+
+# Some sample data for the table.
+data = [
+    [ 'Apples',  10000, 5000, 8000, 6000 ],
+    [ 'Pears',   2000,  3000, 4000, 5000 ],
+    [ 'Bananas', 6000,  6000, 6500, 6000 ],
+    [ 'Oranges', 500,   300,  200,  700 ]
+]
+
+###############################################################################
+#
+# Example 1.
+#
+caption = 'Default table with no data.'
+
+# Set the columns widths.
+worksheet1.set_column('B:G', 12)
+
+# Write the caption.
+worksheet1.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet1.add_table('B3:F7')
+
+
+###############################################################################
+#
+# Example 2.
+#
+caption = 'Default table with data.';
+
+# Set the columns widths.
+worksheet2.set_column('B:G', 12)
+
+# Write the caption.
+worksheet2.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet2.add_table('B3:F7', { :data => data })
+
+
+###############################################################################
+#
+# Example 3.
+#
+caption = 'Table without default autofilter.'
+
+# Set the columns widths.
+worksheet3.set_column('B:G', 12)
+
+# Write the caption.
+worksheet3.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet3.add_table('B3:F7', { :autofilter => 0 })
+
+# Table data can also be written separately, as an array or individual cells.
+worksheet3.write_col('B4', data)
+
+###############################################################################
+#
+# Example 4.
+#
+caption = 'Table without default header row.'
+
+# Set the columns widths.
+worksheet4.set_column('B:G', 12)
+
+# Write the caption.
+worksheet4.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet4.add_table('B4:F7', { :header_row => 0 })
+
+# Table data can also be written separately, as an array or individual cells.
+worksheet4.write_col('B4', data)
+
+###############################################################################
+#
+# Example 5.
+#
+caption = 'Default table with "First Column" and "Last Column" options.'
+
+# Set the columns widths.
+worksheet5.set_column('B:G', 12)
+
+# Write the caption.
+worksheet5.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet5.add_table('B3:F7', { :first_column => 1, :last_column => 1 })
+
+# Table data can also be written separately, as an array or individual cells.
+worksheet5.write_col('B4', data)
+
+###############################################################################
+#
+# Example 6.
+#
+caption = 'Table with banded columns but without default banded rows.';
+
+# Set the columns widths.
+worksheet6.set_column('B:G', 12)
+
+# Write the caption.
+worksheet6.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet6.add_table('B3:F7', { :banded_rows => 0, :banded_columns => 1 })
+
+# Table data can also be written separately, as an array or individual cells.
+worksheet6.write_col('B4', data)
+
+
+###############################################################################
+#
+# Example 7.
+#
+caption = 'Table with user defined column headers';
+
+# Set the columns widths.
+worksheet7.set_column('B:G', 12)
+
+# Write the caption.
+worksheet7.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet7.add_table(
+    'B3:F7',
+    {
+        :data    => data,
+        :columns => [
+            { :header => 'Product' },
+            { :header => 'Quarter 1' },
+            { :header => 'Quarter 2' },
+            { :header => 'Quarter 3' },
+            { :header => 'Quarter 4' }
+        ]
+    }
+)
+
+###############################################################################
+#
+# Example 8.
+#
+caption = 'Table with user defined column headers';
+
+# Set the columns widths.
+worksheet8.set_column('B:G', 12)
+
+# Write the caption.
+worksheet8.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet8.add_table(
+    'B3:G7',
+    {
+        :data    => data,
+        :columns => [
+            { :header => 'Product' },
+            { :header => 'Quarter 1' },
+            { :header => 'Quarter 2' },
+            { :header => 'Quarter 3' },
+            { :header => 'Quarter 4' },
+            {
+                :header  => 'Year',
+                :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
+            }
+        ]
+    }
+)
+
+
+###############################################################################
+#
+# Example 9.
+#
+caption = 'Table with totals row (but no caption or totals).';
+
+# Set the columns widths.
+worksheet9.set_column('B:G', 12)
+
+# Write the caption.
+worksheet9.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet9.add_table(
+    'B3:G8',
+    {
+        :data      => data,
+        :total_row => 1,
+        :columns   => [
+            { :header => 'Product' },
+            { :header => 'Quarter 1' },
+            { :header => 'Quarter 2' },
+            { :header => 'Quarter 3' },
+            { :header => 'Quarter 4' },
+            {
+                :header  => 'Year',
+                :formula => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])'
+            }
+        ]
+    }
+)
+
+
+###############################################################################
+#
+# Example 10.
+#
+caption = 'Table with totals row with user captions and functions.';
+
+# Set the columns widths.
+worksheet10.set_column('B:G', 12)
+
+# Write the caption.
+worksheet10.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet10.add_table(
+    'B3:G8',
+    {
+        :data      => data,
+        :total_row => 1,
+        :columns   => [
+            { :header => 'Product',   :total_string   => 'Totals' },
+            { :header => 'Quarter 1', :total_function => 'sum' },
+            { :header => 'Quarter 2', :total_function => 'sum' },
+            { :header => 'Quarter 3', :total_function => 'sum' },
+            { :header => 'Quarter 4', :total_function => 'sum' },
+            {
+                :header         => 'Year',
+                :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+                :total_function => 'sum'
+            }
+        ]
+    }
+)
+
+
+###############################################################################
+#
+# Example 11.
+#
+caption = 'Table with alternative Excel style.';
+
+# Set the columns widths.
+worksheet11.set_column('B:G', 12)
+
+# Write the caption.
+worksheet11.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet11.add_table(
+    'B3:G8',
+    {
+        :data      => data,
+        :style     => 'Table Style Light 11',
+        :total_row => 1,
+        :columns   => [
+            { :header => 'Product',   :total_string   => 'Totals' },
+            { :header => 'Quarter 1', :total_function => 'sum' },
+            { :header => 'Quarter 2', :total_function => 'sum' },
+            { :header => 'Quarter 3', :total_function => 'sum' },
+            { :header => 'Quarter 4', :total_function => 'sum' },
+            {
+                :header         => 'Year',
+                :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+                :total_function => 'sum'
+            }
+        ]
+    }
+)
+
+
+###############################################################################
+#
+# Example 12.
+#
+caption = 'Table with column formats.';
+
+# Set the columns widths.
+worksheet12.set_column('B:G', 12)
+
+# Write the caption.
+worksheet12.write('B1', caption)
+
+# Add a table to the worksheet.
+worksheet12.add_table(
+    'B3:G8',
+    {
+        :data      => data,
+        :total_row => 1,
+        :columns   => [
+            { :header => 'Product', :total_string => 'Totals' },
+            {
+                :header         => 'Quarter 1',
+                :total_function => 'sum',
+                :format         => currency_format,
+            },
+            {
+                :header         => 'Quarter 2',
+                :total_function => 'sum',
+                :format         => currency_format,
+            },
+            {
+                :header         => 'Quarter 3',
+                :total_function => 'sum',
+                :format         => currency_format,
+            },
+            {
+                :header         => 'Quarter 4',
+                :total_function => 'sum',
+                :format         => currency_format,
+            },
+            {
+                :header         => 'Year',
+                :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+                :total_function => 'sum',
+                :format         => currency_format,
+            }
+        ]
+    }
+)
+
+workbook.close