write_xlsx 0.62.0 → 0.64.0

data/lib/write_xlsx/chart/area.rb

@@ -28,7 +28,7 @@ def initialize(subtype)
 
         # Override and reset the default axis values.
         if @subtype == 'percent_stacked'
-          @y_axis[:_defaults][:num_format] = '0%'
+          @y_axis.defaults[:num_format] = '0%'
         end
 
         set_y_axis
@@ -60,6 +60,9 @@ def write_area_chart(params)
           # Write the series elements.
           series.each {|s| write_series(s)}
 
+          # Write the c:dropLines element.
+          write_drop_lines
+
           # Write the c:marker element.
           write_marker_value
 

data/lib/write_xlsx/chart/axis.rb

@@ -0,0 +1,132 @@
+# -*- encoding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  class Chart
+    class Axis
+      include Writexlsx::Utility
+
+      attr_accessor :defaults, :name, :formula, :data_id, :reverse
+      attr_accessor :min, :max
+      attr_accessor :minor_unit, :major_unit, :minor_unit_type, :major_unit_type
+      attr_accessor :log_base, :crossing, :position, :label_position, :visible
+      attr_accessor :num_format, :num_format_linked, :num_font, :name_font
+      attr_accessor :major_gridlines, :minor_gridlines, :major_tick_mark
+
+      #
+      # Convert user defined axis values into axis instance.
+      #
+      def merge_with_hash(chart, params) # :nodoc:
+        @chart    = chart
+        args      = (defaults || {}).merge(params)
+
+        @name, @formula = @chart.process_names(args[:name], args[:name_formula])
+        @data_id           = @chart.get_data_id(@formula, args[:data])
+        @reverse           = args[:reverse]
+        @min               = args[:min]
+        @max               = args[:max]
+        @minor_unit        = args[:minor_unit]
+        @major_unit        = args[:major_unit]
+        @minor_unit_type   = args[:minor_unit_type]
+        @major_unit_type   = args[:major_unit_type]
+        @log_base          = args[:log_base]
+        @crossing          = args[:crossing]
+        @label_position    = args[:label_position]
+        @num_format        = args[:num_format]
+        @num_format_linked = args[:num_format_linked]
+        @visible           = args[:visible] || 1
+
+        # Map major/minor_gridlines properties.
+        [:major_gridlines, :minor_gridlines].each do |lines|
+          if args[lines] && ptrue?(args[lines][:visible])
+            instance_variable_set("@#{lines}", gridline_properties(args[lines]))
+          else
+            instance_variable_set("@#{lines}", nil)
+          end
+        end
+        @major_tick_mark   = args[:major_tick_mark]
+
+        # Only use the first letter of bottom, top, left or right.
+        @position = args[:position]
+        @position = @position.downcase[0, 1] if @position
+
+        # Set the font properties if present.
+        @num_font  = @chart.convert_font_args(args[:num_font])
+        @name_font = @chart.convert_font_args(args[:name_font])
+      end
+
+      #
+      # Write the <c:numberFormat> element. Note: It is assumed that if a user
+      # defined number format is supplied (i.e., non-default) then the sourceLinked
+      # attribute is 0. The user can override this if required.
+      #
+
+      def write_number_format(writer) # :nodoc:
+        source_linked = 1
+
+        # Check if a user defined number format has been set.
+        if @defaults && @num_format != @defaults[:num_format]
+          source_linked = 0
+        end
+
+        # User override of sourceLinked.
+        if ptrue?(@num_format_linked)
+          source_linked = 1
+        end
+
+        attributes = [
+                      'formatCode',   @num_format,
+                      'sourceLinked', source_linked
+                     ]
+
+        writer.empty_tag('c:numFmt', attributes)
+      end
+
+      #
+      # Write the <c:numFmt> element. Special case handler for category axes which
+      # don't always have a number format.
+      #
+      def write_cat_number_format(writer, cat_has_num_fmt)
+        source_linked  = 1
+        default_format = true
+
+        # Check if a user defined number format has been set.
+        if @defaults && @num_format != @defaults[:num_format]
+          source_linked  = 0
+          default_format = false
+        end
+
+        # User override of linkedSource.
+        if @num_format_linked
+          source_linked = 1
+        end
+
+        # Skip if cat doesn't have a num format (unless it is non-default).
+        if !cat_has_num_fmt && default_format
+          return ''
+        end
+
+        attributes = [
+                      'formatCode',   @num_format,
+                      'sourceLinked', source_linked,
+                     ]
+
+        writer.empty_tag('c:numFmt', attributes)
+      end
+
+      #
+      # Convert user defined gridline properties to the structure required internally.
+      #
+      def gridline_properties(args)
+        # Set the visible property for the gridline.
+        gridline = { :_visible => args[:visible] }
+
+        # Set the line properties for the gridline.
+        gridline[:_line] = @chart.line_properties(args[:line])
+
+        gridline
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/bar.rb

