writeexcel 0.1.0 → 0.3.0

data/examples/chart_pie.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/ruby -w
+#
+###############################################################################
+#
+# A simple demo of Pie chart in Spreadsheet::WriteExcel.
+#
+# reverse('ｩ'), December 2009, 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 called simple.xls and add a worksheet
+workbook  = WriteExcel.new('chart_pie.xls')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = ['Category', 'Values']
+data = [
+    [ 'Apple', 'Cherry', 'Pecan' ],
+    [ 60,       30,       10     ]
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write('A2', data)
+
+
+###############################################################################
+#
+# Example 1. A minimal chart.
+#
+chart1 = workbook.add_chart(:type => Chart::Pie)
+
+# Add values only. Use the default categories.
+chart1.add_series(:values => '=Sheet1!$B$2:$B$4')
+
+###############################################################################
+#
+# Example 2. A minimal chart with user specified categories and a series name.
+#
+chart2 = workbook.add_chart(:type => Chart::Pie)
+
+# Configure the series.
+chart2.add_series(
+  :categories => '=Sheet1!$A$2:$A$4',
+  :values     => '=Sheet1!$B$2:$B$4',
+  :name       => 'Pie sales data'
+)
+
+###############################################################################
+#
+# Example 3. Same as previous chart but with an added title.
+#
+chart3 = workbook.add_chart(:type => Chart::Pie)
+
+# Configure the series.
+chart3.add_series(
+  :categories => '=Sheet1!$A$2:$A$4',
+  :values     => '=Sheet1!$B$2:$B$4',
+  :name       => 'Pie sales data'
+)
+
+# Add a title.
+chart3.set_title(:name => 'Popular Pie Types')
+
+###############################################################################
+#
+# Example 4. Same as previous chart with a user specified chart sheet name.
+#
+chart4 = workbook.add_chart(:name => 'Results Chart', :type => Chart::Pie)
+
+# Configure the series.
+chart4.add_series(
+  :categories => '=Sheet1!$A$2:$A$4',
+  :values     => '=Sheet1!$B$2:$B$4',
+  :name       => 'Pie sales data'
+)
+
+# The other chart_*.rb examples add a second series in example 4 but additional
+# series aren't plotted in a pie chart.
+
+# Add a title.
+chart4.set_title(:name => 'Popular Pie Types')
+
+###############################################################################
+#
+# Example 5. Same as Example 3 but as an embedded chart.
+#
+chart5 = workbook.add_chart(:type => Chart::Pie, :embedded => 1)
+
+# Configure the series.
+chart5.add_series(
+  :categories => '=Sheet1!$A$2:$A$4',
+  :values     => '=Sheet1!$B$2:$B$4',
+  :name       => 'Pie sales data'
+)
+
+# Add a title.
+chart5.set_title(:name => 'Popular Pie Types')
+
+# Insert the chart into the main worksheet.
+worksheet.insert_chart('D2', chart5)
+
+# File save
+workbook.close

data/examples/chart_scatter.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/ruby -w
+#
+###############################################################################
+#
+# A simple demo of Scatter charts in Spreadsheet::WriteExcel.
+#
+# reverse('ｩ'), December 2009, 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 called simple.xls and add a worksheet
+workbook  = WriteExcel.new('chart_scatter.xls')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = ['Category', 'Values 1', 'Values 2']
+data = [
+  [ 2, 3, 4, 5, 6, 7 ],
+  [ 1, 4, 5, 2, 1, 5 ],
+  [ 3, 6, 7, 5, 4, 3 ]
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write('A2', data)
+
+
+###############################################################################
+#
+# Example 1. A minimal chart.
+#
+chart1 = workbook.add_chart(:type => Chart::Scatter)
+
+# Add values only. Use the default categories.
+chart1.add_series(:values => '=Sheet1!$B$2:$B$7')
+
+###############################################################################
+#
+# Example 2. A minimal chart with user specified categories (X axis)
+#            and a series name.
+#
+chart2 = workbook.add_chart(:type => Chart::Scatter)
+
+# Configure the series.
+chart2.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7',
+  :name       => 'Test data series 1'
+)
+
+###############################################################################
+#
+# Example 3. Same as previous chart but with added title and axes labels.
+#
+chart3 = workbook.add_chart(:type => Chart::Scatter)
+
+# Configure the series.
+chart3.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7',
+  :name       => 'Test data series 1'
+)
+
+# Add some labels.
+chart3.set_title(:name => 'Results of sample analysis')
+chart3.set_x_axis(:name => 'Sample number')
+chart3.set_y_axis(:name => 'Sample length (cm)')
+
+###############################################################################
+#
+# Example 4. Same as previous chart but with an added series and with a
+#            user specified chart sheet name.
+#
+chart4 = workbook.add_chart(:name => 'Results Chart', :type => Chart::Scatter)
+
+# Configure the series.
+chart4.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7',
+  :name       => 'Test data series 1'
+)
+
+# Add another series.
+chart4.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$C$2:$C$7',
+  :name       => 'Test data series 2'
+)
+
+# Add some labels.
+chart4.set_title(:name => 'Results of sample analysis')
+chart4.set_x_axis(:name => 'Sample number')
+chart4.set_y_axis(:name => 'Sample length (cm)')
+
+###############################################################################
+#
+# Example 5. Same as Example 3 but as an embedded chart.
+#
+chart5 = workbook.add_chart(:type => Chart::Scatter, :embedded => 1)
+
+# Configure the series.
+chart5.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7',
+  :name       => 'Test data series 1'
+)
+
+# Add some labels.
+chart5.set_title(:name => 'Results of sample analysis')
+chart5.set_x_axis(:name => 'Sample number')
+chart5.set_y_axis(:name => 'Sample length (cm)')
+
+# Insert the chart into the main worksheet.
+worksheet.insert_chart('E2', chart5)
+
+# File save
+workbook.close

