write_xlsx 1.04.0 → 1.07.0

data/test/test_example_match.rb

@@ -242,6 +242,319 @@ def test_autofilter
     compare_xlsx(File.join(@perl_output, @xlsx), @tempfile.path)
   end
 
+  def test_chart_data_labels
+    @xlsx = 'chart_data_labels.xlsx'
+    workbook  = WriteXLSX.new(@io)
+
+    worksheet = workbook.add_worksheet
+    bold      = workbook.add_format(:bold => 1)
+
+    # Add the worksheet data that the charts will refer to.
+    headings = ['Number', 'Data', 'Text']
+    data = [
+      [ 2,  3,  4,  5,  6,  7 ],
+      [20, 10, 20, 30, 40, 30 ],
+      ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun']
+    ]
+
+    worksheet.write('A1', headings, bold)
+    worksheet.write('A2', data)
+
+
+    #######################################################################
+    #
+    # Example with standard data labels.
+    #
+
+    # Create a Column chart.
+    chart1 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Configure the data series and add the data labels.
+    chart1.add_series(
+      :categories  => '=Sheet1!$A$2:$A$7',
+      :values      => '=Sheet1!$B$2:$B$7',
+      :data_labels => { :value => 1 }
+    )
+
+    # Add a chart title.
+    chart1.set_title(:name => 'Chart with standard data labels')
+
+    # Turn off the chart legend.
+    chart1.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D2', chart1, { :x_offset => 25, :y_offset => 10 })
+
+
+    #######################################################################
+    #
+    # Example with value and category data labels.
+    #
+
+    # Create a Column chart.
+    chart2 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Configure the data series and add the data labels.
+    chart2.add_series(
+      :categories  => '=Sheet1!$A$2:$A$7',
+      :values      => '=Sheet1!$B$2:$B$7',
+      :data_labels => { :value => 1, :category => 1 }
+    )
+
+    # Add a chart title.
+    chart2.set_title(:name => 'Category and Value data labels')
+
+    # Turn off the chart legend.
+    chart2.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D18', chart2, { :x_offset => 25, :y_offset => 10 })
+
+
+    #######################################################################
+    #
+    # Example with standard data labels with different font.
+    #
+
+    # Create a Column chart.
+    chart3 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Configure the data series and add the data labels.
+    chart3.add_series(
+      :categories  => '=Sheet1!$A$2:$A$7',
+      :values      => '=Sheet1!$B$2:$B$7',
+      :data_labels => { :value => 1,
+                        :font => {:bold => 1,
+                                  :color => 'red',
+                                  :rotation => -30}
+                      }
+    )
+
+    # Add a chart title.
+    chart3.set_title(:name => 'Data labels with user defined font')
+
+    # Turn off the chart legend.
+    chart3.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D34', chart3, { :x_offset => 25, :y_offset => 10 })
+
+
+    #######################################################################
+    #
+    # Example with custom string data labels.
+    #
+
+    # Create a Column chart.
+    chart4 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Configure the data series and add the data labels.
+    chart4.add_series(
+      :categories  => '=Sheet1!$A$2:$A$7',
+      :values      => '=Sheet1!$B$2:$B$7',
+      :data_labels => {
+        :value  => 1,
+        :border => {:color => 'red'},
+        :fill   => {:color => 'yellow'}
+      }
+    )
+
+    # Add a chart title.
+    chart4.set_title(:name => 'Data labels with formatting')
+
+    # Turn off the chart legend.
+    chart4.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D50', chart4, { :x_offset => 25, :y_offset => 10 })
+
+
+    #######################################################################
+    #
+    # Example with custom string data labels.
+    #
+
+    # Create a Column chart.
+    chart5 = workbook.add_chart( :type => 'column', :embedded => 1 )
+
+    # Some custom labels.
+    custom_labels = [
+      { :value => 'Amy' },
+      { :value => 'Bea' },
+      { :value => 'Eva' },
+      { :value => 'Fay' },
+      { :value => 'Liv' },
+      { :value => 'Una' }
+    ]
+
+    # Configure the data series and add the data labels.
+    chart5.add_series(
+      :categories => '=Sheet1!$A$2:$A$7',
+      :values     => '=Sheet1!$B$2:$B$7',
+      :data_labels => { :value => 1, :custom => custom_labels }
+    )
+
+    # Add a chart title.
+    chart5.set_title(:name => 'Chart with custom string data labels')
+
+    # Turn off the chart legend.
+    chart5.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D66', chart5, { :x_offset => 25, :y_offset => 10 })
+
+
+    #######################################################################
+    #
+    # Example with custom data labels from cells.
+    #
+
+    # Create a Column chart.
+    chart6 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Some custom labels.
+    custom_labels = [
+      { :value => '=Sheet1!$C$2' },
+      { :value => '=Sheet1!$C$3' },
+      { :value => '=Sheet1!$C$4' },
+      { :value => '=Sheet1!$C$5' },
+      { :value => '=Sheet1!$C$6' },
+      { :value => '=Sheet1!$C$7' }
+    ]
+
+
+    # Configure the data series and add the data labels.
+    chart6.add_series(
+      :categories  => '=Sheet1!$A$2:$A$7',
+      :values      => '=Sheet1!$B$2:$B$7',
+      :data_labels => { :value => 1, :custom => custom_labels }
+    )
+
+    # Add a chart title.
+    chart6.set_title(:name => 'Chart with custom data labels from cells')
+
+    # Turn off the chart legend.
+    chart6.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D82', chart6, { :x_offset => 25, :y_offset => 10 })
+
+
+    #######################################################################
+    #
+    # Example with custom and default data labels.
+    #
+
+    # Create a Column chart.
+    chart7 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Some custom labels. The nil items will get the default value.
+    # We also set a font for the custom items as an extra example.
+    custom_labels = [
+      { :value => '=Sheet1!$C$2', :font => { :color => 'red' } },
+      nil,
+      { :value => '=Sheet1!$C$4', :font => { :color => 'red' } },
+      { :value => '=Sheet1!$C$5', :font => { :color => 'red' } }
+    ]
+
+
+    # Configure the data series and add the data labels.
+    chart7.add_series(
+      :categories  => '=Sheet1!$A$2:$A$7',
+      :values      => '=Sheet1!$B$2:$B$7',
+      :data_labels => { :value => 1, :custom => custom_labels }
+    )
+
+    # Add a chart title.
+    chart7.set_title(:name => 'Mixed custom and default data labels')
+
+    # Turn off the chart legend.
+    chart7.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D98', chart7, { :x_offset => 25, :y_offset => 10 })
+
+
+    #######################################################################
+    #
+    # Example with deleted custom data labels.
+    #
+
+    # Create a Column chart.
+    chart8 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+    # Some deleted custom labels and defaults (nil). This allows us to
+    # highlight certain values such as the minimum and maximum.
+    custom_labels = [
+      { :delete => 1 },
+      nil,
+      { :delete => 1 },
+      { :delete => 1 },
+      nil,
+      { :delete => 1 }
+    ]
+
+    # Configure the data series and add the data labels.
+    chart8.add_series(
+      :categories  => '=Sheet1!$A$2:$A$7',
+      :values      => '=Sheet1!$B$2:$B$7',
+      :data_labels => { :value => 1, :custom => custom_labels }
+    )
+
+    # Add a chart title.
+    chart8.set_title(:name => 'Chart with deleted data labels')
+
+    # Turn off the chart legend.
+    chart8.set_legend(:none => 1)
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart('D114', chart8, { :x_offset => 25, :y_offset => 10 })
+
+    #######################################################################
+    #
+    # Example with custom string data labels and formatting.
+    #
+
+    # Create a Column chart.
+    chart9 = workbook.add_chart( :type => 'column', :embedded => 1 )
+
+    # Some custom labels.
+    custom_labels = [
+      { :value => 'Amy', :border => {:color => 'blue'} },
+      { :value => 'Bea' },
+      { :value => 'Eva' },
+      { :value => 'Fay' },
+      { :value => 'Liv' },
+      { :value => 'Una', :fill   => {:color => 'green'} }
+    ]
+
+
+    # Configure the data series and add the data labels.
+    chart9.add_series(
+      :categories => '=Sheet1!$A$2:$A$7',
+      :values     => '=Sheet1!$B$2:$B$7',
+      :data_labels => {
+        :value => 1,
+        :custom => custom_labels,
+        :border => {:color => 'red'},
+        :fill   => {:color => 'yellow'}
+      }
+    )
+
+    # Add a chart title.
+    chart9.set_title( :name => 'Chart with custom labels and formatting' )
+
+    # Turn off the chart legend.
+    chart9.set_legend( :none => 1 )
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart( 'D130', chart9, { :x_offset => 25, :y_offset => 10 } )
+
+    workbook.close
+    store_to_tempfile
+    compare_xlsx(File.join(@perl_output, @xlsx), @tempfile.path)
+  end
+
   def test_chart_gauge
     @xlsx = 'chart_gauge.xlsx'
     workbook  = WriteXLSX.new(@io)