@@ -29,19 +29,19 @@ def initialize(subtype)
         @show_crosses      = false
 
         # Override and reset the default axis values.
-        if @x_axis[:_defaults]
-          @x_axis[:_defaults][:major_gridlines] = { :visible => 1 }
+        if @x_axis.defaults
+          @x_axis.defaults[:major_gridlines] = { :visible => 1 }
         else
-          @x_axis[:_defaults] = { :major_gridlines => { :visible => 1 } }
+          @x_axis.defaults = { :major_gridlines => { :visible => 1 } }
         end
-        if @y_axis[:_defaults]
-          @y_axis[:_defaults][:major_gridlines] = { :visible => 0 }
+        if @y_axis.defaults
+          @y_axis.defaults[:major_gridlines] = { :visible => 0 }
         else
-          @y_axis[:_defaults] = { :major_gridlines => { :visible => 0 } }
+          @y_axis.defaults = { :major_gridlines => { :visible => 0 } }
         end
 
         if @subtype == 'percent_stacked'
-            @x_axis[:_defaults][:num_format] = '0%'
+            @x_axis.defaults[:num_format] = '0%'
         end
 
         set_x_axis
@@ -55,8 +55,8 @@ def write_chart_type(params)
         if params[:primary_axes] != 0
           # Reverse X and Y axes for Bar charts.
           @y_axis, @x_axis = @x_axis, @y_axis
-          if @y2_axis[:_position] == 'r'
-            @y2_axis[:_position] = 't'
+          if @y2_axis.position == 'r'
+            @y2_axis.position = 't'
           end
         end
 
@@ -74,6 +74,14 @@ def write_bar_dir
 
         @writer.empty_tag('c:barDir', attributes)
       end
+
+      #
+      # Write the <c:errDir> element. Overridden from Chart class since it is not
+      # used in Bar charts.
+      #
+      def write_err_dir(direction)
+        # do nothing
+      end
     end
   end
 end

data/lib/write_xlsx/chart/column.rb

@@ -35,7 +35,7 @@ def initialize(subtype)
 
         # Override and reset the default axis values.
         if @subtype == 'percent_stacked'
-          @y_axis[:_defaults][:num_format] = '0%'
+          @y_axis.defaults[:num_format] = '0%'
         end
 
         set_y_axis
@@ -59,6 +59,14 @@ def write_bar_dir
 
         @writer.empty_tag('c:barDir', attributes)
       end
+
+      #
+      # Write the <c:errDir> element. Overridden from Chart class since it is not
+      # used in Bar charts.
+      #
+      def write_err_dir(direction)
+        # do nothing
+      end
     end
   end
 end

data/lib/write_xlsx/chart/line.rb

@@ -45,6 +45,15 @@ def write_line_chart(params)
           # Write the series elements.
           series.each {|s| write_series(s)}
 
+          # Write the c:dropLines element.
+          write_drop_lines
+
+          # Write the c:hiLowLines element.
+          write_hi_low_lines
+
+          # Write the c:upDownBars element.
+          write_up_down_bars
+
           # Write the c:marker element.
           write_marker_value
 
@@ -52,6 +61,21 @@ def write_line_chart(params)
           write_axis_ids(params)
         end
       end
+
+      #
+      # Write an individual <c:dPt> element. Override the parent method to add
+      # markers.
+      #
+      def write_d_pt_point(index, point)
+        @writer.tag_elements('c:dPt') do
+          # Write the c:idx element.
+          write_idx(index)
+          @writer.tag_elements('c:marker') do
+            # Write the c:spPr element.
+            write_sp_pr(point)
+          end
+        end
+      end
     end
   end
 end

data/lib/write_xlsx/chart/radar.rb