data/examples/chart_stock.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/ruby -w
+#
+###############################################################################
+#
+# A simple demo of Stock charts in Spreadsheet::WriteExcel.
+#
+# reverse('©'), January 2010, 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('chart_stock.xls')
+worksheet = workbook.add_worksheet
+
+###############################################################################
+#
+# Set up the data worksheet that the charts will refer to. We read the example
+# data from the __DATA__ section at the end of the file. This simulates
+# reading the data from a database or other source.
+#
+# The default Excel Stock chart is an Open-High-Low-Close chart. Therefore
+# we will need data for each of those series.
+#
+# The layout of the __DATA__ section is similar to the layout of the worksheet.
+#
+
+# Add some formats.
+bold        = workbook.add_format(:bold       => 1)
+date_format = workbook.add_format(:num_format => 'dd/mm/yyyy')
+
+# Increase the width of the column used for date to make it clearer.
+worksheet.set_column('A:A', 12)
+
+stock_data = [
+  %w(Date        Open    High    Low     Close),
+  ['2009-08-19', 100.00, 104.06, 95.96, 100.34],
+  ['2009-08-20', 101.01, 109.08, 100.50, 108.31],
+  ['2009-08-23', 110.75, 113.48, 109.05, 109.40],
+  ['2009-08-24', 111.24, 111.60, 103.57, 104.87],
+  ['2009-08-25', 104.96, 108.00, 103.88, 106.00],
+  ['2009-08-26', 104.95, 107.95, 104.66, 107.91],
+  ['2009-08-27', 108.10, 108.62, 105.69, 106.15],
+  ['2009-08-30', 105.28, 105.49, 102.01, 102.01],
+  ['2009-08-31', 102.30, 103.71, 102.16, 102.37]
+]
+
+# Write the data to the worksheet.
+row = 0
+col = 0
+
+headers = stock_data.shift
+worksheet.write(row, col, headers, bold)
+row += 1
+
+stock_data.each do |data|
+  date = data.shift
+  worksheet.write(row, col, date, date_format)
+  worksheet.write(row, col + 1, data)
+  row += 1
+end
+
+###############################################################################
+#
+# Example 1. A default Open-High-Low-Close chart with series names, axes labels
+#            and a title.
+#
+
+chart1 = workbook.add_chart(:type => Chart::Stock)
+
+# Add a series for each of the Open-High-Low-Close columns. The categories are
+# the dates in the first column.
+
+chart1.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$B$2:$B$10',
+  :name       => 'Open'
+)
+
+chart1.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$C$2:$C$10',
+  :name       => 'High'
+)
+
+chart1.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$D$2:$D$10',
+  :name       => 'Low'
+)
+
+chart1.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$E$2:$E$10',
+  :name       => 'Close'
+)
+
+# Add a chart title and axes labels.
+chart1.set_title(:name => 'Open-High-Low-Close')
+chart1.set_x_axis(:name => 'Date')
+chart1.set_y_axis(:name => 'Share price')
+
+###############################################################################
+#
+# Example 2. Same as the previous as an embedded chart.
+#
+
+chart2 = workbook.add_chart(:type => Chart::Stock, :embedded => 1)
+
+# Add a series for each of the Open-High-Low-Close columns. The categories are
+# the dates in the first column.
+
+chart2.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$B$2:$B$10',
+  :name       => 'Open'
+)
+
+chart2.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$C$2:$C$10',
+  :name       => 'High'
+)
+
+chart2.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$D$2:$D$10',
+  :name       => 'Low'
+)
+
+chart2.add_series(
+  :categories => '=Sheet1!$A$2:$A$10',
+  :values     => '=Sheet1!$E$2:$E$10',
+  :name       => 'Close'
+)
+
+# Add a chart title and axes labels.
+chart2.set_title(:name => 'Open-High-Low-Close')
+chart2.set_x_axis(:name => 'Date')
+chart2.set_y_axis(:name => 'Share price')
+
+# Insert the chart into the main worksheet.
+worksheet.insert_chart('G2', chart2)
+
+# File save
+workbook.close

