write_xlsx 0.89.0 → 1.01.0

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

@@ -16,7 +16,7 @@ class Axis < Caption
       attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
       attr_reader :num_format_linked, :num_font, :layout, :interval_unit
       attr_reader :interval_tick, :major_gridlines, :minor_gridlines, :reverse
-      attr_reader :line, :fill, :text_axis
+      attr_reader :line, :fill, :text_axis, :label_align
       #
       # Convert user defined axis values into axis instance.
       #
@@ -28,7 +28,7 @@ def merge_with_hash(params) # :nodoc:
           :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,
-          :interval_tick, :line, :fill
+          :interval_tick, :line, :fill, :label_align
         ].each { |val| instance_variable_set("@#{val}", args[val]) }
         set_major_minor_gridlines(args)
 
@@ -184,8 +184,8 @@ def set_position_axis
       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 @@ def initialize(chart)
       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'

data/lib/write_xlsx/chart/pie.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'
@@ -42,13 +42,6 @@ def initialize(subtype)
         }
       end
 
-      #
-      # Override parent method to add a warning.
-      #
-      def combine(chart)
-        raise "Combined chart not currently supported for Pie charts"
-      end
-
       #
       # Set the Pie/Doughnut chart rotation: the angle of the first slice.
       #
@@ -91,11 +84,33 @@ def write_pie_chart
       # Write the <c:plotArea> element.
       #
       def write_plot_area
+        second_chart = @combined
+
         @writer.tag_elements('c:plotArea') do
           # Write the c:layout element.
           write_layout(@plotarea.layout, 'plot')
           # Write the subclass chart type element.
           write_chart_type
+          # 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 filehandle 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
+          end
+          # Write the c:spPr eleent for the plotarea formatting.
+          write_sp_pr(@plotarea)
         end
       end
 
@@ -105,15 +120,15 @@ def write_plot_area
       # Write the <c:legend> element.
       #
       def write_legend
-        position = @legend_position
+        position = @legend.position
         allowed  = %w(right left top bottom)
-        delete_series = @legend_delete_series || []
+        delete_series = @legend.delete_series || []
 
-        if @legend_position =~ /^overlay_/
-          position = @legend_position.sub(/^overlay_/, '')
+        if @legend.position =~ /^overlay_/
+          position = @legend.position.sub(/^overlay_/, '')
           overlay = true
         else
-          position = @legend_position
+          position = @legend.position
           overlay = false
         end
 
@@ -127,11 +142,13 @@ def write_legend
           # Write the c:legendEntry element.
           delete_series.each { |index| write_legend_entry(index) }
           # Write the c:layout element.
-          write_layout(@legend_layout, 'legend')
+          write_layout(@legend.layout, 'legend')
           # Write the c:overlay element.
           write_overlay if overlay
+          # Write the c:spPr element.
+          write_sp_pr(@legend)
           # Write the c:txPr element. Over-ridden.
-          write_tx_pr_legend(0, @legend_font)
+          write_tx_pr_legend(0, @legend.font)
         end
       end
 

data/lib/write_xlsx/chart/radar.rb

@@ -8,7 +8,7 @@
 # See formatting note in Chart.
 #
 # Copyright 2000-2012, 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/scatter.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/series.rb

@@ -57,16 +57,20 @@ def initialize(params)
 
     class Trendline < Chartline
       attr_reader :name, :forward, :backward, :order, :period
+      attr_reader :intercept, :display_equation, :display_r_squared
 
       def initialize(params)
         super(params)
 
-        @name     = params[:name]
-        @forward  = params[:forward]
-        @backward = params[:backward]
-        @order    = params[:order]
-        @period   = params[:period]
-        @type     = value_or_raise(types, params[:type], 'trendline type')
+        @name              = params[:name]
+        @forward           = params[:forward]
+        @backward          = params[:backward]
+        @order             = params[:order]
+        @period            = params[:period]
+        @intercept         = params[:intercept]
+        @display_equation  = params[:display_equation]
+        @display_r_squared = params[:display_r_squared]
+        @type              = value_or_raise(types, params[:type], 'trendline type')
       end
 
       private
@@ -293,7 +297,7 @@ def labels_properties(labels) # :nodoc:
         end
 
         if labels[:font]