@@ -577,7 +890,7 @@ def test_chart_doughnut
       :name       => 'Doughnut sales data',
       :categories => [ 'Sheet1', 1, 3, 0, 0 ],
       :values     => [ 'Sheet1', 1, 3, 1, 1 ]
-    );
+    )
 
     # Add a title.
     chart1.set_title(:name => 'Popular Doughnut Types')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 1.04.0
+  version: 1.07.0
 platform: ruby
 authors:
 - Hideo NAKAMURA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -110,6 +110,7 @@ files:
 - examples/chart_clustered.rb
 - examples/chart_column.rb
 - examples/chart_combined.rb
+- examples/chart_data_labels.rb
 - examples/chart_data_table.rb
 - examples/chart_data_tools.rb
 - examples/chart_doughnut.rb
@@ -335,6 +336,7 @@ files:
 - test/perl_output/chart_bar.xlsx
 - test/perl_output/chart_column.xlsx
 - test/perl_output/chart_combined.xlsx
+- test/perl_output/chart_data_labels.xlsx
 - test/perl_output/chart_data_table.xlsx
 - test/perl_output/chart_data_tools.xlsx
 - test/perl_output/chart_doughnut.xlsx
@@ -429,6 +431,7 @@ files:
 - test/regression/test_array_formula01.rb
 - test/regression/test_array_formula02.rb
 - test/regression/test_array_formula03.rb
