write_xlsx 1.12.3 → 1.15.0

data/lib/write_xlsx/chart/axis_writer.rb

@@ -0,0 +1,528 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+###############################################################################
+#
+# axis_writer.rb - axis-specific XML output helpers
+#
+###############################################################################
+
+module Writexlsx
+  class Chart
+    module AxisWriter
+      private
+
+      #
+      # Write the <c:catAx> element. Usually the X axis.
+      #
+      def write_cat_axis(params) # :nodoc:
+        x_axis   = params[:x_axis]
+        y_axis   = params[:y_axis]
+        axis_ids = params[:axis_ids]
+
+        # if there are no axis_ids then we don't need to write this element
+        return unless axis_ids
+        return if axis_ids.empty?
+
+        position  = @cat_axis_position
+        is_y_axis = @horiz_cat_axis
+
+        # Overwrite the default axis position with a user supplied value.
+        position = x_axis.position || position
+
+        @writer.tag_elements('c:catAx') do
+          write_axis_id(axis_ids[0])
+          # Write the c:scaling element.
+          write_scaling(x_axis.reverse)
+
+          write_delete(1) unless ptrue?(x_axis.visible)
+
+          # Write the c:axPos element.
+          write_axis_pos(position, y_axis.reverse)
+
+          # Write the c:majorGridlines element.
+          write_major_gridlines(x_axis.major_gridlines)
+
+          # Write the c:minorGridlines element.
+          write_minor_gridlines(x_axis.minor_gridlines)
+
+          # Write the axis title elements.
+          write_chart_title(x_axis.title, is_y_axis)
+
+          # Write the c:numFmt element.
+          write_cat_number_format(x_axis)
+
+          # Write the c:majorTickMark element.
+          write_major_tick_mark(x_axis.major_tick_mark)
+
+          # Write the c:minorTickMark element.
+          write_minor_tick_mark(x_axis.minor_tick_mark)
+
+          # Write the c:tickLblPos element.
+          write_tick_label_pos(x_axis.label_position)
+
+          # Write the c:spPr element for the axis line.
+          write_sp_pr(x_axis)
+
+          # Write the axis font elements.
+          write_axis_font(x_axis.num_font)
+
+          # Write the c:crossAx element.
+          write_cross_axis(axis_ids[1])
+
+          write_crossing(y_axis.crossing) if @show_crosses || ptrue?(x_axis.visible)
+          # Write the c:auto element.
+          write_auto(1) unless x_axis.text_axis
+          # Write the c:labelAlign element.
+          write_label_align(x_axis.label_align)
+          # Write the c:labelOffset element.
+          write_label_offset(100)
+          # Write the c:tickLblSkip element.
+          write_tick_lbl_skip(x_axis.interval_unit)
+          # Write the c:tickMarkSkip element.
+          write_tick_mark_skip(x_axis.interval_tick)
+        end
+      end
+
+      #
+      # Write the <c:valAx> element. Usually the Y axis.
+      #
+      def write_val_axis(x_axis, y_axis, axis_ids, position = nil)
+        return unless axis_ids && !axis_ids.empty?
+
+        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
+          write_axis_id(axis_ids_1)
+
+          # Write the c:scaling element.
+          write_scaling_with_param(y_axis)
+
+          write_delete(1) unless ptrue?(y_axis.visible)
+
+          # Write the c:axPos element.
+          write_axis_pos(position, x_axis.reverse)
+
+          # Write the c:majorGridlines element.
+          write_major_gridlines(y_axis.major_gridlines)
+
+          # Write the c:minorGridlines element.
+          write_minor_gridlines(y_axis.minor_gridlines)
+
+          # Write the axis title elements.
+          write_chart_title(y_axis.title, @horiz_val_axis)
+
+          # Write the c:numberFormat element.
+          write_number_format(y_axis)
+
+          # Write the c:majorTickMark element.
+          write_major_tick_mark(y_axis.major_tick_mark)
+
+          # Write the c:minorTickMark element.
+          write_minor_tick_mark(y_axis.minor_tick_mark)
+
+          # Write the c:tickLblPos element.
+          write_tick_label_pos(y_axis.label_position)
+
+          # Write the c:spPr element for the axis line.
+          write_sp_pr(y_axis)
+
+          # Write the axis font elements.
+          write_axis_font(y_axis.num_font)
+
+          # Write the c:crossAx element.
+          write_cross_axis(axis_ids_0)
+
+          write_crossing(x_axis.crossing)
+
+          # Write the c:crossBetween element.
+          write_cross_between(x_axis.position_axis)
+
+          # Write the c:majorUnit element.
+          write_c_major_unit(y_axis.major_unit)
+
+          # Write the c:minorUnit element.
+          write_c_minor_unit(y_axis.minor_unit)
+
+          # Write the c:dispUnits element.
+          write_disp_units(y_axis.display_units, y_axis.display_units_visible)
+        end
+      end
+
+      #
+      # Write the <c:dateAx> element. Usually the X axis.
+      #
+      def write_date_axis(params)  # :nodoc:
+        x_axis    = params[:x_axis]
+        y_axis    = params[:y_axis]
+        axis_ids  = params[:axis_ids]
+
+        return unless axis_ids && !axis_ids.empty?
+
+        position  = @cat_axis_position
+
+        # Overwrite the default axis position with a user supplied value.
+        position = x_axis.position || position
+
+        @writer.tag_elements('c:dateAx') do
+          write_axis_id(axis_ids[0])
+          # Write the c:scaling element.
+          write_scaling_with_param(x_axis)
+
+          write_delete(1) unless ptrue?(x_axis.visible)
+
+          # Write the c:axPos element.
+          write_axis_pos(position, y_axis.reverse)
+
+          # Write the c:majorGridlines element.
+          write_major_gridlines(x_axis.major_gridlines)
+
+          # Write the c:minorGridlines element.
+          write_minor_gridlines(x_axis.minor_gridlines)
+
+          # Write the axis title elements.
+          write_chart_title(x_axis.title)
+
+          # Write the c:numFmt element.
+          write_number_format(x_axis)
+          # Write the c:majorTickMark element.
+          write_major_tick_mark(x_axis.major_tick_mark)
+
+          # Write the c:tickLblPos element.
+          write_tick_label_pos(x_axis.label_position)
+          # Write the c:spPr element for the axis line.
+          write_sp_pr(x_axis)
+          # Write the font elements.
+          write_axis_font(x_axis.num_font)
+          # Write the c:crossAx element.
+          write_cross_axis(axis_ids[1])
+
+          write_crossing(y_axis.crossing) if @show_crosses || ptrue?(x_axis.visible)
+
+          # Write the c:auto element.
+          write_auto(1)
+          # Write the c:labelOffset element.
+          write_label_offset(100)
+          # Write the c:tickLblSkip element.
+          write_tick_lbl_skip(x_axis.interval_unit)
+          # Write the c:tickMarkSkip element.
+          write_tick_mark_skip(x_axis.interval_tick)
+          # Write the c:majorUnit element.
+          write_c_major_unit(x_axis.major_unit)
+          # Write the c:majorTimeUnit element.
+          write_c_major_time_unit(x_axis.major_unit_type) if x_axis.major_unit
+          # Write the c:minorUnit element.
+          write_c_minor_unit(x_axis.minor_unit)
+          # Write the c:minorTimeUnit element.
+          write_c_minor_time_unit(x_axis.minor_unit_type) if x_axis.minor_unit
+        end
+      end
+
+      def write_crossing(crossing)
+        # Note, the category crossing comes from the value axis.
+        if [nil, 'max', 'min'].include?(crossing)
+          # Write the c:crosses element.
+          write_crosses(crossing)
+        else
+          # Write the c:crossesAt element.
+          write_c_crosses_at(crossing)
+        end
+      end
+
+      def write_scaling_with_param(param)
+        write_scaling(
+          param.reverse,
+          param.min,
+          param.max,
+          param.log_base
+        )
+      end
+
+      #
+      # Write the <c:scaling> element.
+      #
+      def write_scaling(reverse, min = nil, max = nil, log_base = nil) # :nodoc:
+        @writer.tag_elements('c:scaling') do
+          # Write the c:logBase element.
+          write_c_log_base(log_base)
+          # Write the c:orientation element.
+          write_orientation(reverse)
+          # Write the c:max element.
+          write_c_max(max)
+          # Write the c:min element.
+          write_c_min(min)
+        end
+      end
+
+      #
+      # Write the <c:logBase> element.
+      #
+      def write_c_log_base(val) # :nodoc:
+        return unless ptrue?(val)
+
+        @writer.empty_tag('c:logBase', [['val', val]])
+      end
+
+      #
+      # Write the <c:orientation> element.
+      #
+      def write_orientation(reverse = nil) # :nodoc:
+        val = ptrue?(reverse) ? 'maxMin' : 'minMax'
+
+        @writer.empty_tag('c:orientation', [['val', val]])
+      end
+
+      #
+      # Write the <c:max> element.
+      #
+      def write_c_max(max = nil) # :nodoc:
+        @writer.empty_tag('c:max', [['val', max]]) if max
+      end
+
+      #
+      # Write the <c:min> element.
+      #
+      def write_c_min(min = nil) # :nodoc:
+        @writer.empty_tag('c:min', [['val', min]]) if min
+      end
+
+      #
+      # Write the <c:axPos> element.
+      #
+      def write_axis_pos(val, reverse = false) # :nodoc:
+        if reverse
+          val = 'r' if val == 'l'
+          val = 't' if val == 'b'
+        end
+
+        @writer.empty_tag('c:axPos', [['val', val]])
+      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(axis) # :nodoc:
+        axis.write_number_format(@writer)
+      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(axis)
+        axis.write_cat_number_format(@writer, @cat_has_num_fmt)
+      end
+
+      #
+      # Write the <c:majorTickMark> element.
+      #
+      def write_major_tick_mark(val)
+        return unless ptrue?(val)
+
+        @writer.empty_tag('c:majorTickMark', [['val', val]])
+      end
+
+      #
+      # Write the <c:minorTickMark> element.
+      #
+      def write_minor_tick_mark(val)
+        return unless ptrue?(val)
+
+        @writer.empty_tag('c:minorTickMark', [['val', val]])
+      end
+
+      #
+      # Write the <c:tickLblPos> element.
+      #
+      def write_tick_label_pos(val) # :nodoc:
+        val ||= 'nextTo'
+        val = 'nextTo' if val == 'next_to'
+
+        @writer.empty_tag('c:tickLblPos', [['val', val]])
+      end
+
+      #
+      # Write the <c:crossAx> element.
+      #
+      def write_cross_axis(val = 'autoZero') # :nodoc:
+        @writer.empty_tag('c:crossAx', [['val', val]])
+      end
+
+      #
+      # Write the <c:crosses> element.
+      #
+      def write_crosses(val) # :nodoc:
+        val ||= 'autoZero'
+
+        @writer.empty_tag('c:crosses', [['val', val]])
+      end
+
+      #
+      # Write the <c:crossesAt> element.
+      #
+      def write_c_crosses_at(val) # :nodoc:
+        @writer.empty_tag('c:crossesAt', [['val', val]])
+      end
+
+      #
+      # Write the <c:auto> element.
+      #
+      def write_auto(val) # :nodoc:
+        @writer.empty_tag('c:auto', [['val', val]])
+      end
+
+      #
+      # Write the <c:labelAlign> element.
+      #
+      def write_label_align(val) # :nodoc:
+        val ||= 'ctr'
+        if val == 'right'
+          val = 'r'
+        elsif val == 'left'
+          val = 'l'
+        end
+        @writer.empty_tag('c:lblAlgn', [['val', val]])
+      end
+
+      #
+      # Write the <c:labelOffset> element.
+      #
+      def write_label_offset(val) # :nodoc:
+        @writer.empty_tag('c:lblOffset', [['val', val]])
+      end
+
+      #
+      # Write the <c:tickLblSkip> element.
+      #
+      def write_tick_lbl_skip(val) # :nodoc:
+        return unless val
+
+        @writer.empty_tag('c:tickLblSkip', [['val', val]])
+      end
+
+      #
+      # Write the <c:tickMarkSkip> element.
+      #
+      def write_tick_mark_skip(val)  # :nodoc:
+        return unless val
+
+        @writer.empty_tag('c:tickMarkSkip', [['val', val]])
+      end
+
+      #
+      # Write the <c:majorGridlines> element.
+      #
+      def write_major_gridlines(gridlines) # :nodoc:
+        write_gridlines_base('c:majorGridlines', gridlines)
+      end
+
+      #
+      # Write the <c:minorGridlines> element.
+      #
+      def write_minor_gridlines(gridlines)  # :nodoc:
+        write_gridlines_base('c:minorGridlines', gridlines)
+      end
+
+      def write_gridlines_base(tag, gridlines)  # :nodoc:
+        return unless gridlines
+        return if gridlines.respond_to?(:[]) && !ptrue?(gridlines[:_visible])
+
+        if gridlines.line_defined?
+          @writer.tag_elements(tag) { write_sp_pr(gridlines) }
+        else
+          @writer.empty_tag(tag)
+        end
+      end
+
+      #
+      # Write the <c:crossBetween> element.
+      #
+      def write_cross_between(val = nil) # :nodoc:
+        val ||= @cross_between
+
+        @writer.empty_tag('c:crossBetween', [['val', val]])
+      end
+
+      #
+      # Write the <c:majorUnit> element.
+      #
+      def write_c_major_unit(val = nil) # :nodoc:
+        return unless val
+
+        @writer.empty_tag('c:majorUnit', [['val', val]])
+      end
+
+      #
+      # Write the <c:minorUnit> element.
+      #
+      def write_c_minor_unit(val = nil) # :nodoc:
+        return unless val
+
+        @writer.empty_tag('c:minorUnit', [['val', val]])
+      end
+
+      #
+      # Write the <c:majorTimeUnit> element.
+      #
+      def write_c_major_time_unit(val) # :nodoc:
+        val ||= 'days'
+
+        @writer.empty_tag('c:majorTimeUnit', [['val', val]])
+      end
+
+      #
+      # Write the <c:minorTimeUnit> element.
+      #
+      def write_c_minor_time_unit(val) # :nodoc:
+        val ||= 'days'
+
+        @writer.empty_tag('c:minorTimeUnit', [['val', val]])
+      end
+
+      #
+      # Write the <c:dispUnits> element.
+      #
+      def write_disp_units(units, display)
+        return unless ptrue?(units)
+
+        attributes = [['val', units]]
+
+        @writer.tag_elements('c:dispUnits') do
+          @writer.empty_tag('c:builtInUnit', attributes)
+          if ptrue?(display)
+            @writer.tag_elements('c:dispUnitsLbl') do
+              @writer.empty_tag('c:layout')
+            end
+          end
+        end
+      end
+
+      #
+      # Write the axis font elements.
+      #
+      def write_axis_font(font) # :nodoc:
+        return unless font
+
+        @writer.tag_elements('c:txPr') do
+          write_a_body_pr(font[:_rotation])
+          write_a_lst_style
+          @writer.tag_elements('a:p') do
+            write_a_p_pr_rich(font)
+            write_a_end_para_rpr
+          end
+        end
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/bar.rb