-          labels[:font] = @chart.convert_font_args(labels[:font])
+          labels[:font] = convert_font_args(labels[:font])
         end
 
         labels

data/lib/write_xlsx/chart/stock.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/chartsheet.rb

@@ -6,7 +6,7 @@
 # Used in conjunction with WriteXLSX
 #
 # 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/worksheet'
@@ -19,7 +19,7 @@ class Chartsheet < Worksheet
 
     def initialize(workbook, index, name)
       super
-      @drawing           = Drawing.new
+      @drawings          = Drawings.new
       @is_chartsheet     = true
       @chart             = nil
       @charts            = [1]
@@ -57,11 +57,39 @@ def assemble_xml_file # :nodoc:
       end
     end
 
-    def protect(password = '', options = {})
+    def protect(password = '', user_options = nil, options = {})
+      # Objects are default on for chartsheets.
+      if user_options
+        if user_options.has_key?(:objects)
+          if ptrue?(user_options[:objects])
+            options[:objects] = 0
+          else
+            options[:objects] = 1
+          end
+        else
+          options[:objects] = 0
+        end
+
+        if user_options.has_key?(:content)
+          options[:content] = user_options[:content]
+        else
+          options[:content] = 1
+        end
+      else
+        options[:objects] = 0
+        options[:content] = 1
+      end
+
+      # Is objects and content are off then the chartsheet isn't locked.
+      # except if it has a password.
+      if password == '' && ptrue?(options[:objects]) && !ptrue?(options[:content])
+        return
+      end
+
       @chart.protection = 1
 
+      # Turn off worksheet defaults.
       options[:sheet]     = 0
-      options[:content]   = 1
       options[:scenarios] = 1
 
       super(password, options)
@@ -148,9 +176,9 @@ def set_high_low_lines(*args)
     def prepare_chart(index, chart_id, drawing_id) # :nodoc:
       @chart.id = chart_id - 1
 
-      drawing = Drawing.new
-      @drawing = drawing
-      @drawing.orientation = @page_setup.orientation
+      drawings  = Drawings.new
+      @drawings = drawings
+      @drawings.orientation = @page_setup.orientation
 
       @external_drawing_links << [ '/drawing', "../drawings/drawing#{drawing_id}.xml" ]
 

data/lib/write_xlsx/drawing.rb

@@ -4,6 +4,15 @@
 
 module Writexlsx
   class Drawing
+    attr_accessor :type, :dimensions, :width, :height, :name, :shape, :anchor
+
+    def initialize(type, dimensions, width, height, name, shape, anchor)
+      @type, @dimensions, @width, @height, @name, @shape, @anchor =
+        type, dimensions, width, height, name, shape, anchor
+    end
+  end
+
+  class Drawings
     include Writexlsx::Utility
 
     attr_writer :embedded, :orientation
@@ -32,10 +41,10 @@ def assemble_xml_file
         write_drawing_workspace do
           if @embedded
             index = 0
-            @drawings.each do |dimensions|
+            @drawings.each do |drawing|
               # Write the xdr:twoCellAnchor element.
               index += 1
-              write_two_cell_anchor(index, *(dimensions.flatten))
+              write_two_cell_anchor(index, drawing)
             end
           else
             # Write the xdr:absoluteAnchor element.
@@ -48,8 +57,8 @@ def assemble_xml_file
     #
     # Add a chart, image or shape sub object to the drawing.
     #
-    def add_drawing_object(*args)
-      @drawings << args.flatten
+    def add_drawing_object(drawing)
+      @drawings << drawing
     end
 
     private
@@ -71,14 +80,25 @@ def write_drawing_workspace
     # Write the <xdr:twoCellAnchor> element.
     #
     def write_two_cell_anchor(*args)
-      index, type, col_from, row_from, col_from_offset, row_from_offset,
-      col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute,
-      width, height, description, shape = args
+      index, drawing = args
+
+      type = drawing.type
+      width = drawing.width
+      height = drawing.height
+      description = drawing.name
+      shape = drawing.shape
+      anchor = drawing.anchor
+      col_from, row_from, col_from_offset, row_from_offset,
+      col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute = drawing.dimensions
 
       attributes      = []
 
       # Add attribute for images.