+- test/regression/test_array_formula04.rb
 - test/regression/test_autofilter00.rb
 - test/regression/test_autofilter01.rb
 - test/regression/test_autofilter02.rb
@@ -589,6 +592,28 @@ files:
 - test/regression/test_chart_data_labels23.rb
 - test/regression/test_chart_data_labels24.rb
 - test/regression/test_chart_data_labels25.rb
+- test/regression/test_chart_data_labels26.rb
+- test/regression/test_chart_data_labels27.rb
+- test/regression/test_chart_data_labels28.rb
+- test/regression/test_chart_data_labels29.rb
+- test/regression/test_chart_data_labels30.rb
+- test/regression/test_chart_data_labels31.rb
+- test/regression/test_chart_data_labels32.rb
+- test/regression/test_chart_data_labels33.rb
+- test/regression/test_chart_data_labels34.rb
+- test/regression/test_chart_data_labels35.rb
+- test/regression/test_chart_data_labels36.rb
+- test/regression/test_chart_data_labels37.rb
+- test/regression/test_chart_data_labels38.rb
+- test/regression/test_chart_data_labels39.rb
+- test/regression/test_chart_data_labels40.rb
+- test/regression/test_chart_data_labels41.rb
+- test/regression/test_chart_data_labels42.rb
+- test/regression/test_chart_data_labels43.rb
+- test/regression/test_chart_data_labels44.rb
+- test/regression/test_chart_data_labels45.rb
+- test/regression/test_chart_data_labels46.rb
+- test/regression/test_chart_data_labels47.rb
 - test/regression/test_chart_date01.rb
 - test/regression/test_chart_date02.rb
 - test/regression/test_chart_date03.rb
