write_xlsx 1.02.0 → 1.08.1

data/examples/tables.rb

@@ -28,6 +28,7 @@ worksheet9  = workbook.add_worksheet
 worksheet10 = workbook.add_worksheet
 worksheet11 = workbook.add_worksheet
 worksheet12 = workbook.add_worksheet
+worksheet13 = workbook.add_worksheet
 
 currency_format = workbook.add_format(:num_format => '$#,##0')
 
@@ -60,7 +61,7 @@ worksheet1.add_table('B3:F7')
 #
 # Example 2.
 #
-caption = 'Default table with data.';
+caption = 'Default table with data.'
 
 # Set the columns widths.
 worksheet2.set_column('B:G', 12)
@@ -130,7 +131,7 @@ worksheet5.write_col('B4', data)
 #
 # 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)
@@ -149,7 +150,7 @@ worksheet6.write_col('B4', data)
 #
 # 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)
@@ -176,7 +177,7 @@ worksheet7.add_table(
 #
 # 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)
@@ -208,7 +209,7 @@ worksheet8.add_table(
 #
 # 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)
@@ -241,7 +242,7 @@ worksheet9.add_table(
 #
 # 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)
@@ -275,7 +276,7 @@ worksheet10.add_table(
 #
 # Example 11.
 #
-caption = 'Table with alternative Excel style.';
+caption = 'Table with alternative Excel style.'
 
 # Set the columns widths.
 worksheet11.set_column('B:G', 12)
@@ -310,7 +311,7 @@ worksheet11.add_table(
 #
 # Example 12.
 #
-caption = 'Table with column formats.';
+caption = 'Table with no Excel style.'
 
 # Set the columns widths.
 worksheet12.set_column('B:G', 12)
@@ -320,40 +321,74 @@ worksheet12.write('B1', caption)
 
 # Add a table to the worksheet.
 worksheet12.add_table(
-    'B3:G8',
-    {
-        :data      => data,
-        :total_row => 1,
-        :columns   => [
-            { :header => 'Product', :total_string => 'Totals' },
-            {
-                :header         => 'Quarter 1',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Quarter 2',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Quarter 3',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Quarter 4',
-                :total_function => 'sum',
-                :format         => currency_format,
-            },
-            {
-                :header         => 'Year',
-                :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
-                :total_function => 'sum',
-                :format         => currency_format,
-            }
-        ]
-    }
+  '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,
+    :total_row => 1,
+    :columns   => [
+      { :header => 'Product', :total_string => 'Totals' },
+      {
+        :header         => 'Quarter 1',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Quarter 2',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Quarter 3',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Quarter 4',
+        :total_function => 'sum',
+        :format         => currency_format,
+      },
+      {
+        :header         => 'Year',
+        :formula        => '=SUM(Table8[@[Quarter 1]:[Quarter 4]])',
+        :total_function => 'sum',
+        :format         => currency_format,
+      }
+    ]
+  }
 )
 
 workbook.close

data/lib/write_xlsx/chart/line.rb

@@ -22,9 +22,17 @@ module Writexlsx
 
       def initialize(subtype)
         super(subtype)
+        @subtype        = @subtype || 'standard'
         @default_marker = Marker.new(:type => 'none')
         @smooth_allowed = 1
 
+        # Override and reset the default axis values.
+        if @subtype == 'percent_stacked'
+          @y_axis.defaults[:num_format] = '0%'
+        end
+
+        set_y_axis
+
         # Set the available data label positions for this chart type.
         @label_position_default = 'right'
         @label_positions = {
@@ -54,9 +62,15 @@ module Writexlsx
         series = axes_series(params)
         return if series.empty?
 
+        if @subtype == 'percent_stacked'
+          subtype = 'percentStacked'
+        else
+          subtype = @subtype
+        end
+
         @writer.tag_elements('c:lineChart') do
           # Write the c:grouping element.
-          write_grouping('standard')
+          write_grouping(subtype)
           # Write the series elements.
           series.each {|s| write_series(s)}
 

data/lib/write_xlsx/chart/series.rb

@@ -296,10 +296,110 @@ module Writexlsx
           labels[:separator] = separators[separator]
         end
 
+
+        # Set the line properties for the data labels.
+        line = line_properties( labels[:line] )
+
+        # Allow 'border' as a synonym for 'line'.
+        if labels[:border]
+          line = line_properties(labels[:border])
+        end
+
+        # Set the fill properties for the labels.
+        fill = fill_properties(labels[:fill])
+
+        # Set the pattern properties for the labels.
+        pattern = pattern_properties(labels[:pattern])
+
+        # Set the gradient fill properties for the labels.
+        gradient = gradient_properties(labels[:gradient])
+
+        # Pattern fill overrides solid fill.
+        if pattern
+          fill = nil
+        end
+
+        # Gradient fill overrides solid and pattern fills.
+        if gradient
+          pattern = nil
+          fill    = nil
+        end
+
+        labels[:line]     = line
+        labels[:fill]     = fill
+        labels[:pattern]  = pattern
+        labels[:gradient] = gradient
+
         if labels[:font]
           labels[:font] = convert_font_args(labels[:font])
         end
 
+        if labels[:custom]
+          # Duplicate, and modify, the custom label properties.
+          custom = []
+
+          labels[:custom].each do |label|
+            if !label
+              custom << nil
+              next
+            end
+
+            property = label.dup
+
+            # Convert formula.
+            if property[:value] && property[:value] =~ /^=[^!]+!\$/
+              property[:formula] = property[:value]
+            end
+
+            if property[:formula]
+              property[:formula] = property[:formula].sub(/^=/, '')
+
+              data_id = @chart.data_id(property[:formula], property[:data])
+              property[:data_id] = data_id
+            end
+
+            if property[:font]
+              property[:font] = convert_font_args(property[:font])
+            end
+
+            # Allow 'border' as a synonym for 'line'.
+            if property[:border]
+              line = line_properties(property[:border])
+            else
+              # Set the line properties for the data labels.
+              line = line_properties(property[:line])
+            end
+
+            # Set the fill properties for the labels.
+            fill = fill_properties(property[:fill])
+
+            # Set the pattern properties for the labels.
+            pattern = pattern_properties(property[:pattern])
+
+            # Set the gradient fill properties for the labels.
+            gradient = gradient_properties(property[:gradient])
+
+            # Pattern fill overrides solid fill.
+            if pattern
+              fill = nil
+            end
+
+            # Gradient fill overrides solid and pattern fills.
+            if gradient
+              pattern = nil
+              fill    = nil
+            end
+
+            property[:line]     = line
+            property[:fill]     = fill
+            property[:pattern]  = pattern
+            property[:gradient] = gradient
+
+            custom << property
+          end
+          labels[:custom] = custom
+        end
+
         labels
       end
     end

data/lib/write_xlsx/chart.rb

@@ -34,7 +34,7 @@ module Writexlsx
         @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 @@ module Writexlsx
         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 @@ module Writexlsx
         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 @@ module Writexlsx
         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 @@ module Writexlsx
         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)
@@ -1397,7 +1397,7 @@ module Writexlsx
 
     def write_crossing(crossing)
       # Note, the category crossing comes from the value axis.
-      if nil_or_max?(crossing)
+      if [nil, 'max', 'min'].include?(crossing)
         # Write the c:crosses element.
         write_crosses(crossing)
       else
@@ -1693,7 +1693,7 @@ module Writexlsx
         # 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 @@ module Writexlsx
     #
     # 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 @@ module Writexlsx
         # 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 @@ module Writexlsx
     #
     # 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 @@ module Writexlsx
         # 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 @@ module Writexlsx
     #
     # 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 @@ module Writexlsx
       @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 @@ module Writexlsx
       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 @@ module Writexlsx
       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,105 @@ module Writexlsx
       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_d_lbl_pos(parent[:position]) if parent[:position]
+            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_d_lbl_pos(parent[:position]) if parent[:position]
+            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 +2826,7 @@ module Writexlsx
 
             # 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
@@ -2802,9 +2928,5 @@ module Writexlsx
         @writer.empty_tag(tag)
       end
     end
-
-    def nil_or_max?(val)  # :nodoc:
-      val.nil? || val == 'max'
-    end
   end
 end