write_xlsx 0.81.1 → 0.83.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a47873b65edc4837593147baf4b03c8b7a0aca4c
-  data.tar.gz: 3b18363eaa6f1f1ac48a15c28dd39285202369bf
+  metadata.gz: 055ac6da5fa4ffabd709a61116271eb670a1a946
+  data.tar.gz: da5f1f06369023fec4603457d29cd60b1638e317
 SHA512:
-  metadata.gz: 30ff5c82ce5ede263bee14816a0b52463f60a5336641176dc6bca5669d244996790abbac68491ff1a028b11fa1466a87d86de3ef355e82307832b93cc5cddb5f
-  data.tar.gz: 48d97134f94f572573f1981da0c900a4ce1ac8dea0cf7cba35ccacdd8b27b30e06f61a3b86dae90f54b16999b0014bfa50505a36579ffa7a754099fa3f22e660
+  metadata.gz: 8b09a5444cce89ac0b182f9a82d37ade0e41e5a081cd0c885dcb288e8b6c67a6424ce44dc69e9c6e4e302d4271fb29b9997365ad379629103af99f55fee115ad
+  data.tar.gz: cfd9852383a7cf97b141ab4ec6a1d5eac376cb05c3e6ecbb64a48e3c799bf513c043273e4a26c8890abb36331278e5705ec5abe34806102ceb615ff58a148bf5

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.2.0
+- 2.1.5
+- 2.1.2
+- 2.1.1
+- 2.0.0
+- 1.9.3

data/Changes

@@ -1,4 +1,24 @@
 Change history of write_xlsx rubygem.
+2015-04-12 v0.83.0
+   Added option to combine two different chart types. For example to
+   create a Pareto chart.
+
+2015-04-12 v0.82.0
+   Added extra documentation on how to handle VBA macros and added
+   automatic and manual setting of workbook and worksheet VBA codenames.
+
+   Fix for set_start_page() for values > 1.
+
+   Fix to copy user defined chart properties, such as trendlines,
+   so that they aren't overwritten.
+
+   Added column funtion_value option to add_table to allow
+   function value to be set.
+
+   Allow explicit text categories in charts.
+
+   Fix for column/bar gap/overlap on y2 axis.
+
 2014-12-28 v0.81.1
    use test-unit gem instead of test/unit.
 

data/README.md

