write_xlsx 1.04.0 → 1.07.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c3893d317a3ab9f246b62c9d6b6b3a727abd9ab539da4edf52c4029f076d566
-  data.tar.gz: 64861b9ce57ebd55ce67508b33be19705049a8db520edfacc1fd40d8547c2b9c
+  metadata.gz: 677847fdb975ab7253b3a5ed5f6aa779a9bbf2a459e941f5037b7d557e2abfe4
+  data.tar.gz: 4c4b0b03ce3b510a0ad6423c30a76fc778463afe92f992da52b49bbe65c7a1ac
 SHA512:
-  metadata.gz: c3870b13ed05dca60597ecc86662d15d2ec143667e6ff29349c4409d2dd7966eb9f7246f14071a06524a15f5039cb8ec2d4c6c4fb99206b1377f452abe94eddc
-  data.tar.gz: b776541fecba7724e59e5742939e331944ea9a08d87eba2528d29404f9f34bbab8a8abe548fd52735a15c72e42e54c54cc73ad5c06765521647771178229fab0
+  metadata.gz: b3f81d2d54e5f7a7170c34e7666f58c7f4f77b993ff3b95263327b0ff8edff5c9a0b1a6ea825ece5b43c5b1d2b91a6f01764237f22ee6442bd8c747de8e04150
+  data.tar.gz: 3e49064459345dbcc5d97fef0f8154159776e8361cb0709e8a4564f32dd062fe95b6e4f08976df81b5ac478a40287be9a33086726444af3c75d1cbeb5c869dc2

data/.travis.yml

@@ -63,4 +63,3 @@ rvm:
 - 2.1.1
 - 2.1.0
 - 2.0.0
-- 1.9.3

data/Changes

@@ -1,5 +1,24 @@
 Change history of write_xlsx rubygem.
 
+2021-02-17 v1.07.0
+
+   Added support for Border, Fill, Pattern and Gradient formatting to chart
+   data labels and chart custom data labels.
+
+
+2021-02-15 v1.06.0
+
+   Fix for issue where array formulas weren't included in the output file
+   for certain ranges/conditions.
+
+
+2021-02-15 v1.05.0
+
+   Added support for custom data labels in charts.
+
+   Remove ruby-1.9.3 travil CI check.
+
+
 2021-02-14 v1.04.0
 
    Added support for "stacked" and "percent_stacked" Line charts.

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-1.04](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.04)
+[Excel::Writer::XLSX-1.07](https://github.com/jmcnamara/excel-writer-xlsx/tree/CPAN_1.07)
 
 ## Description
 

data/examples/chart_data_labels.rb

@@ -0,0 +1,320 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A demo of an various Excel chart data label features that are available
+# via an WriteXLSX chart.
+#
+# Copyright 2000-2020, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_data_labels.xlsx')
+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

data/lib/write_xlsx/chart.rb

@@ -34,7 +34,7 @@ def write_d_table(writer)
         @writer.empty_tag('c:showOutline',    attributes) if ptrue?(outline)
         @writer.empty_tag('c:showKeys',       attributes) if ptrue?(show_keys)
         # Write the table font.
-        write_tx_pr(nil, font)                            if ptrue?(font)
+        write_tx_pr(font)                                 if ptrue?(font)
       end
     end
 
@@ -783,7 +783,7 @@ def write_chart # :nodoc:
         elsif @title.formula
           write_title_formula(@title, nil, nil, @title.layout, @title.overlay)
         elsif @title.name
-          write_title_rich(@title, nil, @title.layout, @title.overlay)
+          write_title_rich(@title, nil, @title.name_font, @title.layout, @title.overlay)
         end
 
         # Write the c:plotArea element.
@@ -1204,7 +1204,7 @@ def write_cat_axis(params) # :nodoc:
         if x_axis.formula
           write_title_formula(x_axis, is_y_axis, @x_axis, x_axis.layout)
         elsif x_axis.name
-          write_title_rich(x_axis, is_y_axis, x_axis.layout)
+          write_title_rich(x_axis, is_y_axis, x_axis.name_font, x_axis.layout)
         end
 
         # Write the c:numFmt element.
@@ -1281,7 +1281,7 @@ def write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)  # :no
         if y_axis.formula
           write_title_formula(y_axis, @horiz_val_axis, nil, y_axis.layout)
         elsif y_axis.name
-          write_title_rich(y_axis, @horiz_val_axis, y_axis.layout)
+          write_title_rich(y_axis, @horiz_val_axis, y_axis.name_font, y_axis.layout)
         end
 
         # Write the c:numberFormat element.
@@ -1356,7 +1356,7 @@ def write_date_axis(params)  # :nodoc:
         if x_axis.formula
           write_title_formula(x_axis, nil, nil, x_axis.layout)
         elsif x_axis.name
