write_xlsx 0.87.0 → 0.88.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7cdfffc65c56b8de477d41c1126ebd46a7d6e63aee6d6660bab0e9283be2c6
-  data.tar.gz: c62748b94058a7021e796b88031b7d126b8508ce9ece50bdaa7455a620d8403b
+  metadata.gz: 994776679641b1907ecab841ff3f708bdf82e7db2347b12a7b3e06c3cf3de218
+  data.tar.gz: 47fefd5324ac9fc71d40b4fcdcd59c2679098c04ff793d4a96c0e9988e7170cb
 SHA512:
-  metadata.gz: 0042aea94458add0013ceefed1e734593692c00f9dc32d8b02fef80093b2e62d3510ef62e84481c74acbf0436e8fe8223485a562a76ec8fd011724e2869c5b1e
-  data.tar.gz: 0bb9fed1ec24707d52b7557c256579606c39eadb716bfdc4acb5e5e6b13f0792fb3627e75f16aef375675160d57556fff7f02af6fea8e4819bbdb244f96657e9
+  metadata.gz: 845c34594fea0e22e12663a4bc2912e48eef99de5685573d53c9ba74a89709d5a2ab25efd6eb76f799e1fd4b9913f1fe766d2010352058725389ef119e823c4e
+  data.tar.gz: e98541a0595e76f391a4dcd38f36b6f754cec385d6310fc169e088bd2f08b38cd4d0d10eebe1f44fd7bed2458bafc2f56fa7994d5bbe8982dc740f0b2ed7be0d

data/Changes

@@ -1,5 +1,11 @@
 Change history of write_xlsx rubygem.
 
+2020-12-26 v0.88.0
+
+   Added transparency option to solid fills in chart areas.
+
+   Added options to configure chart axis tick placement.
+
 2020-12-26 v0.87.0
 
    Added chart pattern and gradient fills.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Hideo NAKAMURA
+Copyright (c) 2012-2020 Hideo NAKAMURA
 
 MIT License
 

data/README.md

@@ -5,7 +5,7 @@
 
 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.86](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.88](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 

data/lib/write_xlsx/chart.rb

@@ -1285,6 +1285,9 @@ def write_cat_axis(params) # :nodoc:
         # Write the c:majorTickMark element.
         write_major_tick_mark(x_axis.major_tick_mark)
 
+        # Write the c:minorTickMark element.
+        write_minor_tick_mark(x_axis.minor_tick_mark)
+
         # Write the c:tickLblPos element.
         write_tick_label_pos(x_axis.label_position)
 
@@ -1359,6 +1362,9 @@ def write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)  # :no
         # Write the c:majorTickMark element.
         write_major_tick_mark(y_axis.major_tick_mark)
 
+        # Write the c:minorTickMark element.
+        write_minor_tick_mark(y_axis.minor_tick_mark)
+
         # Write the c:tickLblPos element.
         write_tick_label_pos(y_axis.label_position)
 
@@ -1581,6 +1587,15 @@ def write_major_tick_mark(val)
       @writer.empty_tag('c:majorTickMark', [ ['val', val] ])
     end
 
+    #
+    # Write the <c:minorTickMark> element.
+    #
+    def write_minor_tick_mark(val)
+      return unless ptrue?(val)
+
+      @writer.empty_tag('c:minorTickMark', [ ['val', val] ])
+    end
+
     #
     # Write the <c:tickLblPos> element.
     #
@@ -2187,18 +2202,38 @@ def write_a_no_fill # :nodoc:
     #
     # Write the <a:solidFill> element.
     #
-    def write_a_solid_fill(line) # :nodoc:
+    def write_a_solid_fill(fill) # :nodoc:
       @writer.tag_elements('a:solidFill') do
-        # Write the a:srgbClr element.
-        write_a_srgb_clr(color(line[:color])) if line[:color]
+        if fill[:color]
+          # Write the a:srgbClr element.
+          write_a_srgb_clr(color(fill[:color]), fill[:transparency])
+        end
       end
     end
 
     #
     # Write the <a:srgbClr> element.
     #