@@ -14,12 +14,12 @@
 #
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   class Chart
     class Bar < self
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       def initialize(subtype)
         super

data/lib/write_xlsx/chart/caption.rb

@@ -4,26 +4,33 @@
 module Writexlsx
   class Chart
     class Caption
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::RichText
 
-      attr_accessor :name, :formula, :data_id, :name_font
+      attr_accessor :name, :formula, :data_id, :font
+      attr_accessor :line, :fill, :pattern, :gradient
       attr_reader :layout, :overlay, :none
 
       def initialize(chart)
         @chart = chart
       end
 
-      def merge_with_hash(params) # :nodoc:
+      def apply_text_options(params) # :nodoc:
         @name, @formula = chart.process_names(params[:name], params[:name_formula])
-        @data_id   = chart.data_id(@formula, params[:data])
-        @name_font = convert_font_args(params[:name_font])
-        @layout    = chart.layout_properties(params[:layout], 1)
+        @name = nil if @name.respond_to?(:empty?) && @name.empty?
+        @data_id = chart.data_id(@formula, params[:data])
+        @font     = convert_font_args(params[:font] || params[:name_font])
 
-        # Set the title overlay option.
+        @layout   = chart.layout_properties(params[:layout], 1)
         @overlay  = params[:overlay]
+        @none     = params[:none]
+      end
 