@@ -1161,6 +1186,7 @@ files:
 - test/regression/xlsx_files/array_formula01.xlsx
 - test/regression/xlsx_files/array_formula02.xlsx
 - test/regression/xlsx_files/array_formula03.xlsx
+- test/regression/xlsx_files/array_formula04.xlsx
 - test/regression/xlsx_files/autofilter00.xlsx
 - test/regression/xlsx_files/autofilter01.xlsx
 - test/regression/xlsx_files/autofilter02.xlsx
@@ -1321,6 +1347,28 @@ files:
 - test/regression/xlsx_files/chart_data_labels23.xlsx
 - test/regression/xlsx_files/chart_data_labels24.xlsx
 - test/regression/xlsx_files/chart_data_labels25.xlsx
+- test/regression/xlsx_files/chart_data_labels26.xlsx
+- test/regression/xlsx_files/chart_data_labels27.xlsx
+- test/regression/xlsx_files/chart_data_labels28.xlsx
+- test/regression/xlsx_files/chart_data_labels29.xlsx
+- test/regression/xlsx_files/chart_data_labels30.xlsx
+- test/regression/xlsx_files/chart_data_labels31.xlsx
+- test/regression/xlsx_files/chart_data_labels32.xlsx
+- test/regression/xlsx_files/chart_data_labels33.xlsx
+- test/regression/xlsx_files/chart_data_labels34.xlsx
+- test/regression/xlsx_files/chart_data_labels35.xlsx
+- test/regression/xlsx_files/chart_data_labels36.xlsx
+- test/regression/xlsx_files/chart_data_labels37.xlsx
+- test/regression/xlsx_files/chart_data_labels38.xlsx
+- test/regression/xlsx_files/chart_data_labels39.xlsx
+- test/regression/xlsx_files/chart_data_labels40.xlsx
+- test/regression/xlsx_files/chart_data_labels41.xlsx
+- test/regression/xlsx_files/chart_data_labels42.xlsx
+- test/regression/xlsx_files/chart_data_labels43.xlsx
+- test/regression/xlsx_files/chart_data_labels44.xlsx
+- test/regression/xlsx_files/chart_data_labels45.xlsx
+- test/regression/xlsx_files/chart_data_labels46.xlsx
+- test/regression/xlsx_files/chart_data_labels47.xlsx
 - test/regression/xlsx_files/chart_date01.xlsx
 - test/regression/xlsx_files/chart_date02.xlsx
 - test/regression/xlsx_files/chart_date03.xlsx
@@ -2157,6 +2205,7 @@ test_files:
 - test/perl_output/chart_bar.xlsx
 - test/perl_output/chart_column.xlsx
 - test/perl_output/chart_combined.xlsx
+- test/perl_output/chart_data_labels.xlsx
 - test/perl_output/chart_data_table.xlsx
 - test/perl_output/chart_data_tools.xlsx
 - test/perl_output/chart_doughnut.xlsx
@@ -2251,6 +2300,7 @@ test_files:
 - test/regression/test_array_formula01.rb
 - test/regression/test_array_formula02.rb
 - test/regression/test_array_formula03.rb
+- test/regression/test_array_formula04.rb
 - test/regression/test_autofilter00.rb
 - test/regression/test_autofilter01.rb
 - test/regression/test_autofilter02.rb
@@ -2411,6 +2461,28 @@ test_files:
 - test/regression/test_chart_data_labels23.rb
 - test/regression/test_chart_data_labels24.rb
 - test/regression/test_chart_data_labels25.rb