-          write_title_rich(x_axis, nil, x_axis.layout)
+          write_title_rich(x_axis, nil, x_axis.name_font, x_axis.layout)
         end
         # Write the c:numFmt element.
         write_number_format(x_axis)
@@ -1693,7 +1693,7 @@ def write_legend # :nodoc:
         # Write the c:spPr element.
         write_sp_pr(@legend)
         # Write the c:txPr element.
-        write_tx_pr(nil, @legend.font) if ptrue?(@legend.font)
+        write_tx_pr(@legend.font) if ptrue?(@legend.font)
       end
     end
 
@@ -1808,10 +1808,10 @@ def write_auto_title_deleted
     #
     # Write the <c:title> element for a rich string.
     #
-    def write_title_rich(title, is_y_axis = nil, layout = nil, overlay = nil) # :nodoc:
+    def write_title_rich(title, is_y_axis, font, layout, overlay = nil) # :nodoc:
       @writer.tag_elements('c:title') do
         # Write the c:tx element.
-        write_tx_rich(title, is_y_axis)
+        write_tx_rich(title, is_y_axis, font)
         # Write the c:layout element.
         write_layout(layout, 'text')
         # Write the c:overlay element.
@@ -1831,15 +1831,17 @@ def write_title_formula(title, is_y_axis = nil, axis = nil, layout = nil, overla
         # Write the c:overlay element.
         write_overlay if overlay
         # Write the c:txPr element.
-        write_tx_pr(is_y_axis, axis ? axis.name_font : title.name_font)
+        write_tx_pr(axis ? axis.name_font : title.name_font, is_y_axis)
       end
     end
 
     #
     # Write the <c:tx> element.
     #
-    def write_tx_rich(title, is_y_axis) # :nodoc:
-      @writer.tag_elements('c:tx') { write_rich(title, is_y_axis) }
+    def write_tx_rich(title, is_y_axis, font) # :nodoc:
+      @writer.tag_elements('c:tx') do
+        write_rich(title, font, is_y_axis)
+      end
     end
 
     #
@@ -1861,10 +1863,11 @@ def write_tx_formula(title, data_id) # :nodoc:
     #
     # Write the <c:rich> element.
     #
-    def write_rich(title, is_y_axis) # :nodoc:
+    def write_rich(title, font, is_y_axis, ignore_rich_pr = false) # :nodoc:
       rotation = nil
-      if title.name_font && title.name_font[:_rotation]
-        rotation = title.name_font[:_rotation]
+
+      if font && font[:_rotation]
+        rotation = font[:_rotation]
       end
       @writer.tag_elements('c:rich') do
         # Write the a:bodyPr element.
@@ -1872,18 +1875,18 @@ def write_rich(title, is_y_axis) # :nodoc:
         # Write the a:lstStyle element.
         write_a_lst_style
         # Write the a:p element.
-        write_a_p_rich(title)
+        write_a_p_rich(title, font, ignore_rich_pr)
       end
     end
     #
     # Write the <a:p> element for rich string titles.
     #
-    def write_a_p_rich(title) # :nodoc:
+    def write_a_p_rich(title, font, ignore_rich_pr) # :nodoc:
       @writer.tag_elements('a:p') do
         # Write the a:pPr element.
-        write_a_p_pr_rich(title.name_font)
+        write_a_p_pr_rich(font) if !ignore_rich_pr
         # Write the a:r element.
-        write_a_r(title)
+        write_a_r(title, font)
       end
     end
 
@@ -1897,12 +1900,12 @@ def write_a_p_pr_rich(font) # :nodoc:
     #
     # Write the <a:r> element.
     #
-    def write_a_r(title) # :nodoc:
+    def write_a_r(title, font) # :nodoc:
       @writer.tag_elements('a:r') do
         # Write the a:rPr element.
-        write_a_r_pr(title.name_font)
+        write_a_r_pr(font)
         # Write the a:t element.
-        write_a_t(title.name)
+        write_a_t(title.respond_to?(:name) ? title.name : title)
       end
     end
 
@@ -1967,17 +1970,27 @@ def write_symbol(val) # :nodoc:
       @writer.empty_tag('c:symbol', [ ['val', val] ])
     end
 
+    def has_fill_formatting(element)
+      line     = series_property(element, :line)
+      fill     = series_property(element, :fill)
+      pattern  = series_property(element, :pattern)
+      gradient = series_property(element, :gradient)
+
+      (line && ptrue?(line[:_defined])) ||
+        (fill && ptrue?(fill[:_defined])) || pattern || gradient
+    end
+
+
     #
     # Write the <c:spPr> element.
     #
     def write_sp_pr(series) # :nodoc:
-      line     = series.line
-      fill     = series.fill
-      pattern  = series.pattern  if series.respond_to?(:pattern)
-      gradient = series.gradient if series.respond_to?(:gradient)
+      return if !has_fill_formatting(series)
 
-      return if (!line || !ptrue?(line[:_defined])) &&
-        (!fill || !ptrue?(fill[:_defined])) && !pattern && !gradient
+      line     = series_property(series, :line)
+      fill     = series_property(series, :fill)
+      pattern  = series_property(series, :pattern)
+      gradient = series_property(series, :gradient)
 
       @writer.tag_elements('c:spPr') do
         # Write the fill elements for solid charts such as pie/doughnut and bar.
@@ -2002,6 +2015,14 @@ def write_sp_pr(series) # :nodoc:
       end
     end
 
+    def series_property(object, property)
+      if object.respond_to?(property)
+        object.send(property)
+      elsif object.respond_to?(:[])
+        object[property]
+      end
+    end
+
     #
     # Write the <a:ln> element.
     #
@@ -2349,8 +2370,14 @@ def write_d_lbls(labels) # :nodoc:
       return unless labels
 
       @writer.tag_elements('c:dLbls') do
+        # Write the custom c:dLbl elements.
+        if labels[:custom]
+          write_custom_labels(labels, labels[:custom])
+        end
         # Write the c:numFmt element.
         write_data_label_number_format(labels[:num_format]) if labels[:num_format]
+        # Write the c:spPr element.
+        write_sp_pr(labels)
         # Write the data label font elements.
         write_axis_font(labels[:font]) if labels[:font]
         # Write the c:dLblPos element.
@@ -2372,6 +2399,103 @@ def write_d_lbls(labels) # :nodoc:
       end
     end
 
+    #
+    # Write the <c:dLbl> element.
+    #
+    def write_custom_labels(parent, labels)
+      index  = 0
+
+      labels.each do |label|
+        index += 1
+        next if !ptrue?(label)
+
+        @writer.tag_elements('c:dLbl') do
+          # Write the c:idx element.
+          write_idx(index - 1)
+
+          if label[:delete] && label[:delete]
+            write_delete(1)
+          elsif label[:formula]
+            write_custom_label_formula(label)
+
+            write_show_val      if parent[:value]
+            write_show_cat_name if parent[:category]
+            write_show_ser_name if parent[:series_name]
+          elsif label[:value]
+            write_custom_label_str(label)
+
+            write_show_val      if parent[:value]
+            write_show_cat_name if parent[:category]
+            write_show_ser_name if parent[:series_name]
+          else
+            write_custom_label_format_only(label)
+          end
+        end
+      end
+    end
+
+    #
+    # Write parts of the <c:dLbl> element for strings.
+    #
+    def write_custom_label_str(label)
+      value          = label[:value]
+      font           = label[:font]
+      is_y_axis      = 0
+      has_formatting = has_fill_formatting(label)
+
+      # Write the c:layout element.
+      write_layout()
+
+      @writer.tag_elements('c:tx') do
+        # Write the c:rich element.
+        write_rich(value, font, is_y_axis, !has_formatting)
+      end
+
+      # Write the c:cpPr element.
+      write_sp_pr(label)
+    end
+
+    #
+    # Write parts of the <c:dLbl> element for formulas.
+    #
+    def write_custom_label_formula(label)
+      formula = label[:formula]
+      data_id = label[:data_id]
+
+      if data_id
+        data = @formula_data[data_id]
+      end
+
+      # Write the c:layout element.
+      write_layout
+
+      @writer.tag_elements('c:tx') do
+        # Write the c:strRef element.
+        write_str_ref(formula, data, 'str')
+      end
+
+      # Write the data label formatting, if any.
+      write_custom_label_format_only(label)
+    end
+
+    #
+    # Write parts of the <c:dLbl> element for labels where only the formatting has
+    # changed.
+    #
+    def write_custom_label_format_only(label)
+      font           = label[:font]
+      has_formatting = has_fill_formatting(label)
+
+      if has_formatting
+        # Write the c:spPr element.
+        write_sp_pr(label)
+        write_tx_pr(font)
+      elsif font
+        @writer.empty_tag('c:spPr')
+        write_tx_pr(font)
+      end
+    end
+
     #
     # Write the <c:showLegendKey> element.
     #
@@ -2700,7 +2824,7 @@ def write_a_gs_lst(gradient)
 
             # Write the a:srgbClr element.
             # TODO: Wait for a feature request to support transparency.
-            write_a_srgb_clr( color );
+            write_a_srgb_clr( color )
           end
         end
       end