write_xlsx 0.57.0 → 0.58.0

data/README.rdoc

@@ -74,6 +74,9 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
   workbook.close
 
 == Recent change
+2013-02-10 v0.58.0
+ Added chart area and plot area formatting.
+
 2013-02-10 v0.57.0
  Add major and minor axis chart gridline formatting.
 

data/lib/write_xlsx/chart.rb

@@ -494,6 +494,8 @@ def initialize(subtype)   # :nodoc:
       @horiz_cat_axis    = 0
       @horiz_val_axis    = 1
       @protection        = 0
+      @chartarea         = {}
+      @plotarea          = {}
       @x_axis            = {}
       @y_axis            = {}
       @x2_axis           = {}
@@ -531,6 +533,9 @@ def assemble_xml_file   # :nodoc:
         # Write the c:chart element.
         write_chart
 
+        # Write the c:spPr element for the chartarea formatting.
+        write_sp_pr(@chartarea)
+
         # Write the c:printSettings element.
         write_print_settings if @embedded && @embedded != 0
       end
@@ -897,9 +902,8 @@ def set_legend(params)
     # set_style() method.
     #
     def set_plotarea(params)
-
-      # TODO. Need to refactor for XLSX format.
-      return
+      # Convert the user defined properties to internal properties.
+      @plotarea = get_area_properties(params)
     end
 
     #
@@ -913,8 +917,8 @@ def set_plotarea(params)
     # set_style() method.
     #
     def set_chartarea(params)
-      # TODO. Need to refactor for XLSX format.
-      return
+      # Convert the user defined properties to internal properties.
+      @chartarea = get_area_properties(params)
     end
 
     #
@@ -1201,6 +1205,58 @@ def get_palette_color(index) # :nodoc:
       sprintf("%02X%02X%02X", *rgb)
     end
 
+    #
+    # Get the Spreadsheet::WriteExcel line pattern for backward compatibility.
+    #
+    def get_swe_line_pattern(val)
+      value   = val.downcase
+      default = 'solid'
+
+      patterns = {
+        0              => 'solid',
+        1              => 'dash',
+        2              => 'dot',
+        3              => 'dash_dot',
+        4              => 'long_dash_dot_dot',
+        5              => 'none',
+        6              => 'solid',
+        7              => 'solid',
+        8              => 'solid',
+        'solid'        => 'solid',
+        'dash'         => 'dash',
+        'dot'          => 'dot',
+        'dash-dot'     => 'dash_dot',
+        'dash-dot-dot' => 'long_dash_dot_dot',
+        'none'         => 'none',
+        'dark-gray'    => 'solid',
+        'medium-gray'  => 'solid',
+        'light-gray'   => 'solid'
+      }
+
+      patterns[value] || default
+    end
+
+    #
+    # Get the Spreadsheet::WriteExcel line weight for backward compatibility.
+    #
+    def get_swe_line_weight(val)
+      value   = val.downcase
+      default = 1
+
+      weights = {
+        1          => 0.25,
+        2          => 1,
+        3          => 2,
+        4          => 3,
+        'hairline' => 0.25,
+        'narrow'   => 1,
+        'medium'   => 2,
+        'wide'     => 3
+      }
+
+      weights[value] || default
+    end
+
     #
     # Convert user defined line properties to the structure required internally.
     #
@@ -1368,6 +1424,51 @@ def get_labels_properties(labels) # :nodoc:
       labels
     end
 
+    #
+    # Convert user defined area properties to the structure required internally.
+    #
+    def get_area_properties(arg)  # :nodoc:
+      area = {}
+
+      # Map deprecated Spreadsheet::WriteExcel fill colour.
+      arg[:fill] = { :color => arg[:color] } if arg[:color]
+
+      # Map deprecated Spreadsheet::WriteExcel line_weight.
+      if arg[:line_weight]
+        width = get_swe_line_weight(arg[:line_weight])
+        arg[:border] = { :width => width }
+      end
+
+      # Map deprecated Spreadsheet::WriteExcel line_pattern.
+      if arg[:line_pattern]
+        pattern = get_swe_line_pattern(arg[:line_pattern])
+        if pattern == 'none'
+          arg[:border] = { :none => 1 }
+        else
+          arg[:border][:dash_type] = pattern
+        end
+      end
+
+      # Map deprecated Spreadsheet::WriteExcel line colour.
+      arg[:border][:color] = arg[:line_color] if arg[:line_color]
+
+      # Handle Excel::Writer::XLSX style properties.
+
+      # Set the line properties for the chartarea.
+      line = get_line_properties(arg[:line])
+
+      # Allow 'border' as a synonym for 'line'.
+      line = get_line_properties(arg[:border]) if (arg[:border])
+
+      # Set the fill properties for the chartarea.
+      fill = get_fill_properties(arg[:fill])
+
+      area[:_line] = line
+      area[:_fill] = fill
+
+      return area
+    end
+
     def value_or_raise(hash, key, msg)
       raise "Unknown #{msg} '#{key}'" unless hash[key.to_sym]
       hash[key.to_sym]