@@ -36,11 +36,11 @@ def initialize(subtype)
         end
 
         # Override and reset the default axis values.
-        @x_axis[:_defaults][:major_gridlines] = { :visible => 1 }
+        @x_axis.defaults[:major_gridlines] = { :visible => 1 }
         set_x_axis
 
         # Hardcode major_tick_mark for now untill there is an accessor.
-        @y_axis[:_major_tick_mark] = 'cross'
+        @y_axis.major_tick_mark = 'cross'
       end
 
       #

data/lib/write_xlsx/chart/scatter.rb

@@ -110,10 +110,14 @@ def write_ser(series)
           write_sp_pr(series)
           # Write the c:marker element.
           write_marker(series[:_marker])
+          # 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 the c:xVal element.
           write_x_val(series)
           # Write the c:yVal element.
@@ -266,6 +270,21 @@ def modify_series_formatting
           end
         end
       end
+
+      #
+      # Write an individual <c:dPt> element. Override the parent method to add
+      # markers.
+      #
+      def write_d_pt_point(index, point)
+        @writer.tag_elements('c:dPt') do
+          # Write the c:idx element.
+          write_idx(index)
+          @writer.tag_elements('c:marker') do
+            # Write the c:spPr element.
+            write_sp_pr(point)
+          end
+        end
+      end
     end
   end
 end

data/lib/write_xlsx/chart/stock.rb

@@ -27,10 +27,11 @@ class Stock < self
       def initialize(subtype)
         super(subtype)
         @show_crosses = false
+        @hi_low_lines = {}
 
         # Override and reset the default axis values.
-        @x_axis[:_defaults][:num_format] = 'dd/mm/yyyy'
-        @x2_axis[:_defaults][:num_format] = 'dd/mm/yyyy'
+        @x_axis.defaults[:num_format] = 'dd/mm/yyyy'
+        @x2_axis.defaults[:num_format] = 'dd/mm/yyyy'
         set_x_axis
         set_x2_axis
       end
@@ -62,8 +63,14 @@ def write_stock_chart(params)
           # Write the series elements.
           series.each {|s| write_series(s)}
 
+          # Write the c:dtopLines element.
+          write_drop_lines
+
           # Write the c:hiLowLines element.
-          write_hi_low_lines if params[:primary_axes] == 1
+          write_hi_low_lines if ptrue?(params[:primary_axes])
+
+          # Write the c:upDownBars element.
+          write_up_down_bars
 
           # Write the c:marker element.
           write_marker_value

data/lib/write_xlsx/drawing.rb

@@ -89,7 +89,7 @@ def write_two_cell_anchor(*args)
       attributes << :editAs << 'oneCell' if type == 2
 
       # Add attribute for shapes.
-      attributes << :editAs << shape[:edit_as] if shape && !shape[:edit_as].nil?
+      attributes << :editAs << shape.edit_as if shape && !shape.edit_as.nil?
 
       @writer.tag_elements('xdr:twoCellAnchor', attributes) do
         # Write the xdr:from element.
@@ -400,7 +400,7 @@ def write_client_data
     # Write the <xdr:sp> element.
     #
     def write_sp(index, col_absolute, row_absolute, width, height, shape)
-      if shape[:connect] != 0
+      if shape.connect != 0
         attributes = [:macro,  '']
         @writer.tag_elements('xdr:cxnSp', attributes) do
 
@@ -422,7 +422,7 @@ def write_sp(index, col_absolute, row_absolute, width, height, shape)
           write_xdr_sp_pr(index, col_absolute, row_absolute, width, height, shape)
 
           # Write the xdr:txBody element.
-          if shape[:text] != 0
+          if shape.text != 0
             write_txBody(col_absolute, row_absolute, width, height, shape)
           end
         end
@@ -435,21 +435,21 @@ def write_sp(index, col_absolute, row_absolute, width, height, shape)
     def write_nv_cxn_sp_pr(index, shape)
       @writer.tag_elements('xdr:nvCxnSpPr') do
 
-        shape[:name] = [shape[:type], index].join(' ') unless shape[:name]
-        write_c_nv_pr(shape[:id], shape[:name])
+        shape.name = [shape.type, index].join(' ') unless shape.name
+        write_c_nv_pr(shape.id, shape.name)
 
         @writer.tag_elements('xdr:cNvCxnSpPr') do
 
           attributes = [:noChangeShapeType, '1']
           @writer.empty_tag('a:cxnSpLocks', attributes)
 
