write_xlsx 0.79.0 → 0.80.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e671b68b1de5d627fc5e2306b17a157dd669ac0b
-  data.tar.gz: 9a33233b791e917331d2714bfa1212789ff7d515
+  metadata.gz: 9f7b091a25a820d796b03d56e1e599383281513d
+  data.tar.gz: 6253c7a5c2dc797c7924593d5e1747f721758899
 SHA512:
-  metadata.gz: 2b218047dedb38eb475c41a3dda88d3eefca2d185ea34af3270f6d5ca9ebb884f1e81d3b8f893b16cbb84930fda41f28b2a62c926d2a58b9754c2c0e296204ce
-  data.tar.gz: d9ea75c34d0510b98d1a9a985fabbe3bcd62a73b8f31eba6b9d334313d1f94e29ffe6392dda2bc12cc84e1d4a778ace0e8ddff6afe530a5c5eb3661aeaa7ef07
+  metadata.gz: d4b0e1065e775a4638f962cbb5aa7345a1859f0c4fda350af0119a20c02b1455a7208480d5098283ba83f9ab64e616eed61684a84af0822a7de4a9fe4436be17
+  data.tar.gz: 57547d50d45c5961e8827049a0132ff50d392b927f0add7ea5f4bf57974398538d87d4d8bb3ce3d3ed88c36b5bdd81d7379a887cb2382e834d6b3d417429088c

data/Changes

@@ -1,4 +1,10 @@
 Change history of write_xlsx rubygem.
