write_xlsx 1.02.0 → 1.08.1

data/test/test_example_match.rb

@@ -242,6 +242,319 @@ class TestExampleMatch < Minitest::Test
     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 @@ EOS
       :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')
@@ -714,6 +1027,81 @@ EOS
     # Insert the chart into the worksheet (with an offset).
     worksheet.insert_chart('D2', chart, 25, 10)
 
+    #
+    # Create a stacked chart sub-type
+    #
+    chart2 = workbook.add_chart(
+      :type     => 'line',
+      :embedded => 1,
+      :subtype  => 'stacked'
+    )
+
+    # 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.
+    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  => 'Stacked Chart' )
+    chart2.set_x_axis( :name => 'Test number' )
+    chart2.set_y_axis( :name => 'Sample length (mm)' )
+
+    # Set an Excel chart style. Blue colors with white outline and shadow.
+    chart2.set_style( 12 )
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart(
+      'D18', chart2,
+      { :x_offset => 25, :y_offset => 10 }
+    )
+
+
+    #
+    # Create a percent stacked chart sub-type
+    #
+    chart3 = workbook.add_chart(
+      :type     => 'line',
+      :embedded => 1,
+      :subtype  => 'percent_stacked'
+    )
+
+    # Configure the first series.
+    chart3.add_series(
+      :name       => '=Sheet1!$B$1',
+      :categories => '=Sheet1!$A$2:$A$7',
+      :values     => '=Sheet1!$B$2:$B$7'
+    )
+
+    # Configure second series.
+    chart3.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.
+    chart3.set_title( :name  => 'Percent Stacked Chart' )
+    chart3.set_x_axis( :name => 'Test number' )
+    chart3.set_y_axis( :name => 'Sample length (mm)' )
+
+    # Set an Excel chart style. Blue colors with white outline and shadow.
+    chart3.set_style( 13 )
+
+    # Insert the chart into the worksheet (with an offset).
+    worksheet.insert_chart(
+      'D34', chart3,
+      { :x_offset => 25, :y_offset => 10 }
+    )
+
     workbook.close
     store_to_tempfile
     compare_xlsx(File.join(@perl_output, @xlsx), @tempfile.path)
@@ -1320,7 +1708,7 @@ EOS
     comment = 'Hello.'
 
     worksheet6.write( 'C9', cell_text, text_wrap )
-    worksheet6.write_comment( 'C9', comment, :color => 0x35 )
+    worksheet6.write_comment( 'C9', comment, :color => '#FF6600' )
 
 
     ###############################################################################
@@ -4595,6 +4983,7 @@ EOS
     worksheet10 = workbook.add_worksheet
     worksheet11 = workbook.add_worksheet
     worksheet12 = workbook.add_worksheet
+    worksheet13 = workbook.add_worksheet
 
     currency_format = workbook.add_format(:num_format => '$#,##0')
 
@@ -4626,7 +5015,7 @@ EOS
     #
     # Example 2.
     #
-    caption = 'Default table with data.';
+    caption = 'Default table with data.'
 
     # Set the columns widths.
     worksheet2.set_column('B:G', 12)
@@ -4695,7 +5084,7 @@ EOS
     #
     # Example 6.
     #
-    caption = 'Table with banded columns but without default banded rows.';
+    caption = 'Table with banded columns but without default banded rows.'
 
     # Set the columns widths.
     worksheet6.set_column('B:G', 12)
@@ -4713,7 +5102,7 @@ EOS
     #
     # Example 7.
     #
-    caption = 'Table with user defined column headers';
+    caption = 'Table with user defined column headers'
 
     # Set the columns widths.
     worksheet7.set_column('B:G', 12)
@@ -4740,7 +5129,7 @@ EOS
     #
     # Example 8.
     #
-    caption = 'Table with user defined column headers';
+    caption = 'Table with user defined column headers'
 
     # Set the columns widths.
     worksheet8.set_column('B:G', 12)
@@ -4772,7 +5161,7 @@ EOS
     #
     # Example 9.
     #
-    caption = 'Table with totals row (but no caption or totals).';
+    caption = 'Table with totals row (but no caption or totals).'
 
     # Set the columns widths.
     worksheet9.set_column('B:G', 12)
@@ -4804,7 +5193,7 @@ EOS
     #
     # Example 10.
     #
-    caption = 'Table with totals row with user captions and functions.';
+    caption = 'Table with totals row with user captions and functions.'
 
     # Set the columns widths.
     worksheet10.set_column('B:G', 12)
@@ -4837,7 +5226,7 @@ EOS
     #
     # Example 11.
     #
-    caption = 'Table with alternative Excel style.';
+    caption = 'Table with alternative Excel style.'
 
     # Set the columns widths.
     worksheet11.set_column('B:G', 12)
@@ -4871,7 +5260,7 @@ EOS
     #
     # Example 12.
     #
-    caption = 'Table with column formats.';
+    caption = 'Table with no Excel style.'
 
     # Set the columns widths.
     worksheet12.set_column('B:G', 12)
@@ -4881,6 +5270,40 @@ EOS
 
     # Add a table to the worksheet.
     worksheet12.add_table(
+      'B3:G8',
+      {
+        :data      => data,
+        :style     => 'None',
+        :total_row => 1,
+        :columns   => [
+          { :header => 'Product',   :total_string   => 'Totals' },
+          { :header => 'Quarter 1', :total_function => 'sum' },
+          { :header => 'Quarter 2', :total_function => 'sum' },
+          { :header => 'Quarter 3', :total_function => 'sum' },
+          { :header => 'Quarter 4', :total_function => 'sum' },
+          {
+            :header         => 'Year',
+            :formula        => '=SUM(Table12[@[Quarter 1]:[Quarter 4]])',
+            :total_function => 'sum'
+          }
+        ]
+      }
+    )
+
+    ###############################################################################
+    #
+    # Example 13.
+    #
+    caption = 'Table with column formats.'
+
+    # Set the columns widths.
+    worksheet13.set_column('B:G', 12)
+
+    # Write the caption.
+    worksheet13.write('B1', caption)
+
+    # Add a table to the worksheet.
+    worksheet13.add_table(
       'B3:G8',
       {
         :data      => data,

data/test/utility/test_range.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRange < Minitest::Test
+  include Writexlsx::Utility
+
+  def test_range_0_0_1_1
+    assert_equal(
+      'B1',
+      xl_range(0, 0, 1, 1)
+    )
+  end
+
+  def test_range_0_0_1_1_1_1_1_1
+    assert_equal(
+      '$B$1',
+      xl_range(0, 0, 1, 1, 1, 1, 1, 1)
+    )
+  end
+end

data/test/workbook/test_check_sheetname.rb

@@ -48,14 +48,4 @@ class TestCheckSheetname < Minitest::Test
       end
     end
   end
-
-  def test_check_sheetname_reserved_name
-    reserved_names = ['History', 'history', 'HISTORY', 'HisTory']
-
-    reserved_names.each do |sheetname|
-      assert_raises RuntimeError, "'#{sheetname}' passed incorrectly" do
-        @workbook.add_worksheet(sheetname)
-      end
-    end
-  end
 end

data/write_xlsx.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rubyzip', '>= 1.0.0'
   gem.add_runtime_dependency 'zip-zip'
   gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'byebug'
   gem.add_development_dependency 'rake'
   gem.extra_rdoc_files = [
     "LICENSE.txt",