-    def write_a_srgb_clr(val) # :nodoc:
-      @writer.empty_tag('a:srgbClr', [ ['val', val] ])
+    def write_a_srgb_clr(color, transparency = nil) # :nodoc:
+      tag        = 'a:srgbClr'
+      attributes = [ ['val', color] ]
+
+      if ptrue?(transparency)
+        @writer.tag_elements(tag, attributes) do
+          write_a_alpha(transparency)
+        end
+      else
+        @writer.empty_tag(tag, attributes)
+      end
+     end
+
+    #
+    # Write the <a:alpha> element.
+    #
+    def write_a_alpha(val)
+      val = (100 - val.to_i) * 1000
+
+      @writer.empty_tag('a:alpha', [ ['val', val] ])
     end
 
     #

data/lib/write_xlsx/chart/axis.rb

@@ -9,7 +9,8 @@ class Axis < Caption
       include Writexlsx::Utility
 
       attr_accessor :defaults
-      attr_accessor :min, :max, :num_format, :position, :major_tick_mark
+      attr_accessor :min, :max, :num_format, :position
+      attr_accessor :major_tick_mark, :minor_tick_mark
       attr_reader :minor_unit, :major_unit, :minor_unit_type, :major_unit_type
       attr_reader :display_units_visible, :display_units
       attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
@@ -27,11 +28,11 @@ def merge_with_hash(params) # :nodoc:
           :reverse, :min, :max, :minor_unit, :major_unit, :minor_unit_type,
           :major_unit_type, :log_base, :crossing, :position_axis,
           :label_position, :num_format, :num_format_linked, :interval_unit,
-          :interval_tick, :major_tick_mark, :line, :fill
+          :interval_tick, :line, :fill
         ].each { |val| instance_variable_set("@#{val}", args[val]) }
-        @visible           = args[:visible] || 1
-
         set_major_minor_gridlines(args)
+
+        @visible           = args[:visible] || 1
         set_display_units(args)
         set_display_units_visible(args)
         set_position(args)
@@ -44,6 +45,10 @@ def merge_with_hash(params) # :nodoc:
           @chart.date_category = false
           @text_axis = true
         end
+
+        # Set the tick marker types.
+        @major_tick_mark = get_tick_type(params[:major_tick_mark])
+        @minor_tick_mark = get_tick_type(params[:minor_tick_mark])
       end
 
       #
@@ -126,6 +131,26 @@ def get_display_units(display_units)
         end
       end
 
+      #
+      # Convert user tick types to internal units.
+      #
+      def get_tick_type(tick_type)
+        return if !ptrue?(tick_type)
+
+        types = {
+          'outside' => 'out',
+          'inside'  => 'in',
+          'none'    => 'none',
+          'cross'   => 'cross'
+        }
+
+        if(types[tick_type])
+          return types[tick_type]
+        else
+          raise "Unknown tick_type type '#{tick_type}'\n"
+        end
+      end
+
       def set_display_units(args)
         @display_units = get_display_units(args[:display_units])
       end
@@ -134,7 +159,7 @@ def set_display_units_visible(args)
         if args[:display_units_visible]
           @display_units_visible = args[:display_units_visible]
         else
-          @display_units_visible = 1;
+          @display_units_visible = 1
         end
       end
 

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.87.0"
+WriteXLSX_VERSION = "0.88.0"

data/test/regression/test_chart_axis41.rb

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartAxis41 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_axis41
+    @xlsx = 'chart_axis41.xlsx'
+    workbook    = WriteXLSX.new(@io)
+    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, [108321024, 108328448])
+
+    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_x_axis(
+      :major_tick_mark => 'none',
+      :minor_tick_mark => 'inside'
+    )
+    chart.set_y_axis(:minor_tick_mark => 'cross')
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression(
+      nil,
+      { 'xl/charts/chart1.xml' => ['<c:pageMargins'] }
+    )
+  end
+end