@@ -1,10 +1,11 @@
 # write_xlsx
 
 [![Gem Version](https://badge.fury.io/rb/write_xlsx.png)](http://badge.fury.io/rb/write_xlsx)
+[![Build Status](https://travis-ci.org/cxn03651/write_xlsx.svg?branch=master)](https://travis-ci.org/cxn03651/write_xlsx)
 
 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.81](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.83](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 
@@ -84,7 +85,7 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
 Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp)
-Copyright (c) 2012-2014 Hideo NAKAMURA.
+Copyright (c) 2012-2015 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 

data/examples/chart_combined.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# An example of a Combined chart in WriteXLSX.
+#
+# reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_combined.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = ['Number', 'Batch 1', 'Batch 2']
+data = [
+  [ 2,  3,  4,  5,  6,  7],
+  [10, 40, 50, 20, 10, 50],
+  [30, 60, 70, 50, 40, 30]
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write('A2', data)
+
+#
+# In the first example we will create a combined column and line chart.
+# They will share the same X and Y axes.
+#
+
+# Create a new column chart. This will use this as the primary chart.
+column_chart1 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the data series for the primary chart.
+column_chart1.add_series(
+  :name       => '=Sheet1!$B$1',
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Create a new column chart. This will use this as the secondary chart.
+line_chart1 = workbook.add_chart(:type => 'line', :embedded => 1)
+
+# Configure the data series for the secondary chart.
+line_chart1.add_series(
+  :name       => '=Sheet1!$C$1',
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$C$2:$C$7'
+)
+
+# Combine the charts.
+column_chart1.combine(line_chart1)
+
+# Add a chart title and some axis labels. Note, this is done via the
+# primary chart.
+column_chart1.set_title(:name => 'Combined chart - same Y axis')
+column_chart1.set_x_axis(:name => 'Test number')
+column_chart1.set_y_axis(:name => 'Sample length (mm)')
+
+
+# Insert the chart into the worksheet
+worksheet.insert_chart('E2', column_chart1)
+
+#
+# In the second example we will create a similar combined column and line
+# chart except that the secondary chart will have a secondary Y axis.
+#
+
+# Create a new column chart. This will use this as the primary chart.
+column_chart2 = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the data series for the primary chart.
+column_chart2.add_series(
+  :name       => '=Sheet1!$B$1',
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Create a new column chart. This will use this as the secondary chart.
+line_chart2 = workbook.add_chart(:type => 'line', :embedded => 1)
+
+# Configure the data series for the secondary chart. We also set a
+# secondary Y axis via (y2_axis). This is the only difference between
+# this and the first example, apart from the axis label below.
+line_chart2.add_series(
+  :name       => '=Sheet1!$C$1',
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$C$2:$C$7',
+  :y2_axis    => 1
+)
+
+# Combine the charts.
+column_chart2.combine(line_chart2)
+
+# Add a chart title and some axis labels.
+column_chart2.set_title(:name => 'Combine chart - secondary Y axis')
+column_chart2.set_x_axis(:name => 'Test number')
+column_chart2.set_y_axis(:name => 'Sample length (mm)')
+column_chart2.set_y2_axis(:name => 'Target length (mm)')
+
+# Insert the chart into the worksheet
+worksheet.insert_chart('E18', column_chart2)
+
+workbook.close

data/examples/chart_data_table.rb

@@ -3,7 +3,7 @@
 
 #######################################################################
 #
-# A demo of an Column chart with a data table on the X-axis using
+# A demo of a Column chart with a data table on the X-axis using
 # WriteXLSX.
 #
 # reverse ('(c)'), December 2012, John McNamara, jmcnamara@cpan.org

data/examples/chart_pareto.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A demo of a Pareto chart in Excel::Writer::XLSX.
+#
+# reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_pareto.xlsx')
+worksheet = workbook.add_worksheet
+
+# Formats used in the workbook.
+bold           = workbook.add_format(:bold => 1)
+percent_format = workbook.add_format(:num_format => '0.0%')
+
+# Widen the columns for visibility.
+worksheet.set_column('A:A', 15)
+worksheet.set_column('B:C', 10)
+
+# Add the worksheet data that the charts will refer to.
+headings = ['Reason', 'Number', 'Percentage']
+
+reasons = [
+  'Traffic',   'Child care', 'Public Transport', 'Weather',
+  'Overslept', 'Emergency'
+]
+
+numbers  = [  60,    40,  20,  15,    10, 5]
+percents = [0.44, 0.667, 0.8, 0.9, 0.967, 1]
+
+worksheet.write_row('A1', headings, bold)
+worksheet.write_col('A2', reasons)
+worksheet.write_col('B2', numbers)
+worksheet.write_col('C2', percents, percent_format)
+
+# Create a new column chart. This will be the primary chart.
+column_chart = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Add a series
+column_chart.add_series(
+  :categories => 'Sheet1!$A$2:$A$7',
+  :values     => 'Sheet1!$B$2:$B$7'
+)
+
+# Add a chart title.
+column_chart.set_title(:name => 'Reasons for lateness')
+
+# Turn off the chart legend.
+column_chart.set_legend(:position => 'none')
+
+# Set the title and scale of the Y axes. Note, the secondary axis is set from
+# the primary chart.
+column_chart.set_y_axis(
+  :name => 'Respondents (number)',
+  :min  => 0,
+  :max  => 120
+)
+column_chart.set_y2_axis(:max => 1)
+
+# Create a new line chart. This will be the secondary chart.
+line_chart = workbook.add_chart(:type => 'line', :embedded => 1)
+
+# Add a series, on the secondary axis.
+line_chart.add_series(
+  :categories => '=Sheet1!$A$2:$A$7',
+  :values     => '=Sheet1!$C$2:$C$7',
+  :marker     => {:type => 'automatic'},
+  :y2_axis    => 1
+)
+
+# Combine the charts.
+column_chart.combine(line_chart)
+
+# Insert the chart into the worksheet.
+worksheet.insert_chart('F2', column_chart)
+
+workbook.close

data/lib/write_xlsx/chart.rb

@@ -141,7 +141,11 @@ 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
+    attr_reader :label_positions, :label_position_default, :combined # :nodoc:
+    attr_writer :date_category, :already_inserted
+    attr_writer :series_index
+    attr_writer :writer
+    attr_reader :x2_axis, :y2_axis, :axis2_ids
 
     #
     # Factory method for returning chart objects based on their class type.
@@ -185,7 +189,7 @@ def initialize(subtype)   # :nodoc:
       @sheet_type        = 0x0200
       @series            = []
       @embedded          = 0
-      @id                = ''
+      @id                = -1
       @series_index      = 0
       @style_id          = 2
       @formula_ids       = {}
@@ -197,6 +201,8 @@ def initialize(subtype)   # :nodoc:
       @name              = ''
       @table             = nil
       set_default_properties
+      @combined          = nil
+      @is_secondary      = false
     end
 
     def set_xml_writer(filename)   # :nodoc:
@@ -245,6 +251,11 @@ def add_series(params)
       x2_axis = params[:x2_axis]
       y2_axis = params[:y2_axis]
 
+      # Store secondary status for combined charts.
+      if ptrue?(x2_axis) || ptrue?(y2_axis)
+        @is_secondary = true
+      end
+
       # Set the gap and overlap for Bar/Column charts.
       if params[:gap]
         if ptrue?(y2_axis)
@@ -342,7 +353,7 @@ def set_chartarea(params)
     # Set on of the 42 built-in Excel chart styles. The default style is 2.
     #
     def set_style(style_id = 2)
-      style_id = 2 if style_id < 0 || style_id > 42
+      style_id = 2 if style_id < 0 || style_id > 48
       @style_id = style_id
     end
 
@@ -423,6 +434,13 @@ def set_high_low_lines(params = {})
       @hi_low_lines = Chartline.new(params)
     end
 
+    #
+    # Add another chart to create a combined chart.
+    #
+    def combine(chart)
+      @combined = chart
+    end
+
     #
     # Setup the default configuration data for an embedded chart.
     #
@@ -518,7 +536,12 @@ def params_to_font(params)
     #
     def process_names(name = nil, name_formula = nil) # :nodoc:
       # Name looks like a formula, use it to set name_formula.
-      if name && name =~ /^=[^!]+!\$/
+      if name.respond_to?(:to_ary)
+        cell = xl_rowcol_to_cell(name[1], name[2], 1, 1)
+        name_formula = "#{quote_sheetname(name[0])}!#{cell}"
+        name = ''
+      elsif
+        name && name =~ /^=[^!]+!\$/
         name_formula = name
         name         = ''
       end
@@ -556,6 +579,14 @@ def data_id(full_formula, data) # :nodoc:
       id
     end
 
+    def already_inserted?
+      @already_inserted
+    end
+
+    def is_secondary?
+      @is_secondary
+    end
+
     private
 
     def axis_setup
@@ -663,11 +694,11 @@ def add_axis_ids(params) # :nodoc:
     end
 
     def ids
-      chart_id   = 1 + @id
+      chart_id   = 5001 + @id
       axis_count = 1 + @axis2_ids.size + @axis_ids.size
 
-      id1 = sprintf('5%03d%04d', chart_id, axis_count)
-      id2 = sprintf('5%03d%04d', chart_id, axis_count + 1)
+      id1 = sprintf('%04d%04d', chart_id, axis_count)
+      id2 = sprintf('%04d%04d', chart_id, axis_count + 1)
 
       [id1, id2]
     end
@@ -832,6 +863,7 @@ def write_disp_blanks_as
     # Write the <c:plotArea> element.
     #
     def write_plot_area   # :nodoc:
+      second_chart = @combined
       @writer.tag_elements('c:plotArea') do
         # Write the c:layout element.
         write_layout(@plotarea.layout, 'plot')
@@ -839,6 +871,27 @@ def write_plot_area   # :nodoc:
         write_chart_type(:primary_axes => 1)
         write_chart_type(:primary_axes => 0)
 
+        # Configure a combined chart if present.
+        if second_chart
+
+          # Secondary axis has unique id otherwise use same as primary.
+          if second_chart.is_secondary?
+            second_chart.id = 1000 + @id
+          else
+            second_chart.id = @id
+          end
+
+          # Share the same writer for writing.
+          second_chart.writer = @writer
+
+          # Share series index with primary chart.
+          second_chart.series_index = @series_index
+
+          # Write the subclass chart type elements for combined chart.
+          second_chart.write_chart_type(:primary_axes => 1)
+          second_chart.write_chart_type(:primary_axes => 0)
+        end
+
         # Write the category and value elements for the primary axes.
         params = {
           :x_axis   => @x_axis,
@@ -852,7 +905,7 @@ def write_plot_area   # :nodoc:
           write_cat_axis(params)
         end
 
-        write_val_axis(params)
+        write_val_axis(@x_axis, @y_axis, @axis_ids)
 
         # Write the category and value elements for the secondary axes.
         params = {
@@ -861,7 +914,23 @@ def write_plot_area   # :nodoc:
           :axis_ids => @axis2_ids
         }
 
-        write_val_axis(params)
+        write_val_axis(@x2_axis, @y2_axis, @axis2_ids)
+
+        # Write the secondary axis for the secondary chart.
+        if second_chart && second_chart.is_secondary?
+
+          params = {
+            :x_axis   => second_chart.x2_axis,
+            :y_axis   => second_chart.y2_axis,
+            :axis_ids => second_chart.axis2_ids
+          }
+
+          second_chart.write_val_axis(
+            second_chart.x2_axis,
+            second_chart.y2_axis,
+            second_chart.axis2_ids
+          )
+        end
 
         if @date_category
           write_date_axis(params)
@@ -937,30 +1006,10 @@ def write_series(series) # :nodoc:
     # Write the <c:ser> element.
     #
     def write_ser(series) # :nodoc:
-      index = @series_index
-      @series_index += 1
-
       @writer.tag_elements('c:ser') do
-        # Write the c:idx element.
-        write_idx(index)
-        # Write the c:order element.
-        write_order(index)
-        # Write the series name.
-        write_series_name(series)
-        # Write the c:spPr element.
-        write_sp_pr(series)
-        # Write the c:marker element.
-        write_marker(series.marker)
-        # Write the c:invertIfNegative element.
-        write_c_invert_if_negative(series.invert_if_negative)
-        # Write the c:dPt element.
-        write_d_pt(series.points)
-        # Write the c:dLbls element.
-        write_d_lbls(series.labels)
-        # Write the c:trendline element.
-        write_trendline(series.trendline)
-        # Write the c:errBars element.
-        write_error_bars(series.error_bars)
+        write_ser_base(series) do
+          write_c_invert_if_negative(series.invert_if_negative)
+        end
         # Write the c:cat element.
         write_cat(series)
         # Write the c:val element.
@@ -968,6 +1017,31 @@ def write_ser(series) # :nodoc:
         # Write the c:smooth element.
         write_c_smooth(series.smooth) if ptrue?(@smooth_allowed)
       end
+      @series_index += 1
+    end
+
+    def write_ser_base(series)
+      # Write the c:idx element.
+      write_idx(@series_index)
+      # Write the c:order element.
+      write_order(@series_index)
+      # Write the series name.
+      write_series_name(series)
+      # Write the c:spPr element.
+      write_sp_pr(series)
+      # Write the c:marker element.
+      write_marker(series.marker)
+
+      yield if block_given?
+
+      # Write the c:dPt element.
+      write_d_pt(series.points)
+      # Write the c:dLbls element.
+      write_d_lbls(series.labels)
+      # Write the c:trendline element.
+      write_trendline(series.trendline)
+      # Write the c:errBars element.
+      write_error_bars(series.error_bars)
     end
 
     #
@@ -1177,7 +1251,7 @@ def write_cat_axis(params) # :nodoc:
           write_crossing(y_axis.crossing)
         end
         # Write the c:auto element.
-        write_auto(1)
+        write_auto(1) unless x_axis.text_axis
         # Write the c:labelAlign element.
         write_label_align('ctr')
         # Write the c:labelOffset element.
@@ -1190,18 +1264,17 @@ def write_cat_axis(params) # :nodoc:
     #
     # Write the <c:valAx> element. Usually the Y axis.
     #
-    def write_val_axis(params)
-      axis_ids = params[:axis_ids]
+    def write_val_axis(x_axis, y_axis, axis_ids, position = nil)
       return unless axis_ids && !axis_ids.empty?
 
-      x_axis   = params[:x_axis]
-      y_axis   = params[:y_axis]
-      axis_ids_0 = axis_ids[0]
-      axis_ids_1 = axis_ids[1]
-      position = y_axis.position || params[:position] || @val_axis_position
-
-      write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)
+      write_val_axis_base(
+        x_axis, y_axis,
+        axis_ids[0],
+        axis_ids[1],
+        y_axis.position || position || @val_axis_position
+      )
     end
+    public :write_val_axis
 
     def write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)  # :nodoc:
       @writer.tag_elements('c:valAx') do