write_xlsx 0.61.0 → 0.62.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = write_xlsx
 
-gem to create a new file in the Excel 2007+ XLSX format, and you can use the same interface as writeexcel gem. write_xlsx is converted from Perl's module Excel::Writer::XLSX-0.60, https://github.com/jmcnamara/excel-writer-xlsx .
+gem to create a new file in the Excel 2007+ XLSX format, and you can use the same interface as writeexcel gem. write_xlsx is converted from Perl's module Excel::Writer::XLSX-0.62, https://github.com/jmcnamara/excel-writer-xlsx .
 
 == Description
 
@@ -75,6 +75,10 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
   workbook.close
 
 == Recent change
+2013-02-24 v0.62.0
+  Added option for adding a data table to a Chart X-axis.
+  See output from chart_data_table.rb example.
+
 2013-02-23 v0.61.0
   Allow a cell url string to be over written with a number or formula
   using a second write() call to the same cell. The url remains intact.

data/examples/chart_data_table.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A demo of an Column chart with a data table on the X-axis using
+# WriteXLSX.
+#
+# reverse ('(c)'), December 2012, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_data_table.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = [ 'Number', 'Batch 1', 'Batch 2' ]
+data = [
+    [ 2, 3, 4, 5, 6, 7 ],
+    [ 10, 40, 50, 20, 10, 50 ],
+    [ 30, 60, 70, 50, 40, 30 ]
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write('A2', data)
+
+# Create a new column chart with a data table.
+chart1 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the first series.
+chart1.add_series(
+    :name       => '=Sheet1!$B$1',
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Configure second series. Note alternative use of array ref to define
+# ranges: [ sheetname, row_start, row_end, col_start, col_end ].
+chart1.add_series(
+    :name       => '=Sheet1!$C$1',
+    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart1.set_title(:name => 'Chart with Data Table')
+chart1.set_x_axis(:name => 'Test number')
+chart1.set_y_axis(:name => 'Sample length (mm)')
+
+# Set a default data table on the X-Axis.
+chart1.set_table
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D2', chart1, 25, 10)
+
+#
+# Create a second charat.
+#
+chart2 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the first series.
+chart2.add_series(
+    :name       => '=Sheet1!$B$1',
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Configure second series. Note alternative use of array ref to define
+# ranges: [ sheetname, row_start, row_end, col_start, col_end ].
+chart2.add_series(
+    :name       => '=Sheet1!$C$1',
+    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart2.set_title(:name => 'Data Table with legend keys')
+chart2.set_x_axis(:name => 'Test number')
+chart2.set_y_axis(:name => 'Sample length (mm)')
+
+# Set a default data table on the X-Axis with the legend keys shown.
+chart2.set_table(:show_keys => true)
+
+# Hide the chart legend since the keys are show on the data table.
+chart2.set_legend(:position => 'none')
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D18', chart2, 25, 11)
+
+workbook.close

data/lib/write_xlsx/chart.rb

@@ -3,6 +3,35 @@
 require 'write_xlsx/utility'
 
 module Writexlsx
+  class Table
+    include Writexlsx::Utility
+
+    attr_reader :horizontal, :vertical, :outline, :show_keys
+
+    def initialize(params = {})
+      @horizontal, @vertical, @outline, @show_keys = true, true, true, false
+      @horizontal = params[:horizontal] if params.has_key?(:horizontal)
+      @vertical   = params[:vertical]   if params.has_key?(:vertical)
+      @outline    = params[:outline]    if params.has_key?(:outline)
+      @show_keys  = params[:show_keys]  if params.has_key?(:show_keys)
+    end
+
+    def write_d_table(writer)
+      writer.tag_elements('c:dTable') do
+        writer.empty_tag('c:showHorzBorder', attributes) if ptrue?(horizontal)
+        writer.empty_tag('c:showVertBorder', attributes) if ptrue?(vertical)
+        writer.empty_tag('c:showOutline',    attributes) if ptrue?(outline)
+        writer.empty_tag('c:showKeys',       attributes) if ptrue?(show_keys)
+      end
+    end
+
+    private
+
+    def attributes
+      ['val', 1]
+    end
+  end
+
   # ==SYNOPSIS
   #
   # To create a simple Excel file with a chart using WriteXLSX:
@@ -512,6 +541,7 @@ def initialize(subtype)   # :nodoc:
       @y_scale           = 1
       @x_offset          = 0
       @y_offset          = 0
+      @table             = nil
 
       set_default_properties
     end
@@ -975,7 +1005,7 @@ def show_hidden_data
     #
     # Set dimensions for scale for the chart.
     #
-    def size(params = {})
+    def set_size(params = {})
       @width    = params[:width]    if params[:width]
       @height   = params[:height]   if params[:height]
       @x_scale  = params[:x_scale]  if params[:x_scale]
@@ -984,6 +1014,28 @@ def size(params = {})
       @y_offset = params[:y_offset] if params[:y_offset]
     end
 
+    # Backward compatibility with poorly chosen method name.
+    alias :size :set_size
+
+    #
+    # The set_table method adds a data table below the horizontal axis with the
+    # data used to plot the chart.
+    #
+    #    chart.set_table
+    #
+    # The available options, with default values are:
+    #
+    #    :vertical   => true    # Display vertical lines in the table.
+    #    :horizontal => true    # Display horizontal lines in the table.
+    #    :outline    => true    # Display an outline in the table.
+    #    :show_keys  => false   # Show the legend keys with the table data.
+    #
+    # The data table can only be shown with Bar, Column, Line, Area and Stock charts.
+    #
+    def set_table(params = {})
+      @table = Table.new(params)
+    end
+
     #
     # Setup the default configuration data for an embedded chart.
     #
@@ -1753,6 +1805,9 @@ def write_plot_area_base(type = nil) # :nodoc:
         write_val_axis(params)
         write_cat_or_date_axis(params, type)
 
+        # Write the c:dTable element.
+        write_d_table
+
         # Write the c:spPr element for the plotarea formatting.
         write_sp_pr(@plotarea)
       end
@@ -3436,6 +3491,13 @@ def write_a_latin(args)  # :nodoc:
       @writer.empty_tag('a:latin', args)
     end
 
+    #
+    # Write the <c:dTable> element.
+    #
+    def write_d_table
+      @table.write_d_table(@writer) if @table
+    end
+
     def nil_or_max?(val)  # :nodoc:
       val.nil? || val == 'max'
     end

data/lib/write_xlsx/version.rb

@@ -1,5 +1,5 @@
 require 'write_xlsx/workbook'
 
 class WriteXLSX < Writexlsx::Workbook
-  VERSION = "0.61.0"
+  VERSION = "0.62.0"
 end

data/lib/write_xlsx/worksheet.rb

@@ -2802,7 +2802,7 @@ def insert_chart(*args)
       raise "Not a Chart object in insert_chart()" unless chart.is_a?(Chart) || chart.is_a?(Chartsheet)
       raise "Not a embedded style Chart object in insert_chart()" if chart.respond_to?(:embedded) && chart.embedded == 0
 
-      # Use the values set with chart.size, if any.
+      # Use the values set with chart.set_size, if any.
       x_scale  = chart.x_scale  if chart.x_scale  != 1
       y_scale  = chart.y_scale  if chart.y_scale  != 1
       x_offset = chart.x_offset if ptrue?(chart.x_offset)

data/test/regression/test_chart_size01.rb

@@ -31,7 +31,7 @@ def test_chart_size01
     chart.add_series(:values => '=Sheet1!$B$1:$B$5')
     chart.add_series(:values => '=Sheet1!$C$1:$C$5')
 
-    chart.size(:width => 512, :height => 320)
+    chart.set_size(:width => 512, :height => 320)
 
     worksheet.insert_chart('E9', chart)
 

data/test/regression/test_chart_size02.rb

@@ -31,7 +31,7 @@ def test_chart_size02
     chart.add_series(:values => '=Sheet1!$B$1:$B$5')
     chart.add_series(:values => '=Sheet1!$C$1:$C$5')
 
-    chart.size(:x_scale => 1.066666666, :y_scale => 1.11111111)
+    chart.set_size(:x_scale => 1.066666666, :y_scale => 1.11111111)
 
     worksheet.insert_chart('E9', chart)
 

data/test/regression/test_chart_table01.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestChartTable01 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_table01
+    @xlsx = 'chart_table01.xlsx'
+    workbook   = WriteXLSX.new(@xlsx)
+    worksheet  = workbook.add_worksheet
+    chart      = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xls file.
+    chart.instance_variable_set(:@axis_ids, [61355520, 61357056])
+
+    data = [
+            [ 1, 2, 3, 4,  5 ],
+            [ 2, 4, 6, 8,  10 ],
+            [ 3, 6, 9, 12, 15 ]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(:values => '=Sheet1!$A$1:$A$5')
+    chart.add_series(:values => '=Sheet1!$B$1:$B$5')
+    chart.add_series(:values => '=Sheet1!$C$1:$C$5')
+
+    # Test the default table.
+    chart.set_table
+
+    worksheet.insert_chart('E9',  chart)
+
+    workbook.close
+    compare_xlsx_for_regression(
+                                File.join(@regression_output, @xlsx),
+                                @xlsx
+                                )
+  end
+end

data/test/regression/test_chart_table02.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestChartTable02 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_table02
+    @xlsx = 'chart_table02.xlsx'
+    workbook   = WriteXLSX.new(@xlsx)
+    worksheet  = workbook.add_worksheet
+    chart      = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xls file.
+    chart.instance_variable_set(:@axis_ids, [61354368, 61355904])
+
+    data = [
+            [ 1, 2, 3, 4,  5 ],
+            [ 2, 4, 6, 8,  10 ],
+            [ 3, 6, 9, 12, 15 ]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(:values => '=Sheet1!$A$1:$A$5')
+    chart.add_series(:values => '=Sheet1!$B$1:$B$5')
+    chart.add_series(:values => '=Sheet1!$C$1:$C$5')
+
+    # Test the default table.
+    chart.set_table(
+                    :vertical   => false,
+                    :horizontal => false,
+                    :outline    => false,
+                    :show_keys  => true
+                    )
+
+    worksheet.insert_chart('E9',  chart)
+
+    workbook.close
+    compare_xlsx_for_regression(
+                                File.join(@regression_output, @xlsx),
+                                @xlsx
+                                )
+  end
+end

data/test/test_example_match.rb

@@ -4881,4 +4881,88 @@ def test_hide_row_col
     workbook.close
     compare_xlsx(File.join(@perl_output, @xlsx), @xlsx)
   end
+
+  def test_chart_data_table
+    @xlsx = 'chart_data_table.xlsx'
+    workbook = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+    bold      = workbook.add_format(:bold => 1)
+
+    # Add the worksheet data that the charts will refer to.
+    headings = [ 'Number', 'Batch 1', 'Batch 2' ]
+    data = [
+            [ 2, 3, 4, 5, 6, 7 ],
+            [ 10, 40, 50, 20, 10, 50 ],
+            [ 30, 60, 70, 50, 40, 30 ]
+           ]
+
+    worksheet.write('A1', headings, bold)
+    worksheet.write('A2', data)
+
+    # Create a new column chart with a data table.
+    chart1 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Configure the first series.
+    chart1.add_series(
+                      :name       => '=Sheet1!$B$1',
+                      :categories => '=Sheet1!$A$2:$A$7',
+                      :values     => '=Sheet1!$B$2:$B$7'
+                      )
+
+    # Configure second series. Note alternative use of array ref to define
+    # ranges: [ sheetname, row_start, row_end, col_start, col_end ].
+    chart1.add_series(
+                      :name       => '=Sheet1!$C$1',
+                      :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+                      :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+                      )
+
+    # Add a chart title and some axis labels.
+    chart1.set_title(:name => 'Chart with Data Table')
+    chart1.set_x_axis(:name => 'Test number')
+    chart1.set_y_axis(:name => 'Sample length (mm)')
+
+    # Set a default data table on the X-Axis.
+    chart1.set_table
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D2', chart1, 25, 10)
+
+    #
+    # Create a second charat.
+    #
+    chart2 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Configure the first series.
+    chart2.add_series(
+                      :name       => '=Sheet1!$B$1',
+                      :categories => '=Sheet1!$A$2:$A$7',
+                      :values     => '=Sheet1!$B$2:$B$7'
+                      )
+
+    # Configure second series. Note alternative use of array ref to define
+    # ranges: [ sheetname, row_start, row_end, col_start, col_end ].
+    chart2.add_series(
+                      :name       => '=Sheet1!$C$1',
+                      :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+                      :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+                      )
+
+    # Add a chart title and some axis labels.
+    chart2.set_title(:name => 'Data Table with legend keys')
+    chart2.set_x_axis(:name => 'Test number')
+    chart2.set_y_axis(:name => 'Sample length (mm)')
+
+    # Set a default data table on the X-Axis with the legend keys shown.
+    chart2.set_table(:show_keys => true)
+
+    # Hide the chart legend since the keys are show on the data table.
+    chart2.set_legend(:position => 'none')
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D18', chart2, 25, 11)
+
+    workbook.close
+    compare_xlsx(File.join(@perl_output, @xlsx), @xlsx)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 0.61.0
+  version: 0.62.0
   prerelease: 
 platform: ruby
 authors:
@@ -61,6 +61,7 @@ files:
 - examples/chart_area.rb
 - examples/chart_bar.rb
 - examples/chart_column.rb
+- examples/chart_data_table.rb
 - examples/chart_line.rb
 - examples/chart_pie.rb
 - examples/chart_radar.rb
@@ -262,6 +263,7 @@ files:
 - test/perl_output/chart_area.xlsx
 - test/perl_output/chart_bar.xlsx
 - test/perl_output/chart_column.xlsx
+- test/perl_output/chart_data_table.xlsx
 - test/perl_output/chart_line.xlsx
 - test/perl_output/chart_pie.xlsx
 - test/perl_output/chart_radar.xlsx
@@ -474,6 +476,8 @@ files:
 - test/regression/test_chart_stock02.rb
 - test/regression/test_chart_str01.rb
 - test/regression/test_chart_str02.rb
+- test/regression/test_chart_table01.rb
+- test/regression/test_chart_table02.rb
 - test/regression/test_chartsheet01.rb
 - test/regression/test_chartsheet02.rb
 - test/regression/test_chartsheet03.rb
@@ -789,6 +793,8 @@ files:
 - test/regression/xlsx_files/chart_stock02.xlsx
 - test/regression/xlsx_files/chart_str01.xlsx
 - test/regression/xlsx_files/chart_str02.xlsx
+- test/regression/xlsx_files/chart_table01.xlsx
+- test/regression/xlsx_files/chart_table02.xlsx
 - test/regression/xlsx_files/chartsheet01.xlsx
 - test/regression/xlsx_files/chartsheet02.xlsx
 - test/regression/xlsx_files/chartsheet03.xlsx
@@ -1205,6 +1211,7 @@ test_files:
 - test/perl_output/chart_area.xlsx
 - test/perl_output/chart_bar.xlsx
 - test/perl_output/chart_column.xlsx
+- test/perl_output/chart_data_table.xlsx
 - test/perl_output/chart_line.xlsx
 - test/perl_output/chart_pie.xlsx
 - test/perl_output/chart_radar.xlsx
@@ -1417,6 +1424,8 @@ test_files:
 - test/regression/test_chart_stock02.rb
 - test/regression/test_chart_str01.rb
 - test/regression/test_chart_str02.rb
+- test/regression/test_chart_table01.rb
+- test/regression/test_chart_table02.rb
 - test/regression/test_chartsheet01.rb
 - test/regression/test_chartsheet02.rb
 - test/regression/test_chartsheet03.rb
@@ -1732,6 +1741,8 @@ test_files:
 - test/regression/xlsx_files/chart_stock02.xlsx
 - test/regression/xlsx_files/chart_str01.xlsx
 - test/regression/xlsx_files/chart_str02.xlsx
+- test/regression/xlsx_files/chart_table01.xlsx
+- test/regression/xlsx_files/chart_table02.xlsx
 - test/regression/xlsx_files/chartsheet01.xlsx
 - test/regression/xlsx_files/chartsheet02.xlsx
 - test/regression/xlsx_files/chartsheet03.xlsx