write_xlsx 0.85.9 → 1.09.2

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'
@@ -20,6 +20,6 @@ worksheet4 = workbook.add_worksheet
 # Worksheet1 will have the default tab colour.
 worksheet2.tab_color = 'red'
 worksheet3.tab_color = 'green'
-worksheet4.tab_color = 0x35    # Orange
+worksheet4.tab_color = '#FF6600'    # Orange
 
 workbook.close

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 @@ 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/examples/update_range_format_with_params.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A simple example of how to use the write_xlsx gem to
+# update format of the range of cells.
+#
+
+require 'write_xlsx'
+
+workbook = WriteXLSX.new('update_range_format_with_params.xlsx')
+worksheet = workbook.add_worksheet
+
+common_format = workbook.add_format(align: 'center', border: 1)
+
+table_contents = [
+  ['Table', 'Header', 'Contents'],
+  ['table', 'body', 'contents'],
+  ['table', 'body', 'contents'],
+  ['table', 'body', 'contents']
+]
+
+worksheet.write_col(0, 0, table_contents, common_format)
+worksheet.update_range_format_with_params(
+  0, 0, 0, 2,
+  bold: 1, top: 2, bottom: 2, bg_color: 31
+)
+worksheet.update_range_format_with_params(0, 0, 3, 0, left: 2)
+worksheet.update_range_format_with_params(0, 2, 3, 2, right: 2)
+worksheet.update_range_format_with_params(3, 0, 3, 2, bottom: 2)
+
+workbook.close

data/lib/write_xlsx/chart/area.rb

@@ -8,7 +8,7 @@
 # See formatting note in Chart.
 #
 # Copyright 2000-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/package/xml_writer_simple'

data/lib/write_xlsx/chart/axis.rb

@@ -9,13 +9,14 @@ module Writexlsx
       include Writexlsx::Utility
 
       attr_accessor :defaults
-      attr_accessor :min, :max, :num_format, :position, :major_tick_mark
+      attr_accessor :min, :max, :num_format, :position
+      attr_accessor :major_tick_mark, :minor_tick_mark
       attr_reader :minor_unit, :major_unit, :minor_unit_type, :major_unit_type
       attr_reader :display_units_visible, :display_units
       attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
       attr_reader :num_format_linked, :num_font, :layout, :interval_unit
-      attr_reader :major_gridlines, :minor_gridlines, :reverse
-      attr_reader :line, :fill, :text_axis
+      attr_reader :interval_tick, :major_gridlines, :minor_gridlines, :reverse
+      attr_reader :line, :fill, :text_axis, :label_align
       #
       # Convert user defined axis values into axis instance.
       #
@@ -27,11 +28,11 @@ module Writexlsx
           :reverse, :min, :max, :minor_unit, :major_unit, :minor_unit_type,
           :major_unit_type, :log_base, :crossing, :position_axis,
           :label_position, :num_format, :num_format_linked, :interval_unit,
-          :major_tick_mark, :line, :fill
+          :interval_tick, :line, :fill, :label_align
         ].each { |val| instance_variable_set("@#{val}", args[val]) }
-        @visible           = args[:visible] || 1
-
         set_major_minor_gridlines(args)
+
+        @visible           = args[:visible] || 1
         set_display_units(args)
         set_display_units_visible(args)
         set_position(args)
@@ -44,6 +45,10 @@ module Writexlsx
           @chart.date_category = false
           @text_axis = true
         end
+
+        # Set the tick marker types.
+        @major_tick_mark = get_tick_type(params[:major_tick_mark])
+        @minor_tick_mark = get_tick_type(params[:minor_tick_mark])
       end
 
       #
@@ -82,8 +87,8 @@ module Writexlsx
 
       def num_fmt_attributes
         [
-         ['formatCode',   @num_format],
-         ['sourceLinked', source_linked]
+          ['formatCode',   @num_format],
+          ['sourceLinked', source_linked]
         ]
       end
 
@@ -126,6 +131,26 @@ module Writexlsx
         end
       end
 
+      #
+      # Convert user tick types to internal units.
+      #
+      def get_tick_type(tick_type)
+        return if !ptrue?(tick_type)
+
+        types = {
+          'outside' => 'out',
+          'inside'  => 'in',
+          'none'    => 'none',
+          'cross'   => 'cross'
+        }
+
+        if(types[tick_type])
+          return types[tick_type]
+        else
+          raise "Unknown tick_type type '#{tick_type}'\n"
+        end
+      end
+
       def set_display_units(args)
         @display_units = get_display_units(args[:display_units])
       end
@@ -134,7 +159,7 @@ module Writexlsx
         if args[:display_units_visible]
           @display_units_visible = args[:display_units_visible]
         else
-          @display_units_visible = 1;
+          @display_units_visible = 1
         end
       end
 
@@ -150,7 +175,7 @@ module Writexlsx
           if @position_axis == 'on_tick'
             @position_axis = 'midCat'
           elsif @position_axis == 'between'
-            # Doesn't neet to be modified.
+          # Doesn't neet to be modified.
           else
             # Otherwise use the default value.
             @position_axis = nil
@@ -159,8 +184,8 @@ module Writexlsx
       end
 
       def set_font_properties(args)
-        @num_font  = @chart.convert_font_args(args[:num_font])
-        @name_font = @chart.convert_font_args(args[:name_font])
+        @num_font  = convert_font_args(args[:num_font])
+        @name_font = convert_font_args(args[:name_font])
       end
 
       def set_axis_name_layout(args)

data/lib/write_xlsx/chart/bar.rb

@@ -8,7 +8,7 @@
 # See formatting note in Chart.
 #
 # Copyright 2000-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/package/xml_writer_simple'

data/lib/write_xlsx/chart/caption.rb

@@ -3,6 +3,8 @@
 module Writexlsx
   class Chart
     class Caption
+      include Writexlsx::Utility
+
       attr_accessor :name, :formula, :data_id, :name_font
       attr_reader :layout, :overlay, :none
 
@@ -13,7 +15,7 @@ module Writexlsx
       def merge_with_hash(params) # :nodoc:
         @name, @formula = @chart.process_names(params[:name], params[:name_formula])
         @data_id        = @chart.data_id(@formula, params[:data])
-        @name_font      = @chart.convert_font_args(params[:name_font])
+        @name_font      = convert_font_args(params[:name_font])
         @layout   = @chart.layout_properties(params[:layout], 1)
 
         # Set the title overlay option.

data/lib/write_xlsx/chart/column.rb

@@ -8,7 +8,7 @@
 # See formatting note in Chart.
 #
 # Copyright 2000-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/package/xml_writer_simple'

data/lib/write_xlsx/chart/doughnut.rb

@@ -8,7 +8,7 @@
 # See formatting note in Excel::Writer::XLSX::Chart.
 #
 # Copyright 2000-2014, 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/package/xml_writer_simple'

data/lib/write_xlsx/chart/legend.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+module Writexlsx
+  class Chart
+    class Legend
+      attr_accessor :line, :fill, :pattern, :gradient
+      attr_accessor :position, :delete_series, :layout, :font
+
+      def initialize
+        @position = 'right'
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/line.rb

@@ -8,7 +8,7 @@
 # See formatting note in Chart.
 #
 # Copyright 2000-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/package/xml_writer_simple'
@@ -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)}