+- test/regression/test_chart_data_labels26.rb
+- test/regression/test_chart_data_labels27.rb
+- test/regression/test_chart_data_labels28.rb
+- test/regression/test_chart_data_labels29.rb
+- test/regression/test_chart_data_labels30.rb
+- test/regression/test_chart_data_labels31.rb
+- test/regression/test_chart_data_labels32.rb
+- test/regression/test_chart_data_labels33.rb
+- test/regression/test_chart_data_labels34.rb
+- test/regression/test_chart_data_labels35.rb
+- test/regression/test_chart_data_labels36.rb
+- test/regression/test_chart_data_labels37.rb
+- test/regression/test_chart_data_labels38.rb
+- test/regression/test_chart_data_labels39.rb
+- test/regression/test_chart_data_labels40.rb
+- test/regression/test_chart_data_labels41.rb
+- test/regression/test_chart_data_labels42.rb
+- test/regression/test_chart_data_labels43.rb
+- test/regression/test_chart_data_labels44.rb
+- test/regression/test_chart_data_labels45.rb
+- test/regression/test_chart_data_labels46.rb
+- test/regression/test_chart_data_labels47.rb
 - test/regression/test_chart_date01.rb
 - test/regression/test_chart_date02.rb
 - test/regression/test_chart_date03.rb
@@ -2983,6 +3055,7 @@ test_files:
 - test/regression/xlsx_files/array_formula01.xlsx
 - test/regression/xlsx_files/array_formula02.xlsx
 - test/regression/xlsx_files/array_formula03.xlsx
+- test/regression/xlsx_files/array_formula04.xlsx
 - test/regression/xlsx_files/autofilter00.xlsx
 - test/regression/xlsx_files/autofilter01.xlsx
 - test/regression/xlsx_files/autofilter02.xlsx
@@ -3143,6 +3216,28 @@ test_files:
 - test/regression/xlsx_files/chart_data_labels23.xlsx
 - test/regression/xlsx_files/chart_data_labels24.xlsx
 - test/regression/xlsx_files/chart_data_labels25.xlsx
+- test/regression/xlsx_files/chart_data_labels26.xlsx
+- test/regression/xlsx_files/chart_data_labels27.xlsx
+- test/regression/xlsx_files/chart_data_labels28.xlsx
+- test/regression/xlsx_files/chart_data_labels29.xlsx
+- test/regression/xlsx_files/chart_data_labels30.xlsx
+- test/regression/xlsx_files/chart_data_labels31.xlsx
+- test/regression/xlsx_files/chart_data_labels32.xlsx
+- test/regression/xlsx_files/chart_data_labels33.xlsx
+- test/regression/xlsx_files/chart_data_labels34.xlsx
+- test/regression/xlsx_files/chart_data_labels35.xlsx
+- test/regression/xlsx_files/chart_data_labels36.xlsx
+- test/regression/xlsx_files/chart_data_labels37.xlsx
+- test/regression/xlsx_files/chart_data_labels38.xlsx
+- test/regression/xlsx_files/chart_data_labels39.xlsx
+- test/regression/xlsx_files/chart_data_labels40.xlsx
+- test/regression/xlsx_files/chart_data_labels41.xlsx
+- test/regression/xlsx_files/chart_data_labels42.xlsx
+- test/regression/xlsx_files/chart_data_labels43.xlsx
+- test/regression/xlsx_files/chart_data_labels44.xlsx
+- test/regression/xlsx_files/chart_data_labels45.xlsx
+- test/regression/xlsx_files/chart_data_labels46.xlsx
+- test/regression/xlsx_files/chart_data_labels47.xlsx
 - test/regression/xlsx_files/chart_date01.xlsx
 - test/regression/xlsx_files/chart_date02.xlsx
 - test/regression/xlsx_files/chart_date03.xlsx