data/test/regression/test_chart_format21.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartFormat21 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_format21
+    @xlsx = 'chart_format21.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [115390336, 115417856])
+
+    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',
+      :border     => { :color => 'yellow' },
+      :fill       => { :color => 'red', :transparency => 24 }
+    )
+
+    chart.add_series(
+      :categories => '=Sheet1!$A$1:$A$5',
+      :values     => '=Sheet1!$C$1:$C$5'
+    )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_chart_format22.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartFormat22 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_format22
+    @xlsx = 'chart_format22.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [108321024, 108328448])
+
+    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',
+      :border     => { :color => 'yellow' },
+      :fill       => { :color => 'red', :transparency => 1 }
+    )
+
+    chart.add_series(
+      :categories => '=Sheet1!$A$1:$A$5',
+      :values     => '=Sheet1!$C$1:$C$5'
+    )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_chart_format23.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartFormat23 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_format23
+    @xlsx = 'chart_format23.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [108321024, 108328448])
+
+    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',
+      :border     => { :color => 'yellow' },
+      :fill       => { :color => 'red', :transparency => 100 }
+    )
+
+    chart.add_series(
+      :categories => '=Sheet1!$A$1:$A$5',
+      :values     => '=Sheet1!$C$1:$C$5'
+    )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_chart_format24.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartFormat24 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_format24
+    @xlsx = 'chart_format24.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [115374720, 115389568])
+
+    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'
+    )
+
+    chart.set_chartarea(
+      :fill => { :color => 'yellow', :transparency => 75 }
+    )
+    chart.set_plotarea(
+      :fill => { :color => 'red', :transparency => 25 }
+    )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_chart_format25.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartFormat25 < Minitest::Test
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_chart_format25
+    @xlsx = 'chart_format25.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    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, [108178048, 108319488])
+
+    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',
+      :border     => { :color => 'red', :transparency => 50 }
+    )
+
+    chart.add_series(
+      :categories => '=Sheet1!$A$1:$A$5',
+      :values     => '=Sheet1!$C$1:$C$5'
+    )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_for_regression
+  end
+end

data/test/regression/test_chart_gridlines04.rb

@@ -31,9 +31,10 @@ def test_chart_gridlines04
     chart.add_series(:values => '=Sheet1!$B$1:$B$5')
     chart.add_series(:values => '=Sheet1!$C$1:$C$5')
 
-    chart.set_y_axis(:major_gridlines => { :visible => 0 })
-    chart.instance_variable_get(:@y_axis).
-      instance_variable_set(:@major_tick_mark, 'cross')
+    chart.set_y_axis(
+      :major_gridlines => { :visible => 0 },
+      :major_tick_mark => 'cross'
+    )
 
     worksheet.insert_chart('E9',  chart)
 

data/test/regression/test_chart_gridlines08.rb

@@ -20,11 +20,10 @@ def test_chart_gridlines08
     chart.instance_variable_set(:@axis_ids, [60019072, 60020608])
 
     data = [
-            [ 1, 2, 3, 4,  5 ],
-            [ 2, 4, 6, 8,  10 ],
-            [ 3, 6, 9, 12, 15 ],
-           ]
-
+      [ 1, 2, 3, 4,  5 ],
+      [ 2, 4, 6, 8,  10 ],
+      [ 3, 6, 9, 12, 15 ],
+    ]
 
     worksheet.write('A1', data)
 
@@ -33,12 +32,10 @@ def test_chart_gridlines08
     chart.add_series(:values => '=Sheet1!$C$1:$C$5')
 
     chart.set_y_axis(
-                     :major_gridlines => { :visible => 1 },
-                     :minor_gridlines => { :visible => 1 }
-                     )
-
-    chart.instance_variable_get(:@y_axis).
-      instance_variable_set(:@major_tick_mark, 'cross')
+      :major_gridlines => { :visible => 1 },
+      :minor_gridlines => { :visible => 1 },
+      :major_tick_mark => 'cross'
+    )
 
     worksheet.insert_chart('E9',  chart)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 0.87.0
+  version: 0.88.0
 platform: ruby
 authors:
 - Hideo NAKAMURA
@@ -466,6 +466,7 @@ files:
 - test/regression/test_chart_axis38.rb
 - test/regression/test_chart_axis39.rb
 - test/regression/test_chart_axis40.rb
+- test/regression/test_chart_axis41.rb
 - test/regression/test_chart_bar01.rb
 - test/regression/test_chart_bar02.rb
 - test/regression/test_chart_bar03.rb