-          if shape[:start]
-            attributes = ['id', shape[:start], 'idx', shape[:start_index]]
+          if shape.start
+            attributes = ['id', shape.start, 'idx', shape.start_index]
             @writer.empty_tag('a:stCxn', attributes)
           end
 
-          if shape[:end]
-            attributes = ['id', shape[:end], 'idx', shape[:end_index]]
+          if shape.end
+            attributes = ['id', shape.end, 'idx', shape.end_index]
             @writer.empty_tag('a:endCxn', attributes)
           end
         end
@@ -461,14 +461,13 @@ def write_nv_cxn_sp_pr(index, shape)
     #
     def write_nv_sp_pr(index, shape)
       attributes = []
+      attributes << 'txBox' << 1 if shape.tx_box
 
       @writer.tag_elements('xdr:nvSpPr') do
-        shape_name = "#{shape[:type]} #{index}"
-        write_c_nv_pr(shape[:id], shape_name)
-        attributes = ['txBox', 1] if shape[:tx_box] != 0
+        write_c_nv_pr(shape.id, "#{shape.type} #{index}")
+
         @writer.tag_elements('xdr:cNvSpPr', attributes) do
-          attributes = [:noChangeArrowheads, '1']
-          @writer.empty_tag('a:spLocks', attributes)
+          @writer.empty_tag('a:spLocks', [:noChangeArrowheads, '1'])
         end
       end
     end
@@ -485,7 +484,7 @@ def write_pic(index, col_absolute, row_absolute, width, height, description)
 
         # Pictures are rectangle shapes by default.
         shape = Shape.new
-        shape[:type] = 'rect'
+        shape.type = 'rect'
 
         # Write the xdr:spPr element.
         write_sp_pr(col_absolute, row_absolute, width, height, shape)
@@ -596,9 +595,9 @@ def write_xdr_sp_pr(index, col_absolute, row_absolute, width, height, shape)
         # Write the a:prstGeom element.
         write_a_prst_geom(shape)
 
-        if shape[:fill].to_s.bytesize > 1
+        if shape.fill.to_s.bytesize > 1
           # Write the a:solidFill element.
-          write_a_solid_fill(shape[:fill])
+          write_a_solid_fill(shape.fill)
         else
           @writer.empty_tag('a:noFill')
         end
@@ -611,15 +610,15 @@ def write_xdr_sp_pr(index, col_absolute, row_absolute, width, height, shape)
     #
     # Write the <a:xfrm> element.
     #
-    def write_a_xfrm(col_absolute, row_absolute, width, height, shape = {})
+    def write_a_xfrm(col_absolute, row_absolute, width, height, shape = nil)
       attributes = []
 
-      rotation = shape[:rotation] || 0
+      rotation = shape ? shape.rotation : 0
       rotation *= 60000
 
       attributes << 'rot' << rotation if rotation != 0
-      attributes << 'flipH' << 1      if ptrue?(shape[:flip_h])
-      attributes << 'flipV' << 1      if ptrue?(shape[:flip_v])
+      attributes << 'flipH' << 1      if shape && ptrue?(shape.flip_h)
+      attributes << 'flipV' << 1      if shape && ptrue?(shape.flip_v)
 
       @writer.tag_elements('a:xfrm', attributes) do
         # Write the a:off element.
@@ -659,7 +658,7 @@ def write_a_ext(cx, cy)
     #
     def write_a_prst_geom(shape = {})
       attributes = []
-      attributes << 'prst' << shape[:type] if shape[:type]
+      attributes << 'prst' << shape.type if shape.type
 
       @writer.tag_elements('a:prstGeom', attributes) do
         # Write the a:avLst element.
@@ -671,11 +670,11 @@ def write_a_prst_geom(shape = {})
     # Write the <a:avLst> element.
     #
     def write_a_av_lst(shape = {})
-      if shape[:adjustments].respond_to?(:empty?)
-        adjustments = shape[:adjustments]
-      elsif shape[:adjustments].respond_to?(:coerce)
-        adjustments = [shape[:adjustments]]
-      elsif !shape[:adjustments]
+      if shape.adjustments.respond_to?(:empty?)
+        adjustments = shape.adjustments
+      elsif shape.adjustments.respond_to?(:coerce)
+        adjustments = [shape.adjustments]
+      elsif !shape.adjustments
         adjustments = []
       end
 