@@ -1631,6 +1732,9 @@ def write_plot_area_base(type = nil) # :nodoc:
         }
         write_val_axis(params)
         write_cat_or_date_axis(params, type)
+
+        # Write the c:spPr element for the plotarea formatting.
+        write_sp_pr(@plotarea)
       end
     end
 
@@ -2935,7 +3039,7 @@ def write_sp_pr(series) # :nodoc:
           end
         end
         # Write the a:ln element.
-        write_a_ln(series[:_line]) if series[:_line] && series[:_line][:_defined] != 0
+        write_a_ln(series[:_line]) if series[:_line] && ptrue?(series[:_line][:_defined])
       end
     end
 

data/lib/write_xlsx/chart/scatter.rb

@@ -169,6 +169,9 @@ def write_plot_area
                          :axis_ids => @axis2_ids,
                          :position => 'l'
                          )
+
+          # Write the c:spPr element for the plotarea formatting.
+          write_sp_pr(@plotarea)
         end
       end
 

data/lib/write_xlsx/version.rb

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

data/test/regression/test_chart_chartarea01.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartChartArea01 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_chartarea01
+    @xlsx = 'chart_chartarea01.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 xlsx file.
+    chart.instance_variable_set(:@axis_ids, [82933248, 82952960])
+
+    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')
+
+    chart.set_chartarea(
+                        :border => { :none  => 1 },
+                        :fill   => { :color => 'red' }
+                        )
+    chart.set_plotarea(
+                       :border => {
+                         :color  => 'yellow',
+                         :width  => 1,
+                         :dash_type => 'dash'
+                       },
+                       :fill   => { :color => '#92D050' }
+                       )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end

data/test/regression/test_chart_chartarea02.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartChartArea02 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_chartarea02
+    @xlsx = 'chart_chartarea01.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 xlsx file.
+    chart.instance_variable_set(:@axis_ids, [82933248, 82952960])
+
+    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 deprecated writeexcel interface.
+    chart.set_chartarea(
+                        :line_pattern => 'none',
+                        :color        => 'red'
+                        )
+
+    chart.set_plotarea(
+                       :line_pattern => 'dash',
+                       :line_weight  => 'narrow',
+                       :line_color   => 'yellow',
+                       :color        => '#92D050'
+                       )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end

data/test/regression/test_chart_chartarea03.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartChartArea03 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_chartarea03
+    @xlsx = 'chart_chartarea03.xlsx'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'scatter', :embedded => 1)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [46210048, 46208512])
+
+    data = [
+            [1, 2, 3,  4,  5],
+            [2, 4, 6,  8, 10],
+            [3, 6, 9, 12, 15]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(
+                     :categories => '=Sheet1!$A$1:$A$5',
+                     :values     => '=Sheet1!$B$1:$B$5'
+                     )
+    chart.add_series(
+                     :categories => '=Sheet1!$A$1:$A$5',
+                     :values     => '=Sheet1!$C$1:$C$5'
+                     )
+
+    # Test the deprecated writeexcel interface.
+    chart.set_chartarea(
+                        :border => { :dash_type => 'round_dot' },
+                        :fill   => { :color     => '#9999FF' }
+                        )
+
+    chart.set_plotarea(
+                       :border => { :dash_type => 'square_dot' },
+                       :fill   => { :color     => '#FFC000' }
+                       )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end

data/test/regression/test_chart_chartarea04.rb

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartChartArea04 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_chartarea04
+    @xlsx = 'chart_chartarea04.xlsx'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'stock', :embedded => 1)
+    date_format = workbook.add_format(:num_format => 14)
+
+    # For testing, copy the randomly generated axis ids in the target xlsx file.
+    chart.instance_variable_set(:@axis_ids, [82954112, 82956288])
+
+    data = [
+            [ '2007-01-01T', '2007-01-02T', '2007-01-03T', '2007-01-04T', '2007-01-05T' ],
+            [ 27.2,  25.03, 19.05, 20.34, 18.5 ],
+            [ 23.49, 19.55, 15.12, 17.84, 16.34 ],
+            [ 25.45, 23.05, 17.32, 20.45, 17.34 ]
+           ]
+
+    (0..4).each do |row|
+      worksheet.write_date_time(row, 0, data[0][row], date_format)
+      worksheet.write(row, 1, data[1][row])
+      worksheet.write(row, 2, data[2][row])
+      worksheet.write(row, 3, data[3][row])
+    end
+
+    worksheet.set_column('A:D', 11)
+
+    chart.add_series(
+                     :categories => '=Sheet1!$A$1:$A$5',
+                     :values     => '=Sheet1!$B$1:$B$5'
+                     )
+    chart.add_series(
+                     :categories => '=Sheet1!$A$1:$A$5',
+                     :values     => '=Sheet1!$C$1:$C$5'
+                     )
+    chart.add_series(
+                     :categories => '=Sheet1!$A$1:$A$5',
+                     :values     => '=Sheet1!$D$1:$D$5'
+                     )
+
+    # Test the deprecated writeexcel interface.
+    chart.set_chartarea(
+                        :border => { :color => '#FF0000' },
+                        :fill   => { :color => '#00B050' }
+                        )
+
+    chart.set_plotarea(
+                       :border => { :dash_type => 'dash_dot' },
+                       :fill   => { :color     => '#FFC000' }
+                       )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(
+                                File.join(@regression_output, @xlsx),
+                                @xlsx,
+                                [],
+                                {'xl/charts/chart1.xml' => ['<c:formatCode']}
+                                )
+  end
+end