@@ -617,6 +618,11 @@ files:
 - test/regression/test_chart_format18.rb
 - test/regression/test_chart_format19.rb
 - test/regression/test_chart_format20.rb
+- test/regression/test_chart_format21.rb
+- test/regression/test_chart_format22.rb
+- test/regression/test_chart_format23.rb
+- test/regression/test_chart_format24.rb
+- test/regression/test_chart_format25.rb
 - test/regression/test_chart_gap01.rb
 - test/regression/test_chart_gap02.rb
 - test/regression/test_chart_gap03.rb
@@ -1084,6 +1090,7 @@ files:
 - test/regression/xlsx_files/chart_axis38.xlsx
 - test/regression/xlsx_files/chart_axis39.xlsx
 - test/regression/xlsx_files/chart_axis40.xlsx
+- test/regression/xlsx_files/chart_axis41.xlsx
 - test/regression/xlsx_files/chart_bar01.xlsx
 - test/regression/xlsx_files/chart_bar02.xlsx
 - test/regression/xlsx_files/chart_bar03.xlsx
@@ -1234,6 +1241,11 @@ files:
 - test/regression/xlsx_files/chart_format18.xlsx
 - test/regression/xlsx_files/chart_format19.xlsx
 - test/regression/xlsx_files/chart_format20.xlsx
+- test/regression/xlsx_files/chart_format21.xlsx
+- test/regression/xlsx_files/chart_format22.xlsx
+- test/regression/xlsx_files/chart_format23.xlsx
+- test/regression/xlsx_files/chart_format24.xlsx
+- test/regression/xlsx_files/chart_format25.xlsx
 - test/regression/xlsx_files/chart_gap01.xlsx
 - test/regression/xlsx_files/chart_gap02.xlsx
 - test/regression/xlsx_files/chart_gap03.xlsx
@@ -2032,6 +2044,7 @@ test_files:
 - test/regression/test_chart_axis38.rb
 - test/regression/test_chart_axis39.rb
 - test/regression/test_chart_axis40.rb
+- test/regression/test_chart_axis41.rb
 - test/regression/test_chart_bar01.rb
 - test/regression/test_chart_bar02.rb
 - test/regression/test_chart_bar03.rb
@@ -2183,6 +2196,11 @@ test_files:
 - test/regression/test_chart_format18.rb
 - test/regression/test_chart_format19.rb
 - test/regression/test_chart_format20.rb
+- test/regression/test_chart_format21.rb
+- test/regression/test_chart_format22.rb
+- test/regression/test_chart_format23.rb
+- test/regression/test_chart_format24.rb
+- test/regression/test_chart_format25.rb
 - test/regression/test_chart_gap01.rb
 - test/regression/test_chart_gap02.rb
 - test/regression/test_chart_gap03.rb
@@ -2650,6 +2668,7 @@ test_files:
 - test/regression/xlsx_files/chart_axis38.xlsx
 - test/regression/xlsx_files/chart_axis39.xlsx
 - test/regression/xlsx_files/chart_axis40.xlsx
+- test/regression/xlsx_files/chart_axis41.xlsx
 - test/regression/xlsx_files/chart_bar01.xlsx
 - test/regression/xlsx_files/chart_bar02.xlsx
 - test/regression/xlsx_files/chart_bar03.xlsx
@@ -2800,6 +2819,11 @@ test_files:
 - test/regression/xlsx_files/chart_format18.xlsx
 - test/regression/xlsx_files/chart_format19.xlsx
 - test/regression/xlsx_files/chart_format20.xlsx
+- test/regression/xlsx_files/chart_format21.xlsx
+- test/regression/xlsx_files/chart_format22.xlsx
+- test/regression/xlsx_files/chart_format23.xlsx
+- test/regression/xlsx_files/chart_format24.xlsx
+- test/regression/xlsx_files/chart_format25.xlsx
 - test/regression/xlsx_files/chart_gap01.xlsx
 - test/regression/xlsx_files/chart_gap02.xlsx
 - test/regression/xlsx_files/chart_gap03.xlsx