-        # Set the no automatic title option.
-        @none = params[:none]
+      def apply_format_options(params)
+        @line     = chart.line_properties(params[:border] || params[:line])
+        @fill     = chart.fill_properties(params[:fill])
+        @pattern  = chart.pattern_properties(params[:pattern])
+        @gradient = chart.gradient_properties(params[:gradient])
       end
 
       private

data/lib/write_xlsx/chart/chart_area.rb

@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+module Writexlsx
+  class Chart
+    class ChartArea
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::ChartFormatting
+      include Writexlsx::Gradient
+
+      attr_reader :line, :fill, :pattern, :gradient, :layout
+
+      def initialize(params = {})
+        @layout = layout_properties(params[:layout])
+
+        # Allow 'border' as a synonym for 'line'.
+        border = params_to_border(params)
+
+        # Set the line properties for the chartarea.
+        @line = line_properties(border || params[:line])
+
+        # Set the pattern properties for the series.
+        @pattern = pattern_properties(params[:pattern])
+
+        # Set the gradient fill properties for the series.
+        @gradient = gradient_properties(params[:gradient])
+
+        # Map deprecated Spreadsheet::WriteExcel fill colour.
+        fill = params[:color] ? { color: params[:color] } : params[:fill]
+        @fill = fill_properties(fill)
+
+        # Pattern fill overrides solid fill.
+        @fill = nil if ptrue?(@pattern)
+
+        # Gradient fill overrides solid and pattern fills.
+        if ptrue?(@gradient)
+          @pattern = nil
+          @fill    = nil
+        end
+      end
+
+      private
+
+      def params_to_border(params)
+        line_weight  = params[:line_weight]
+
+        # Map deprecated Spreadsheet::WriteExcel line_weight.
+        border = params[:border]
+        border = { width: swe_line_weight(line_weight) } if line_weight
+
+        # Map deprecated Spreadsheet::WriteExcel line_pattern.
+        if params[:line_pattern]
+          pattern = swe_line_pattern(params[:line_pattern])
+          if pattern == 'none'
+            border = { none: 1 }
+          else
+            border[:dash_type] = pattern
+          end
+        end
+
+        # Map deprecated Spreadsheet::WriteExcel line colour.
+        border[:color] = params[:line_color] if params[:line_color]
+        border
+      end
+
+      #
+      # Get the Spreadsheet::WriteExcel line pattern for backward compatibility.
+      #
+      def swe_line_pattern(val)
+        swe_line_pattern_hash[numeric_or_downcase(val)] || 'solid'
+      end
+
+      def swe_line_pattern_hash
+        {
+          0              => 'solid',
+          1              => 'dash',
+          2              => 'dot',
+          3              => 'dash_dot',
+          4              => 'long_dash_dot_dot',
+          5              => 'none',
+          6              => 'solid',
+          7              => 'solid',
+          8              => 'solid',
+          'solid'        => 'solid',
+          'dash'         => 'dash',
+          'dot'          => 'dot',
+          'dash-dot'     => 'dash_dot',
+          'dash-dot-dot' => 'long_dash_dot_dot',
+          'none'         => 'none',
+          'dark-gray'    => 'solid',
+          'medium-gray'  => 'solid',
+          'light-gray'   => 'solid'
+        }
+      end
+
+      #
+      # Get the Spreadsheet::WriteExcel line weight for backward compatibility.
+      #
+      def swe_line_weight(val)
+        swe_line_weight_hash[numeric_or_downcase(val)] || 1
+      end
+
+      def swe_line_weight_hash
+        {
+          1          => 0.25,
+          2          => 1,
+          3          => 2,
+          4          => 3,
+          'hairline' => 0.25,
+          'narrow'   => 1,
+          'medium'   => 2,
+          'wide'     => 3
+        }
+      end
+
+      def numeric_or_downcase(val)
+        val.respond_to?(:coerce) ? val : val.downcase
+      end
+    end
+  end
+end