write_xlsx 0.97.0 → 1.04.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)
 

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/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 @@ class Line < self
 
       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 @@ def write_line_chart(params)
         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)}
 

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,31 @@ 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
@@ -107,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
 
@@ -129,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/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,16 @@
 
 module Writexlsx
   class Drawing
+    attr_accessor :type, :dimensions, :width, :height, :description, :shape, :anchor, :rel_index, :url_rel_index
+    attr_reader :tip
+
+    def initialize(type, dimensions, width, height, description, shape, anchor, rel_index = nil, url_rel_index = nil, tip = nil)
+      @type, @dimensions, @width, @height, @description, @shape, @anchor, @rel_index, @url_rel_index, @tip =
+        type, dimensions, width, height, description, shape, anchor, rel_index, url_rel_index, tip
+    end
+  end
+
+  class Drawings
     include Writexlsx::Utility
 
     attr_writer :embedded, :orientation
@@ -32,10 +42,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 +58,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 +81,29 @@ 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.description
+      shape         = drawing.shape
+      anchor        = drawing.anchor
+      rel_index     = drawing.rel_index
+      url_rel_index = drawing.url_rel_index
+      tip           = drawing.tip
+
+      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
@@ -93,10 +118,14 @@ def write_two_cell_anchor(*args)
           # Graphic frame.
 
           # Write the xdr:graphicFrame element for charts.
-          write_graphic_frame(index, description)
+          write_graphic_frame(index, rel_index, description)
         elsif type == 2
           # Write the xdr:pic element.
-          write_pic(index, col_absolute, row_absolute, width, height, description)
+          write_pic(
+            index,        rel_index,      col_absolute,
+            row_absolute, width,          height,
+            description,  url_rel_index , tip
+          )
         else
           # Write the xdr:sp element for shapes.
           write_sp(index, col_absolute, row_absolute, width, height, shape)
@@ -129,7 +158,7 @@ def write_absolute_anchor(index)
         end
 
         # Write the xdr:graphicFrame element.
-        write_graphic_frame(index)
+        write_graphic_frame(index, index)
 
         # Write the xdr:clientData element.
         write_client_data
@@ -203,9 +232,9 @@ def write_row_off(data)
     #
     def write_pos(x, y)
       attributes = [
-                    ['x', x],
-                    ['y', y]
-                   ]
+        ['x', x],
+        ['y', y]
+      ]
 
       @writer.empty_tag('xdr:pos', attributes)
     end
@@ -215,9 +244,9 @@ def write_pos(x, y)
     #
     def write_ext(cx, cy)
       attributes = [
-                    ['cx', cx],
-                    ['cy', cy]
-                   ]
+        ['cx', cx],
+        ['cy', cy]
+      ]
 
       @writer.empty_tag('xdr:ext', attributes)
     end
@@ -225,7 +254,7 @@ def write_ext(cx, cy)
     #
     # Write the <xdr:graphicFrame> element.
     #
-    def write_graphic_frame(index, name = nil)
+    def write_graphic_frame(index, rel_index, name = nil)
       macro  = ''
 
       attributes = [ ['macro', macro] ]
@@ -236,7 +265,7 @@ def write_graphic_frame(index, name = nil)
         # Write the xdr:xfrm element.
         write_xfrm
         # Write the a:graphic element.
-        write_atag_graphic(index)
+        write_atag_graphic(rel_index)
       end
     end
 
@@ -257,18 +286,42 @@ def write_nv_graphic_frame_pr(index, name = nil)
     #
     # Write the <xdr:cNvPr> element.
     #
-    def write_c_nv_pr(id, name, descr = nil)
+    def write_c_nv_pr(index, name, description = nil, url_rel_index = nil, tip = nil)
       attributes = [
-          ['id',   id],
-          ['name', name]
+        ['id',   index],
+        ['name', name]
       ]
 
       # Add description attribute for images.
-      attributes << ['descr', descr] if descr
+      attributes << ['descr', description] if description
 
-      @writer.empty_tag('xdr:cNvPr', attributes)
+      if ptrue?(url_rel_index)
+        @writer.tag_elements('xdr:cNvPr', attributes) do
+          # Write the a:hlinkClick element.
+          write_a_hlink_click(url_rel_index, tip)
+        end
+      else
+        @writer.empty_tag('xdr:cNvPr', attributes)
+      end
     end
 
+    #
+    # Write the <a:hlinkClick> element.
+    #
+    def write_a_hlink_click(index, tip)
+      schema  = 'http://schemas.openxmlformats.org/officeDocument/'
+      xmlns_r = "#{schema}2006/relationships"
+      r_id    = "rId#{index}"
+
+      attributes = [
+        ['xmlns:r', xmlns_r],
+        ['r:id', r_id]
+      ]
+
+      attributes << ['tooltip', tip] if tip
+
+      @writer.empty_tag('a:hlinkClick', attributes)
+    end
 
     #
     # Write the <xdr:cNvGraphicFramePr> element.
@@ -351,7 +404,7 @@ def write_atag_graphic(index)
     # Write the <a:graphicData> element.
     #
     def write_atag_graphic_data(index)
-      uri   = 'http://schemas.openxmlformats.org/drawingml/2006/chart'
+      uri = 'http://schemas.openxmlformats.org/drawingml/2006/chart'
 
       attributes = [ ['uri', uri] ]
 
@@ -474,12 +527,12 @@ def write_nv_sp_pr(index, shape)
     #
     # Write the <xdr:pic> element.
     #
-    def write_pic(index, col_absolute, row_absolute, width, height, description)
+    def write_pic(index, rel_index, col_absolute, row_absolute, width, height, description, url_rel_index, tip)
       @writer.tag_elements('xdr:pic') do
         # Write the xdr:nvPicPr element.
-        write_nv_pic_pr(index, description)
+        write_nv_pic_pr(index, rel_index, description, url_rel_index, tip)
         # Write the xdr:blipFill element.
-        write_blip_fill(index)
+        write_blip_fill(rel_index)
 
         # Pictures are rectangle shapes by default.
         shape = Shape.new
@@ -493,10 +546,13 @@ def write_pic(index, col_absolute, row_absolute, width, height, description)
     #
     # Write the <xdr:nvPicPr> element.
     #
-    def write_nv_pic_pr(index, description)
+    def write_nv_pic_pr(index, rel_index, description, url_rel_index, tip)
       @writer.tag_elements('xdr:nvPicPr') do
         # Write the xdr:cNvPr element.
-        write_c_nv_pr( index + 1, "Picture #{index}", description )
+        write_c_nv_pr(
+          index + 1, "Picture #{index}", description,
+          url_rel_index, tip
+        )
         # Write the xdr:cNvPicPr element.
         write_c_nv_pic_pr
       end