data/examples/copyformat.rb

@@ -1,51 +1,51 @@
-#!/usr/bin/ruby -w
-
-###############################################################################
-#
-# Example of how to use the format copying method with Spreadsheet::WriteExcel #
-# 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 workbook1
-workbook1       = Spreadsheet::WriteExcel.new("workbook1.xls")
-worksheet1      = workbook1.add_worksheet
-format1a        = workbook1.add_format
-format1b        = workbook1.add_format
-
-# Create workbook2
-workbook2       = Spreadsheet::WriteExcel.new("workbook2.xls")
-worksheet2      = workbook2.add_worksheet
-format2a        = workbook2.add_format
-format2b        = workbook2.add_format
-
-# Create a global format object that isn't tied to a workbook
-global_format   = Format.new
-
-# Set the formatting
-global_format.set_color('blue')
-global_format.set_bold
-global_format.set_italic
-
-# Create another example format
-format1b.set_color('red')
-
-# Copy the global format properties to the worksheet formats
-format1a.copy(global_format)
-format2a.copy(global_format)
-
-# Copy a format from worksheet1 to worksheet2
-format2b.copy(format1b)
-
-# Write some output
-worksheet1.write(0, 0, "Ciao", format1a)
-worksheet1.write(1, 0, "Ciao", format1b)
-
-worksheet2.write(0, 0, "Hello", format2a)
-worksheet2.write(1, 0, "Hello", format2b)
-workbook1.close
-workbook2.close
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the format copying method with WriteExcel #
+# 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 workbook1
+workbook1       = WriteExcel.new("workbook1.xls")
+worksheet1      = workbook1.add_worksheet
+format1a        = workbook1.add_format
+format1b        = workbook1.add_format
+
+# Create workbook2
+workbook2       = WriteExcel.new("workbook2.xls")
+worksheet2      = workbook2.add_worksheet
+format2a        = workbook2.add_format
+format2b        = workbook2.add_format
+
+# Create a global format object that isn't tied to a workbook
+global_format   = Format.new
+
+# Set the formatting
+global_format.set_color('blue')
+global_format.set_bold
+global_format.set_italic
+
+# Create another example format
+format1b.set_color('red')
+
+# Copy the global format properties to the worksheet formats
+format1a.copy(global_format)
+format2a.copy(global_format)
+
+# Copy a format from worksheet1 to worksheet2
+format2b.copy(format1b)
+
+# Write some output
+worksheet1.write(0, 0, "Ciao", format1a)
+worksheet1.write(1, 0, "Ciao", format1b)
+
+worksheet2.write(0, 0, "Hello", format2a)
+worksheet2.write(1, 0, "Hello", format2b)
+workbook1.close
+workbook2.close