write_xlsx 0.70.0 → 0.71.0

data/lib/write_xlsx/chart/axis.rb

@@ -1,28 +1,27 @@
 # -*- encoding: utf-8 -*-
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
+require 'write_xlsx/chart/caption'
 
 module Writexlsx
   class Chart
-    class Axis
+    class Axis < Caption
       include Writexlsx::Utility
 
-      attr_accessor :defaults, :name, :formula, :data_id, :reverse
+      attr_accessor :defaults, :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 :num_format, :num_format_linked, :num_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
+      def merge_with_hash(params) # :nodoc:
+        super
         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]
@@ -53,7 +52,6 @@ def merge_with_hash(chart, params) # :nodoc:
 
         # 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
 
       #

data/lib/write_xlsx/chart/caption.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+module Writexlsx
+  class Chart
+    class Caption
+      attr_accessor :name, :formula, :data_id, :name_font
+
+      def initialize(chart)
+        @chart = chart
+      end
+
+      def merge_with_hash(params) # :nodoc:
+        @name, @formula = @chart.process_names(params[:name], params[:name_formula])
+        @data_id        = @chart.get_data_id(@formula, params[:data])
+        @name_font      = @chart.convert_font_args(params[:name_font])
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/scatter.rb

@@ -110,24 +110,24 @@ def write_ser(series)
           # Write the c:spPr element.
           write_sp_pr(series)
           # Write the c:marker element.
-          write_marker(series[:_marker])
+          write_marker(series.marker)
           # Write the c:dPt element.
-          write_d_pt(series[:_points])
+          write_d_pt(series.points)
           # Write the c:dLbls element.
-          write_d_lbls(series[:_labels])
+          write_d_lbls(series.labels)
           # Write the c:trendline element.
-          write_trendline(series[:_trendline])
+          write_trendline(series.trendline)
           # Write the c:errBars element.
-          write_error_bars(series[:_error_bars])
+          write_error_bars(series.error_bars)
           # Write the c:xVal element.
           write_x_val(series)
           # Write the c:yVal element.
           write_y_val(series)
           # Write the c:smooth element.
-          if @subtype =~ /smooth/ && !series[:_smooth]
+          if @subtype =~ /smooth/ && !series.smooth
             write_c_smooth(1)
           else
-            write_c_smooth(series[:_smooth])
+            write_c_smooth(series.smooth)
           end
         end
       end
@@ -188,8 +188,8 @@ def write_plot_area
       # Write the <c:xVal> element.
       #
       def write_x_val(series)
-        formula = series[:_categories]
-        data_id = series[:_cat_data_id]
+        formula = series.categories
+        data_id = series.cat_data_id
         data    = @formula_data[data_id]
 
         @writer.tag_elements('c:xVal') do
@@ -211,8 +211,8 @@ def write_x_val(series)
       # Write the <c:yVal> element.
       #
       def write_y_val(series)
-        formula = series[:_values]
-        data_id = series[:_val_data_id]
+        formula = series.values
+        data_id = series.val_data_id
         data    = @formula_data[data_id]
 
         @writer.tag_elements('c:yVal') do
@@ -244,8 +244,8 @@ def modify_series_formatting
           # Go through each series and define default values.
           @series.each do |series|
             # Set a line type unless there is already a user defined type.
-            if series[:_line][:_defined] == 0
-              series[:_line] = { :width => 2.25, :none => 1, :_defined => 1 }
+            if series.line[:_defined] == 0
+              series.line = { :width => 2.25, :none => 1, :_defined => 1 }
             end
           end
         end
@@ -255,8 +255,8 @@ def modify_series_formatting
           # Go through each series and define default values.
           @series.each do |series|
             # Set a marker type unless there is already a user defined type.
-            if !series[:_marker] || series[:_marker][:_defined] == 0
-              series[:_marker] = { :type => 'none', :_defined => 1 }
+            if !series.marker || series.marker[:_defined] == 0
+              series.marker = { :type => 'none', :_defined => 1 }
             end
           end
         end

data/lib/write_xlsx/chart/series.rb