-      attributes << [:editAs, 'oneCell'] if type == 2
+      if anchor == 2
+        attributes << [:editAs, 'oneCell']
+      elsif anchor == 3
+        attributes << [:editAs, 'absolute']
+      end
 
       # Add attribute for shapes.
       attributes << [:editAs, shape.edit_as] if shape && shape.edit_as

data/lib/write_xlsx/format.rb

@@ -163,7 +163,7 @@ class Format
     include Writexlsx::Utility
 
     attr_reader :xf_index, :dxf_index, :num_format   # :nodoc:
-    attr_reader :underline, :font_script, :size, :theme, :font, :font_family, :hyperlink   # :nodoc:
+    attr_reader :underline, :font_script, :size, :theme, :font, :font_family, :hyperlink, :xf_id   # :nodoc:
     attr_reader :diag_type, :diag_color, :font_only, :color, :color_indexed   # :nodoc:
     attr_reader :left, :left_color, :right, :right_color, :top, :top_color, :bottom, :bottom_color   # :nodoc:
     attr_reader :font_scheme   # :nodoc:
@@ -180,7 +180,7 @@ def initialize(formats, params = {})   # :nodoc:
       @xf_index       = nil
       @dxf_index      = nil
 
-      @num_format     = 0
+      @num_format     = 'General'
       @num_format_index = 0
       @font_index     = 0
       @font           = 'Calibri'
@@ -200,6 +200,7 @@ def initialize(formats, params = {})   # :nodoc:
       @font_extend    = 0
       @theme          = 0
       @hyperlink      = 0
+      @xf_id          = 0
 
       @hidden         = 0
       @locked         = 1
@@ -396,7 +397,8 @@ def get_font_key
         @font,
         @italic,
         @size,
-        @underline
+        @underline,
+        @theme
       ].join(':')
     end
 
@@ -476,13 +478,13 @@ def self.color(color_code)
 
       colors = Colors::COLORS
 
+      # Return the default color if nil,
+      return 0x00 unless color_code
+
       if color_code.respond_to?(:to_str)
         # Return RGB style colors for processing later.
         return color_code if color_code =~ /^#[0-9A-F]{6}$/i
 
-        # Return the default color if undef,
-        return 0x00 unless color_code
-
         # or the color string converted to an integer,
         return colors[color_code.downcase.to_sym] if colors[color_code.downcase.to_sym]
 
@@ -593,15 +595,15 @@ def set_rotation(rotation)
     end
 
     #
-    # Set the properties for the hyperlink style. TODO. This doesn't currently
-    # work. Fix it when styles are supported.
+    # Set the properties for the hyperlink style. This isn't a public method. To
+    # be fixed when styles are supported.
     #
-    def set_hyperlink
-      @hyperlink = 1
+    def set_hyperlink(hyperlink)
+      @xf_id = 1
 
       set_underline(1)
       set_theme(10)
-      set_align('top')
+      @hyperlink = hyperlink
     end
 
     def set_font_info(fonts)
@@ -804,11 +806,11 @@ def xf_attributes
         ['fontId'  , font_index],
         ['fillId'  , fill_index],
         ['borderId', border_index],
-        ['xfId'    , 0]
+        ['xfId'    , xf_id]
       ]
       attributes << ['applyNumberFormat', 1] if num_format_index > 0
       # Add applyFont attribute if XF format uses a font element.
-      attributes << ['applyFont', 1] if font_index > 0
+      attributes << ['applyFont', 1] if font_index > 0 && !ptrue?(@hyperlink)
       # Add applyFill attribute if XF format uses a fill element.
       attributes << ['applyFill', 1] if fill_index > 0
       # Add applyBorder attribute if XF format uses a border element.
@@ -817,8 +819,10 @@ def xf_attributes
       # Check if XF format has alignment properties set.
       apply_align, align = get_align_properties
       # We can also have applyAlignment without a sub-element.
-      attributes << ['applyAlignment', 1] if apply_align
-      attributes << ['applyProtection', 1] if get_protection_properties
+      attributes << ['applyAlignment', 1] if apply_align || ptrue?(@hyperlink)
+      if get_protection_properties || ptrue?(hyperlink)
+        attributes << ['applyProtection', 1]
+      end
 
       attributes
     end