data/test/regression/test_chart_chartarea05.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartChartArea05 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_chartarea05
+    @xlsx = 'chart_chartarea05.xlsx'
+    workbook  = WriteXLSX.new(@xlsx)
+    worksheet = workbook.add_worksheet
+    chart     = workbook.add_chart(:type => 'pie', :embedded => 1)
+
+    data = [
+            [2, 4, 6],
+            [60, 30, 10]
+           ]
+
+    worksheet.write('A1', data)
+
+    chart.add_series(
+                     :categories => '=Sheet1!$A$1:$A$3',
+                     :values     => '=Sheet1!$B$1:$B$3'
+                     )
+
+    chart.set_chartarea(
+                        :border => {
+                          :color     => '#FFFF00',
+                          :dash_type => 'long_dash'
+                        },
+                        :fill   => { :color     => '#92D050' }
+                        )
+
+    # This should be ignored for a pie chart.
+    chart.set_plotarea(
+                       :border => { :dash_type => 'dash_dot' },
+                       :fill   => { :color     => '#FFC000' }
+                       )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.58.0
   prerelease: 
 platform: ruby
 authors:
@@ -387,6 +387,11 @@ files:
 - test/regression/test_chart_blank04.rb
 - test/regression/test_chart_blank05.rb
 - test/regression/test_chart_blank06.rb
+- test/regression/test_chart_chartarea01.rb
+- test/regression/test_chart_chartarea02.rb
+- test/regression/test_chart_chartarea03.rb
+- test/regression/test_chart_chartarea04.rb
+- test/regression/test_chart_chartarea05.rb
 - test/regression/test_chart_column01.rb
 - test/regression/test_chart_column02.rb
 - test/regression/test_chart_column03.rb
@@ -682,6 +687,10 @@ files:
 - test/regression/xlsx_files/chart_blank04.xlsx
 - test/regression/xlsx_files/chart_blank05.xlsx
 - test/regression/xlsx_files/chart_blank06.xlsx
+- test/regression/xlsx_files/chart_chartarea01.xlsx
+- test/regression/xlsx_files/chart_chartarea03.xlsx
+- test/regression/xlsx_files/chart_chartarea04.xlsx
+- test/regression/xlsx_files/chart_chartarea05.xlsx
 - test/regression/xlsx_files/chart_column01.xlsx
 - test/regression/xlsx_files/chart_column02.xlsx
 - test/regression/xlsx_files/chart_column03.xlsx
@@ -1286,6 +1295,11 @@ test_files:
 - test/regression/test_chart_blank04.rb
 - test/regression/test_chart_blank05.rb
 - test/regression/test_chart_blank06.rb
+- test/regression/test_chart_chartarea01.rb
+- test/regression/test_chart_chartarea02.rb
+- test/regression/test_chart_chartarea03.rb
+- test/regression/test_chart_chartarea04.rb
+- test/regression/test_chart_chartarea05.rb
 - test/regression/test_chart_column01.rb
 - test/regression/test_chart_column02.rb
 - test/regression/test_chart_column03.rb
@@ -1581,6 +1595,10 @@ test_files:
 - test/regression/xlsx_files/chart_blank04.xlsx
 - test/regression/xlsx_files/chart_blank05.xlsx
 - test/regression/xlsx_files/chart_blank06.xlsx
+- test/regression/xlsx_files/chart_chartarea01.xlsx
+- test/regression/xlsx_files/chart_chartarea03.xlsx
+- test/regression/xlsx_files/chart_chartarea04.xlsx
+- test/regression/xlsx_files/chart_chartarea05.xlsx
 - test/regression/xlsx_files/chart_column01.xlsx
 - test/regression/xlsx_files/chart_column02.xlsx
 - test/regression/xlsx_files/chart_column03.xlsx