@@ -0,0 +1,307 @@
+# -*- coding: utf-8 -*-
+
+class Series
+  include Writexlsx::Utility
+
+  attr_reader :values, :categories, :name, :name_formula, :name_id
+  attr_reader :cat_data_id, :val_data_id, :fill
+  attr_reader :trendline, :smooth, :labels, :invert_if_neg
+  attr_reader :x2_axis, :y2_axis, :error_bars, :points
+  attr_accessor :line, :marker
+
+  def initialize(chart, params = {})
+    @values = aref_to_formula(params[:values])
+    @categories = aref_to_formula(params[:categories])
+    @name, @name_formula =
+      chart.process_names(params[:name], params[:name_formula])
+    @cat_data_id = chart.get_data_id(@categories, params[:categories_data])
+    @val_data_id = chart.get_data_id(@values, params[:values_data])
+    @name_id = chart.get_data_id(@name_formula, params[:name_data])
+    if params[:border]
+      @line = line_properties(params[:border])
+    else
+      @line = line_properties(params[:line])
+    end
+    @fill = fill_properties(params[:fill])
+    @marker = marker_properties(params[:marker])
+    @trendline = trendline_properties(params[:trendline])
+    @smooth = params[:smooth]
+    @error_bars = {
+      :_x_error_bars => error_bars_properties(params[:x_error_bars]),
+      :_y_error_bars => error_bars_properties(params[:y_error_bars])
+    }
+    @points = points_properties(params[:points])
+    @labels = labels_properties(params[:data_labels])
+    @invert_if_neg = params[:invert_if_negative]
+    @x2_axis = params[:x2_axis]
+    @y2_axis = params[:y2_axis]
+  end
+
+  def ==(other)
+    methods = %w[categories values name name_formula name_id
+                 cat_data_id val_data_id
+                 line fill marker trendline
+                 smooth labels invert_if_neg x2_axis y2_axis error_bars points ]
+    methods.each do |method|
+      return false unless self.instance_variable_get("@#{method}") == other.instance_variable_get("@#{method}")
+    end
+    true
+  end
+
+  private
+
+  #
+  # Convert and aref of row col values to a range formula.
+  #
+  def aref_to_formula(data) # :nodoc:
+    # If it isn't an array ref it is probably a formula already.
+    return data unless data.kind_of?(Array)
+    xl_range_formula(*data)
+  end
+
+  #
+  # Convert user defined line properties to the structure required internally.
+  #
+  def line_properties(line) # :nodoc:
+    return { :_defined => 0 } unless line
+
+    dash_types = {
+      :solid               => 'solid',
+      :round_dot           => 'sysDot',
+      :square_dot          => 'sysDash',
+      :dash                => 'dash',
+      :dash_dot            => 'dashDot',
+      :long_dash           => 'lgDash',
+      :long_dash_dot       => 'lgDashDot',
+      :long_dash_dot_dot   => 'lgDashDotDot',
+      :dot                 => 'dot',
+      :system_dash_dot     => 'sysDashDot',
+      :system_dash_dot_dot => 'sysDashDotDot'
+    }
+
+    # Check the dash type.
+    dash_type = line[:dash_type]
+
+    if dash_type
+      line[:dash_type] = value_or_raise(dash_types, dash_type, 'dash type')
+    end
+
+    line[:_defined] = 1
+
+    line
+  end
+
+  #
+  # Convert user defined fill properties to the structure required internally.
+  #
+  def fill_properties(fill) # :nodoc:
+    return { :_defined => 0 } unless fill
+
+    fill[:_defined] = 1
+
+    fill
+  end
+
+  #
+  # Convert user defined marker properties to the structure required internally.
+  #
+  def marker_properties(marker) # :nodoc:
+    return unless marker
+
+    types = {
+      :automatic  => 'automatic',
+      :none       => 'none',
+      :square     => 'square',
+      :diamond    => 'diamond',
+      :triangle   => 'triangle',
+      :x          => 'x',
+      :star       => 'start',
+      :dot        => 'dot',
+      :short_dash => 'dot',
+      :dash       => 'dash',
+      :long_dash  => 'dash',
+      :circle     => 'circle',
+      :plus       => 'plus',
+      :picture    => 'picture'
+    }
+
+    # Check for valid types.
+    marker_type = marker[:type]
+
+    if marker_type
+      marker[:automatic] = 1 if marker_type == 'automatic'
+      marker[:type] = value_or_raise(types, marker_type, 'maker type')
+    end
+
+    # Set the line properties for the marker..
+    line = line_properties(marker[:line])
+
+    # Allow 'border' as a synonym for 'line'.
+    line = line_properties(marker[:border]) if marker[:border]
+
+    # Set the fill properties for the marker.
+    fill = fill_properties(marker[:fill])
+
+    marker[:_line] = line
+    marker[:_fill] = fill
+
+    marker
+  end
+
+  #
+  # Convert user defined trendline properties to the structure required internally.
+  #
+  def trendline_properties(trendline) # :nodoc:
+    return unless trendline
+
+    types = {
+      :exponential    => 'exp',
+      :linear         => 'linear',
+      :log            => 'log',
+      :moving_average => 'movingAvg',
+      :polynomial     => 'poly',
+      :power          => 'power'
+    }
+
+    # Check the trendline type.
+    trend_type = trendline[:type]
+
+    trendline[:type] = value_or_raise(types, trend_type, 'trendline type')
+
+    # Set the line properties for the trendline..
+    line = line_properties(trendline[:line])
+
+    # Allow 'border' as a synonym for 'line'.
+    line = line_properties(trendline[:border]) if trendline[:border]
+
+    # Set the fill properties for the trendline.
+    fill = fill_properties(trendline[:fill])
+
+    trendline[:_line] = line
+    trendline[:_fill] = fill
+
+    return trendline
+  end
+
+  #
+  # Convert user defined error bars properties to structure required
+  # internally.
+  #
+  def error_bars_properties(params = {})
+    return if !ptrue?(params) || params.empty?
+
+    # Default values.
+    error_bars = {
+      :_type      => 'fixedVal',
+      :_value     => 1,
+      :_endcap    => 1,
+      :_direction => 'both'
+    }
+
+    types = {
+      :fixed              => 'fixedVal',
+      :percentage         => 'percentage',
+      :standard_deviation => 'stdDev',
+      :standard_error     => 'stdErr'
+    }
+
+    # Check the error bars type.
+    error_type = params[:type].to_sym
+
+    if types.key?(error_type)
+      error_bars[:_type] = types[error_type]
+    else
+      raise "Unknown error bars type '#{error_type}'\n"
+    end
+
+    # Set the value for error types that require it.
+    if params.key?(:value)
+      error_bars[:_value] = params[:value]
+    end
+
+    # Set the end-cap style.
+    if params.key?(:end_style)
+      error_bars[:_endcap] = params[:end_style]
+    end
+
+    # Set the error bar direction.
+    if params.key?(:direction)
+      if params[:direction] == 'minus'
+        error_bars[:_direction] = 'minus'
+      elsif params[:direction] == 'plus'
+        error_bars[:_direction] = 'plus'
+      else
+        # Default to 'both'
+      end
+    end
+
+    # Set the line properties for the error bars.
+    error_bars[:_line] = line_properties(params[:line])
+
+    error_bars
+  end
+
+  #
+  # Convert user defined points properties to structure required internally.
+  #
+  def points_properties(user_points = nil)
+    return unless user_points
+
+    points = []
+    user_points.each do |user_point|
+      if user_point
+        # Set the lline properties for the point.
+        line = line_properties(user_point[:line])
+
+        # Allow 'border' as a synonym for 'line'.
+        if user_point[:border]
+          line = line_properties(user_point[:border])
+        end
+
+        # Set the fill properties for the chartarea.
+        fill = fill_properties(user_point[:fill])
+
+        point = {}
+        point[:_line] = line
+        point[:_fill] = fill
+      end
+      points << point
+    end
+    points
+  end
+
+  #
+  # Convert user defined labels properties to the structure required internally.
+  #
+  def labels_properties(labels) # :nodoc:
+    return nil unless labels
+
+    position = labels[:position]
+    if position.nil? || position.empty?
+      labels.delete(:position)
+    else
+      # Map user defined label positions to Excel positions.
+      positions = {
+        :center      => 'ctr',
+        :right       => 'r',
+        :left        => 'l',
+        :top         => 't',
+        :above       => 't',
+        :bottom      => 'b',
+        :below       => 'b',
+        :inside_end  => 'inEnd',
+        :outside_end => 'outEnd',
+        :best_fit    => 'bestFit'
+      }
+
+      labels[:position] = value_or_raise(positions, position, 'label position')
+    end
+
+    labels
+  end
+
+  def value_or_raise(hash, key, msg)
+    raise "Unknown #{msg} '#{key}'" unless hash[key.to_sym]
+    hash[key.to_sym]
+  end
+end

data/lib/write_xlsx/chart/stock.rb

@@ -95,19 +95,19 @@ def modify_series_formatting
         array = []
         @series.each do |series|
           if index % 4 != 3
-            if series[:_line][:_defined].nil? || series[:_line][:_defined] == 0
-              series[:_line] = {
+            if series.line[:_defined].nil? || series.line[:_defined] == 0
+              series.line = {
                 :width    => 2.25,
                 :none     => 1,
                 :_defined => 1
               }
             end
 
-            if series[:_marker].nil? || series[:_marker] == 0
+            if series.marker.nil? || series.marker == 0
               if index % 4 == 2
-                series[:_marker] = { :type => 'dot', :size => 3 }
+                series.marker = { :type => 'dot', :size => 3 }
               else
-                series[:_marker] = { :type => 'none' }
+                series.marker = { :type => 'none' }
               end
             end
           end