+2014-11-30 v0.80.0
+   Chart Data Label enhancements. Added number formatting, font handling
+   (Excel::Writer::XLSX issue #106), separator (Same issue #107) and legend key.
+   Added chart specific handling of data label positions since not all
+   positions are available for all chart types. Excel::Writer::XLSX Issue #110.
+
 2014-11-29 v0.79.0
    Added option to add images to headers and footers.
    Added option to not scale heaader/footer with page.

data/README.md

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

data/lib/write_xlsx/chart.rb

@@ -141,6 +141,7 @@ class Chart
     attr_reader :embedded, :formula_ids, :formula_data   # :nodoc:
     attr_reader :x_scale, :y_scale, :x_offset, :y_offset # :nodoc:
     attr_reader :width, :height  # :nodoc:
+    attr_reader :label_positions, :label_position_default
 
     #
     # Factory method for returning chart objects based on their class type.
@@ -1392,6 +1393,20 @@ def write_cat_number_format(axis)
       axis.write_cat_number_format(@writer, @cat_has_num_fmt)
     end
 
+    #
+    # Write the <c:numberFormat> element for data labels.
+    #
+    def write_data_label_number_format(format_code)
+      source_linked = 0
+
+      attributes = [
+                    ['formatCode',   format_code],
+                    ['sourceLinked', source_linked]
+                   ]
+
+      @writer.empty_tag('c:numFmt', attributes)
+    end
+
     #
     # Write the <c:majorTickMark> element.
     #
@@ -2232,8 +2247,14 @@ def write_d_lbls(labels) # :nodoc:
       return unless labels
 
       @writer.tag_elements('c:dLbls') do
+        # Write the c:numFmt element.
+        write_data_label_number_format(labels[:num_format]) if labels[:num_format]
+        # Write the data label font elements.
+        write_axis_font(labels[:font]) if labels[:font]
         # Write the c:dLblPos element.
-        write_d_lbl_pos(labels[:position]) if labels[:position]
+        write_d_lbl_pos(labels[:position]) if ptrue?(labels[:position])
+        # Write the c:showLegendKey element.
+        write_show_legend_key if labels[:legend_key]
         # Write the c:showVal element.
         write_show_val if labels[:value]
         # Write the c:showCatName element.
@@ -2242,11 +2263,20 @@ def write_d_lbls(labels) # :nodoc:
         write_show_ser_name if labels[:series_name]
         # Write the c:showPercent element.
         write_show_percent if labels[:percentage]
+        # Write the c:separator element.
+        write_separator(labels[:separator]) if labels[:separator]
         # Write the c:showLeaderLines element.
         write_show_leader_lines if labels[:leader_lines]
       end
     end
 
+    #
+    # Write the <c:showLegendKey> element.
+    #
+    def write_show_legend_key
+      @writer.empty_tag('c:showLegendKey', [ ['val', 1] ])
+    end
+
     #
     # Write the <c:showVal> element.
     #
@@ -2275,6 +2305,13 @@ def write_show_percent
       @writer.empty_tag('c:showPercent', [ ['val', 1] ])
     end
 
+    #
+    # Write the <c:separator> element.
+    #
+    def write_separator(data)
+      @writer.data_element('c:separator', data)
+    end
+
     #
     # Write the <c:showLeaderLines> element.
     #

data/lib/write_xlsx/chart/area.rb

@@ -32,6 +32,10 @@ def initialize(subtype)
         end
 
         set_y_axis
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'center'
+        @label_positions = { 'center' => 'ctr' }
       end
 
       #

data/lib/write_xlsx/chart/bar.rb

@@ -31,6 +31,15 @@ def initialize(subtype)
         axis_defaults_set
         set_x_axis
         set_y_axis
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'outside_end'
+        @label_positions = {
+          'center'      => 'ctr',
+          'inside_base' => 'inBase',
+          'inside_end'  => 'inEnd',
+          'outside_end' => 'outEnd'
+        }
       end
 
       #

data/lib/write_xlsx/chart/column.rb

@@ -39,6 +39,15 @@ def initialize(subtype)
         end
 
         set_y_axis
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'outside_end'
+        @label_positions = {
+          'center'      => 'ctr',
+          'inside_base' => 'inBase',
+          'inside_end'  => 'inEnd',
+          'outside_end' => 'outEnd'
+        }
       end
 
       #

data/lib/write_xlsx/chart/line.rb

@@ -24,6 +24,19 @@ def initialize(subtype)
         super(subtype)
         @default_marker = Marker.new(:type => 'none')
         @smooth_allowed = 1
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'right'
+        @label_positions = {
+          'center'      => 'ctr',
+          'right'       => 'r',
+          'left'        => 'l',
+          'above'       => 't',
+          'below'       => 'b',
+          # For backward compatibility.
+          'top'         => 't',
+          'bottom'      => 'b'
+        }
       end
 
       #

data/lib/write_xlsx/chart/pie.rb

@@ -30,6 +30,16 @@ def initialize(subtype)
         super(subtype)
         @vary_data_color = 1
         @rotation        = 0
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'best_fit'
+        @label_positions = {
+          'center'      => 'ctr',
+          'inside_base' => 'inBase',
+          'inside_end'  => 'inEnd',
+          'outside_end' => 'outEnd',
+          'best_fit'    => 'bestFit'
+        }
       end
 
       #

data/lib/write_xlsx/chart/radar.rb

@@ -41,6 +41,10 @@ def initialize(subtype)
 
         # Hardcode major_tick_mark for now untill there is an accessor.
         @y_axis.major_tick_mark = 'cross'
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'center'
+        @label_positions = { 'center' => 'ctr' }
       end
 
       #

data/lib/write_xlsx/chart/scatter.rb

@@ -43,6 +43,19 @@ def initialize(subtype)
         @horiz_val_axis    = 0
         @val_axis_position = 'b'
         @smooth_allowed    = 1
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'right'
+        @label_positions = {
+          'center'      => 'ctr',
+          'right'       => 'r',
+          'left'        => 'l',
+          'above'       => 't',
+          'below'       => 'b',
+          # For backward compatibility.
+          'top'         => 't',
+          'bottom'      => 'b'
+        }
       end
 
       #

data/lib/write_xlsx/chart/series.rb

@@ -168,12 +168,13 @@ class Series
       attr_accessor :line, :marker
 
       def initialize(chart, params = {})
+        @chart      = chart
         @values     = aref_to_formula(params[:values])
         @categories = aref_to_formula(params[:categories])
         @name, @name_formula =
           chart.process_names(params[:name], params[:name_formula])
 
-        set_data_ids(chart, params)
+        set_data_ids(params)
 
         @line = line_properties(params[:border] || params[:line])
         @fill = fill_properties(params[:fill])
@@ -182,6 +183,9 @@ def initialize(chart, params = {})
         @trendline  = Trendline.new(params[:trendline]) if params[:trendline]
         @error_bars = errorbars(params[:x_error_bars], params[:y_error_bars])
         @points     = params[:points].collect { |p| p ? Point.new(p) : p } if params[:points]
+
+        @label_positions = chart.label_positions
+        @label_position_default = chart.label_position_default
         @labels     = labels_properties(params[:data_labels])
 
         [:smooth, :invert_if_negative, :x2_axis, :y2_axis].
@@ -214,10 +218,10 @@ def aref_to_formula(data) # :nodoc:
         xl_range_formula(*data)
       end
 
-      def set_data_ids(chart, params)
-        @cat_data_id = chart.data_id(@categories, params[:categories_data])
-        @val_data_id = chart.data_id(@values, params[:values_data])
-        @name_id = chart.data_id(@name_formula, params[:name_data])
+      def set_data_ids(params)
+        @cat_data_id = @chart.data_id(@categories, params[:categories_data])
+        @val_data_id = @chart.data_id(@values, params[:values_data])
+        @name_id = @chart.data_id(@name_formula, params[:name_data])
       end
 
       def errorbars(x, y)
@@ -233,31 +237,39 @@ def errorbars(x, y)
       def labels_properties(labels) # :nodoc:
         return nil unless labels
 
+        # Map user defined label positions to Excel positions.
         position = labels[:position]
-        if position.nil? || position.empty?
-          labels.delete(:position)
-        else
-          # Map user defined label positions to Excel positions.
-          labels[:position] = value_or_raise(positions, position, 'label position')
+        if ptrue?(position)
+          if @label_positions[position]
+            if position == @label_position_default
+              labels[:position] = nil
+            else
+              labels[:position] = @label_positions[position]
+            end
+          else
+            raise "Unsupported label position '#{position}' for this chart type"
+          end
         end
 
-        labels
-      end
-
-      def positions
-        {
-          :center      => 'ctr',
-          :right       => 'r',
-          :left        => 'l',
-          :top         => 't',
-          :above       => 't',
-          :bottom      => 'b',
-          :below       => 'b',
-          :inside_base => 'inBase',
-          :inside_end  => 'inEnd',
-          :outside_end => 'outEnd',
-          :best_fit    => 'bestFit'
+        # Map the user defined label separator to the Excel separator.
+        separators = {
+          ","  => ", ",
+          ";"  => "; ",
+          "."  => ". ",
+          "\n" => "\n",
+          " "  => " "
         }
+        separator = labels[:separator]
+        unless separator.nil? || separator.empty?
+          raise "unsuppoted label separator #{separator}" unless separators[separator]
+          labels[:separator] = separators[separator]
+        end
+
+        if labels[:font]
+          labels[:font] = @chart.convert_font_args(labels[:font])
+        end
+
+        labels
       end
     end
   end

data/lib/write_xlsx/chart/stock.rb

@@ -35,6 +35,19 @@ def initialize(subtype)
         @x2_axis.defaults[:num_format] = 'dd/mm/yyyy'
         set_x_axis
         set_x2_axis
+
+        # Set the available data label positions for this chart type.
+        @label_position_default = 'right'
+        @label_positions = {
+          'center'      => 'ctr',
+          'right'       => 'r',
+          'left'        => 'l',
+          'above'       => 't',
+          'below'       => 'b',
+          # For backward compatibility.
+          'top'         => 't',
+          'bottom'      => 'b',
+        }
       end
 
       #

data/lib/write_xlsx/utility.rb

@@ -551,7 +551,7 @@ def dash_types
     end
 
     def value_or_raise(hash, key, msg)
-      raise "Unknown #{msg} '#{key}'" unless hash[key.to_sym]
+      raise "Unknown #{msg} '#{key}'" if hash[key.to_sym].nil?
       hash[key.to_sym]
     end
 

data/lib/write_xlsx/version.rb

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

data/lib/write_xlsx/worksheet.rb

@@ -1489,7 +1489,7 @@ def repeat_rows(row_min, row_max = nil)
       area = "$#{row_min}:$#{row_max}"
 
       # Build up the print titles "Sheet1!$1:$2"
-      sheetname = quote_sheetname(name)
+      sheetname = quote_sheetname(@name)
       @page_setup.repeat_rows = "#{sheetname}!#{area}"
     end
 
@@ -7515,7 +7515,7 @@ def convert_name_area(row_num_1, col_num_1, row_num_2, col_num_2) #:nodoc:
       end
 
       # Build up the print area range "Sheet1!$A$1:$C$13".
-      "#{quote_sheetname(name)}!#{area}"
+      "#{quote_sheetname(@name)}!#{area}"
     end
 
     #
@@ -7524,8 +7524,15 @@ def convert_name_area(row_num_1, col_num_1, row_num_2, col_num_2) #:nodoc:
     # TODO. We need to handle more special cases.
     #
     def quote_sheetname(sheetname) #:nodoc:
-      return sheetname if sheetname =~ /^Sheet\d+$/
-      return "'#{sheetname}'"
+      # Use Excel's conventions and quote the sheet name if it comtains any
+      # non-word character or if it isn't already quoted.
+      name = sheetname.dup
+      if name =~ /\W/ && !(name =~ /^'/)
+        # Double quote and single quoted strings.
+        name = name.gsub(/'/, "''")
+        name = "'#{name}'"
+      end
+      name
     end
 
     def fit_page? #:nodoc:

data/test/chart/test_write_d_lbls.rb

@@ -4,7 +4,24 @@
 
 class TestWriteDLbls < Test::Unit::TestCase
   def setup
-    @chart = Writexlsx::Chart.new('Pie')
+    @chart = Writexlsx::Chart.new('Line')
+    @chart.instance_variable_set(
+                                 :@label_positions,
+                                 {
+                                   'center'      => 'ctr',
+                                   'right'       => 'r',
+                                   'left'        => 'l',
+                                   'top'         => 't',
+                                   'above'       => 't',
+                                   'bottom'      => 'b',
+                                   'below'       => 'b',
+                                   'inside_base' => 'inBase',
+                                   'inside_end'  => 'inEnd',
+                                   'outside_end' => 'outEnd',
+                                   'best_fit'    => 'bestFit'
+                                 }
+                                 )
+    @chart.instance_variable_set(:@label_position_default, '')
     @series = Writexlsx::Chart::Series.new(@chart)
   end
 

data/test/regression/test_chart_data_labels01.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestRegressionChartDataLabels01 < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    File.delete(@xlsx) if File.exist?(@xlsx)
+  end
+
+  def test_chart_data_labels01
+    @xlsx = 'chart_data_labels01.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, [45848832, 47718784])
+
+    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',
+                     :data_labels => { :value => 1, :position => 'outside_end' }
+                     )
+
+    chart.add_series(
+                     :values      => '=Sheet1!$B$1:$B$5',
+                     :data_labels => { :value => 1, :position => 'inside_base' }
+                     )
+
+    chart.add_series( :values => '=Sheet1!$C$1:$C$5' )
+
+    worksheet.insert_chart('E9', chart)
+
+    workbook.close
+    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+  end
+end