@@ -685,7 +684,7 @@ def write_a_av_lst(shape = {})
           adjustments.each do |adj|
             i += 1
             # Only connectors have multiple adjustments.
-            suffix = shape[:connect] != 0 ? i : ''
+            suffix = shape.connect != 0 ? i : ''
 
             # Scale Adjustments: 100,000 = 100%.
             adj_int = (adj * 1000).to_i
@@ -714,10 +713,10 @@ def write_a_solid_fill(rgb = '000000')
     # Write the <a:ln> elements.
     #
     def write_a_ln(shape = {})
-      weight = shape[:line_weight] || 0
+      weight = shape.line_weight || 0
       attributes = ['w', weight * 9525]
       @writer.tag_elements('a:ln', attributes) do
-        line = shape[:line] || 0
+        line = shape.line || 0
         if line.to_s.bytesize > 1
           # Write the a:solidFill element.
           write_a_solid_fill(line)
@@ -725,12 +724,12 @@ def write_a_ln(shape = {})
           @writer.empty_tag('a:noFill')
         end
 
-        if shape[:line_type] != ''
-          attributes = ['val', shape[:line_type]]
+        if shape.line_type != ''
+          attributes = ['val', shape.line_type]
           @writer.empty_tag('a:prstDash', attributes)
         end
 
-        if shape[:connect] != 0
+        if shape.connect != 0
           @writer.empty_tag('a:round')
         else
           attributes = ['lim', 800000]
@@ -753,7 +752,7 @@ def write_txBody(col_absolute, row_absolute, width, height, shape)
                     :tIns,         "22860",
                     :rIns,         "27432",
                     :bIns,         "22860",
-                    :anchor,       shape[:valign],
+                    :anchor,       shape.valign,
                     :upright,      "1"
                    ]
       @writer.tag_elements('xdr:txBody') do
@@ -761,23 +760,23 @@ def write_txBody(col_absolute, row_absolute, width, height, shape)
         @writer.empty_tag('a:lstStyle')
 
         @writer.tag_elements('a:p') do
-          rotation = shape[:format][:rotation] || 0
+          rotation = shape.format[:rotation] || 0
           rotation *= 60000
 
-          attributes = [:algn, shape[:align], :rtl, rotation]
+          attributes = [:algn, shape.align, :rtl, rotation]
           @writer.tag_elements('a:pPr', attributes) do
             attributes = [:sz, "1000"]
             @writer.empty_tag('a:defRPr', attributes)
           end
 
           @writer.tag_elements('a:r') do
-            size = shape[:format][:size] || 8
+            size = shape.format[:size] || 8
             size *= 100
 
-            bold      = shape[:format][:bold]      || 0
-            italic    = shape[:format][:italic]    || 0
-            underline = ptrue?(shape[:format][:underline]) ? 'sng' : 'none'
-            strike    = ptrue?(shape[:format][:font_strikeout]) ? 'Strike' : 'noStrike'
+            bold      = shape.format[:bold]      || 0
+            italic    = shape.format[:italic]    || 0
+            underline = ptrue?(shape.format[:underline]) ? 'sng' : 'none'
+            strike    = ptrue?(shape.format[:font_strikeout]) ? 'Strike' : 'noStrike'
 
             attributes = [
                           :lang,     "en-US",
@@ -789,7 +788,7 @@ def write_txBody(col_absolute, row_absolute, width, height, shape)
                           :baseline, 0
                          ]
             @writer.tag_elements('a:rPr', attributes) do
-              color = shape[:format][:color]
+              color = shape.format[:color]
               if color
                 color = shape.get_palette_color(color)
                 color = color.sub(/^FF/, '')  # Remove leading FF from rgb for shape color.
@@ -799,13 +798,13 @@ def write_txBody(col_absolute, row_absolute, width, height, shape)
 
               write_a_solid_fill(color)
 
-              font = shape[:format][:font] || 'Calibri'
+              font = shape.format[:font] || 'Calibri'
               attributes = [:typeface, font]
               @writer.empty_tag('a:latin', attributes)
               @writer.empty_tag('a:cs', attributes)
             end
             @writer.tag_elements('a:t') do
-              @writer.characters(shape[:text])
+              @writer.characters(shape.text)
             end
           end
         end