write_xlsx 0.99.0 → 1.07.0

data/examples/tab_colors.rb

@@ -5,7 +5,7 @@
 # Example of how to set Excel worksheet tab colours.
 #
 # reverse(c), May 2006, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/tables.rb

@@ -9,7 +9,7 @@
 # structure that can be references in a formula or formatted collectively.
 #
 # reverse(c), March 2001, John McNamara, jmcnamara@cpan.org
-# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# convert to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'
@@ -28,6 +28,7 @@
 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 @@
 #
 # 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 @@
 #
 # 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 @@
 #
 # 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 @@
 #
 # 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 @@
 #
 # 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 @@
 #
 # 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 @@
 #
 # 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 @@
 #
 # 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 @@
 
 # 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.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.
@@ -1178,8 +1178,8 @@ def write_cat_axis(params) # :nodoc:
       return unless axis_ids
       return if axis_ids.empty?
 
-      position = @cat_axis_position
-      horiz    = @horiz_cat_axis
+      position  = @cat_axis_position
+      is_y_axis = @horiz_cat_axis
 
       # Overwrite the default axis position with a user supplied value.
       position = x_axis.position || position
@@ -1202,9 +1202,9 @@ def write_cat_axis(params) # :nodoc:
 
         # Write the axis title elements.
         if x_axis.formula
-          write_title_formula(x_axis, horiz, @x_axis, x_axis.layout)
+          write_title_formula(x_axis, is_y_axis, @x_axis, x_axis.layout)
         elsif x_axis.name
-          write_title_rich(x_axis, horiz, 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, horiz = 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, horiz)
+        write_tx_rich(title, is_y_axis, font)
         # Write the c:layout element.
         write_layout(layout, 'text')
         # Write the c:overlay element.
@@ -1822,7 +1822,7 @@ def write_title_rich(title, horiz = nil, layout = nil, overlay = nil) # :nodoc:
     #
     # Write the <c:title> element for a rich string.
     #
-    def write_title_formula(title, horiz = nil, axis = nil, layout = nil, overlay = nil) # :nodoc:
+    def write_title_formula(title, is_y_axis = nil, axis = nil, layout = nil, overlay = nil) # :nodoc:
       @writer.tag_elements('c:title') do
         # Write the c:tx element.
         write_tx_formula(title.formula, axis ? axis.data_id : title.data_id)
@@ -1831,15 +1831,17 @@ def write_title_formula(title, horiz = nil, axis = nil, layout = nil, overlay =
         # Write the c:overlay element.
         write_overlay if overlay
         # Write the c:txPr element.
-        write_tx_pr(horiz, 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, horiz) # :nodoc:
-      @writer.tag_elements('c:tx') { write_rich(title, horiz) }
+    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,29 +1863,30 @@ def write_tx_formula(title, data_id) # :nodoc:
     #
     # Write the <c:rich> element.
     #
-    def write_rich(title, horiz) # :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.
-        write_a_body_pr(rotation, horiz)
+        write_a_body_pr(rotation, is_y_axis)
         # 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.
     #
@@ -2241,7 +2262,12 @@ def write_num_base(tag, data)
         write_format_code('General')
 
         # Write the c:ptCount element.
-        write_pt_count(data.size)
+        if data
+          count = data.size
+        else
+          count = 0
+        end
+        write_pt_count(count)
 
         data.each_with_index do |token, i|
           # Write non-numeric data as 0.
@@ -2344,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.
@@ -2367,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.
     #
@@ -2695,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