write_xlsx 0.97.0 → 1.04.0

data/examples/merge6.rb

@@ -7,7 +7,7 @@
 # method with Unicode strings.
 #
 # reverse(c), December 2005, 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/outline.rb

@@ -61,7 +61,7 @@
 # See the main Excel::Writer::XLSX documentation for more information.
 #
 # reverse(c), April 2003, 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/outline_collapsed.rb

@@ -9,7 +9,7 @@
 # outlines.pl example program for more general examples.
 #
 # reverse ('(c)'), March 2008, 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/panes.rb

@@ -6,7 +6,7 @@
 # Example of using the Excel::Writer::XLSX module to create worksheet panes.
 #
 # reverse(c), May 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'

data/examples/properties.rb

@@ -6,7 +6,7 @@
 # An example of adding document properties to a Excel::Writer::XLSX file.
 #
 # reverse('©'), August 2008, 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/regions.rb

@@ -7,7 +7,7 @@
 # Excel workbook with multiple worksheets.
 #
 # 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'

data/examples/rich_strings.rb

@@ -7,7 +7,7 @@
 # strings with multiple formatting.
 #
 # reverse(c), February 2011, 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/right_to_left.rb

@@ -7,7 +7,7 @@
 # of Excel.
 #
 # reverse(c), January 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/shape1.rb

@@ -7,7 +7,7 @@
 # add shapes to an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape2.rb

@@ -7,7 +7,7 @@
 # modify shapes properties in an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape3.rb

@@ -7,7 +7,7 @@
 # scale shapes in an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape4.rb

@@ -7,7 +7,7 @@
 # demonstrate stenciling in an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape5.rb

@@ -7,7 +7,7 @@
 # add shapes (objects and top/bottom connectors) to an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape6.rb

@@ -7,7 +7,7 @@
 # add shapes (objects and right/left connectors) to an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape7.rb

@@ -7,7 +7,7 @@
 # add shapes and one-to-many connectors to an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape8.rb

@@ -7,7 +7,7 @@
 # add shapes and one-to-many connectors to an Excel xlsx file.
 #
 # reverse('c'), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to Ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to Ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 
 require 'write_xlsx'

data/examples/shape_all.rb

@@ -10,7 +10,7 @@
 # part of the ECMA-376 standard.
 #
 # reverse(c), May 2012, John McNamara, jmcnamara@cpan.org
-# converted to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+# converted to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
 #
 require 'write_xlsx'
 

data/examples/sparklines1.rb

@@ -10,7 +10,7 @@
 # of more complex sparkline formatting.
 #
 # reverse ('(c)'), November 2011, 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/sparklines2.rb

@@ -10,7 +10,7 @@
 # options that can be applied to sparklines.
 #
 # reverse ('(c)'), November 2011, 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/stats.rb

@@ -6,7 +6,7 @@
 # A Simple example of how to use functions with the WriteXLSX gem.
 #
 # 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'

data/examples/stats_ext.rb

@@ -9,7 +9,7 @@
 # other worksheets within the same workbook.
 #
 # 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'

data/examples/stocks.rb

@@ -9,7 +9,7 @@
 # with colours to indicate if a share price has gone up or down.
 #
 # 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'

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

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/gradient'
+require 'write_xlsx/chart/legend'
 require 'write_xlsx/utility'
 require 'write_xlsx/chart/axis'
 require 'write_xlsx/chart/caption'
@@ -162,6 +163,7 @@ def numeric_or_downcase(val)
 
   class Chart
     include Writexlsx::Utility
+    include Writexlsx::Gradient
 
     attr_accessor :id, :name   # :nodoc:
     attr_writer :index, :palette, :protection   # :nodoc:
@@ -352,16 +354,8 @@ def set_title(params)
     # Set the properties of the chart legend.
     #
     def set_legend(params)
-      if params[:none]
-        @legend_position = 'none'
-      else
-        @legend_position = params[:position] || 'right'
-      end
-      @legend_delete_series = params[:delete_series]
-      @legend_font          = convert_font_args(params[:font])
-
-      # Set the legend layout.
-      @legend_layout = layout_properties(params[:layout])
+      # Convert the user default properties to internal properties.
+      legend_properties(params)
     end
 
     #
@@ -611,7 +605,7 @@ def display_setup
       @y_scale           = 1
       @x_offset          = 0
       @y_offset          = 0
-      @legend_position   = 'right'
+      @legend            = Legend.new
       @smooth_allowed    = 0
       @cross_between     = 'between'
       @date_category     = false
@@ -1184,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
@@ -1208,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.layout)
         end
 
         # Write the c:numFmt element.
@@ -1240,7 +1234,7 @@ def write_cat_axis(params) # :nodoc:
         # Write the c:auto element.
         write_auto(1) unless x_axis.text_axis
         # Write the c:labelAlign element.
-        write_label_align('ctr')
+        write_label_align(x_axis.label_align)
         # Write the c:labelOffset element.
         write_label_offset(100)
         # Write the c:tickLblSkip element.
@@ -1574,6 +1568,12 @@ def write_auto(val) # :nodoc:
     # Write the <c:labelAlign> element.
     #
     def write_label_align(val) # :nodoc:
+      val ||= 'ctr'
+      if val == 'right'
+        val = 'r'
+      elsif val == 'left'
+        val = 'l'
+      end
       @writer.empty_tag('c:lblAlgn', [ ['val', val] ])
     end
 
@@ -1676,10 +1676,10 @@ def write_c_minor_time_unit(val) # :nodoc:
     # Write the <c:legend> element.
     #
     def write_legend # :nodoc:
-      position = @legend_position.sub(/^overlay_/, '')
+      position = @legend.position.sub(/^overlay_/, '')
       return if position == 'none' || (not position_allowed.has_key?(position))
 
-      @delete_series = @legend_delete_series if @legend_delete_series.kind_of?(Array)
+      @delete_series = @legend.delete_series if @legend.delete_series.kind_of?(Array)
       @writer.tag_elements('c:legend') do
         # Write the c:legendPos element.
         write_legend_pos(position_allowed[position])
@@ -1687,20 +1687,23 @@ def write_legend # :nodoc:
         # Write the c:legendEntry element.
         @delete_series.each { |i| write_legend_entry(i) } if @delete_series
         # Write the c:layout element.
-        write_layout(@legend_layout, 'legend')
-        # Write the c:txPr element.
-        write_tx_pr(nil, @legend_font) if ptrue?(@legend_font)
+        write_layout(@legend.layout, 'legend')
         # Write the c:overlay element.
-        write_overlay if @legend_position =~ /^overlay_/
+        write_overlay if @legend.position =~ /^overlay_/
+        # Write the c:spPr element.
+        write_sp_pr(@legend)
+        # Write the c:txPr element.
+        write_tx_pr(nil, @legend.font) if ptrue?(@legend.font)
       end
     end
 
     def position_allowed
       {
-        'right'  => 'r',
-        'left'   => 'l',
-        'top'    => 't',
-        'bottom' => 'b'
+        'right'     => 'r',
+        'left'      => 'l',
+        'top'       => 't',
+        'bottom'    => 'b',
+        'top_right' => 'tr'
       }
     end
 
@@ -1805,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 = nil, layout = nil, 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)
         # Write the c:layout element.
         write_layout(layout, 'text')
         # Write the c:overlay element.
@@ -1819,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)
@@ -1828,15 +1831,15 @@ 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(is_y_axis, axis ? axis.name_font : title.name_font)
       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) # :nodoc:
+      @writer.tag_elements('c:tx') { write_rich(title, is_y_axis) }
     end
 
     #
@@ -1858,14 +1861,14 @@ def write_tx_formula(title, data_id) # :nodoc:
     #
     # Write the <c:rich> element.
     #
-    def write_rich(title, horiz) # :nodoc:
+    def write_rich(title, is_y_axis) # :nodoc:
       rotation = nil
       if title.name_font && title.name_font[:_rotation]
         rotation = title.name_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.
@@ -2238,7 +2241,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.