write_xlsx 1.12.3 → 1.15.0

data/lib/write_xlsx/chart/series_writer.rb

@@ -0,0 +1,318 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+###############################################################################
+#
+# series_writer.rb - series and cache XML output helpers
+#
+###############################################################################
+
+module Writexlsx
+  class Chart
+    module SeriesWriter
+      private
+
+      #
+      # Write the series elements.
+      #
+      def write_series(series) # :nodoc:
+        write_ser(series)
+      end
+
+      #
+      # Write the <c:ser> element.
+      #
+      def write_ser(series) # :nodoc:
+        @writer.tag_elements('c:ser') do
+          write_ser_base(series) do
+            write_c_invert_if_negative(series.invert_if_negative)
+          end
+          # Write the c:cat element.
+          write_cat(series)
+          # Write the c:val element.
+          write_val(series)
+          # Write the c:smooth element.
+          write_c_smooth(series.smooth) if ptrue?(@smooth_allowed)
+          # Write the c:extLst element.
+          write_ext_lst_inverted_fill(series.inverted_color) if series.inverted_color
+        end
+        @series_index += 1
+      end
+
+      def write_ser_base(series)
+        # Write the c:idx element.
+        write_idx(@series_index)
+        # Write the c:order element.
+        write_order(@series_index)
+        # Write the series name.
+        write_series_name(series)
+        # Write the c:spPr element.
+        write_sp_pr(series)
+        # Write the c:marker element.
+        write_marker(series.marker)
+
+        yield if block_given?
+
+        # 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)
+      end
+
+      #
+      # Write the <c:idx> element.
+      #
+      def write_idx(val) # :nodoc:
+        @writer.empty_tag('c:idx', [['val', val]])
+      end
+
+      #
+      # Write the <c:order> element.
+      #
+      def write_order(val) # :nodoc:
+        @writer.empty_tag('c:order', [['val', val]])
+      end
+
+      #
+      # Write the series name.
+      #
+      def write_series_name(series) # :nodoc:
+        if series.name_formula
+          write_tx_formula(series.name_formula, series.name_id)
+        elsif series.name
+          write_tx_value(series.name)
+        end
+      end
+
+      #
+      # Write the <c:cat> element.
+      #
+      def write_cat(series) # :nodoc:
+        formula = series.categories
+        data_id = series.cat_data_id
+
+        data = @formula_data[data_id] if data_id
+
+        # Ignore <c:cat> elements for charts without category values.
+        return unless formula
+
+        @writer.tag_elements('c:cat') do
+          # Check the type of cached data.
+          type = get_data_type(data)
+          if type == 'str'
+            @cat_has_num_fmt = false
+            # Write the c:strRef element.
+            write_str_ref(formula, data, type)
+          elsif type == 'multi_str'
+            @cat_has_num_fmt = false
+            # Write the c:multiLvLStrRef element.
+            write_multi_lvl_str_ref(formula, data)
+          else
+            @cat_has_num_fmt = true
+            # Write the c:numRef element.
+            write_num_ref(formula, data, type)
+          end
+        end
+      end
+
+      #
+      # Write the <c:val> element.
+      #
+      def write_val(series) # :nodoc:
+        write_val_base(series.values, series.val_data_id, 'c:val')
+      end
+
+      def write_val_base(formula, data_id, tag) # :nodoc:
+        data = @formula_data[data_id]
+
+        @writer.tag_elements(tag) do
+          # Unlike Cat axes data should only be numeric.
+
+          # Write the c:numRef element.
+          write_num_ref(formula, data, 'num')
+        end
+      end
+
+      #
+      # Write the <c:numRef> or <c:strRef> element.
+      #
+      def write_num_or_str_ref(tag, formula, data, type) # :nodoc:
+        @writer.tag_elements(tag) do
+          # Write the c:f element.
+          write_series_formula(formula)
+          if type == 'num'
+            # Write the c:numCache element.
+            write_num_cache(data)
+          elsif type == 'str'
+            # Write the c:strCache element.
+            write_str_cache(data)
+          end
+        end
+      end
+
+      #
+      # Write the <c:numRef> element.
+      #
+      def write_num_ref(formula, data, type) # :nodoc:
+        write_num_or_str_ref('c:numRef', formula, data, type)
+      end
+
+      #
+      # Write the <c:strRef> element.
+      #
+      def write_str_ref(formula, data, type) # :nodoc:
+        write_num_or_str_ref('c:strRef', formula, data, type)
+      end
+
+      #
+      # Write the <c:multiLvLStrRef> element.
+      #
+      def write_multi_lvl_str_ref(formula, data)
+        return if data.empty?
+
+        @writer.tag_elements('c:multiLvlStrRef') do
+          # Write the c:f element.
+          write_series_formula(formula)
+
+          @writer.tag_elements('c:multiLvlStrCache') do
+            # Write the c:ptCount element.
+            write_pt_count(data.last.size)
+
+            # Write the data arrays in reverse order.
+            data.reverse.each do |arr|
+              @writer.tag_elements('c:lvl') do
+                # Write the c:pt element.
+                arr.each_with_index { |a, i| write_pt(i, a) }
+              end
+            end
+          end
+        end
+      end
+
+      #
+      # Write the <c:numLit> element for literal number list elements.
+      #
+      def write_num_lit(data)
+        write_num_base('c:numLit', data)
+      end
+
+      #
+      # Write the <c:f> element.
+      #
+      def write_series_formula(formula) # :nodoc:
+        # Strip the leading '=' from the formula.
+        formula = formula.sub(/^=/, '')
+
+        @writer.data_element('c:f', formula)
+      end
+
+      #
+      # Write the <c:numCache> element.
+      #
+      def write_num_cache(data) # :nodoc:
+        write_num_base('c:numCache', data)
+      end
+
+      def write_num_base(tag, data)
+        @writer.tag_elements(tag) do
+          # Write the c:formatCode element.
+          write_format_code('General')
+
+          # Write the c:ptCount element.
+          count = if data
+                    data.size
+                  else
+                    0
+                  end
+          write_pt_count(count)
+
+          data.each_with_index do |token, i|
+            # Write non-numeric data as 0.
+            if token &&
+               token.to_s !~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/
+              token = 0
+            end
+
+            # Write the c:pt element.
+            write_pt(i, token)
+          end
+        end
+      end
+
+      #
+      # Write the <c:strCache> element.
+      #
+      def write_str_cache(data) # :nodoc:
+        @writer.tag_elements('c:strCache') do
+          write_pt_count(data.size)
+          write_pts(data)
+        end
+      end
+
+      def write_pts(data)
+        data.each_index { |i| write_pt(i, data[i]) }
+      end
+
+      #
+      # Write the <c:formatCode> element.
+      #
+      def write_format_code(data) # :nodoc:
+        @writer.data_element('c:formatCode', data)
+      end
+
+      #
+      # Write the <c:ptCount> element.
+      #
+      def write_pt_count(val) # :nodoc:
+        @writer.empty_tag('c:ptCount', [['val', val]])
+      end
+
+      #
+      # Write the <c:pt> element.
+      #
+      def write_pt(idx, value) # :nodoc:
+        return unless value
+
+        attributes = [['idx', idx]]
+
+        @writer.tag_elements('c:pt', attributes) { write_v(value) }
+      end
+
+      #
+      # Write the <c:v> element.
+      #
+      def write_v(data) # :nodoc:
+        @writer.data_element('c:v', data)
+      end
+
+      #
+      # Write the <c:axId> elements for the primary or secondary axes.
+      #
+      def write_axis_ids(params)
+        # Generate the axis ids.
+        add_axis_ids(params)
+
+        if params[:primary_axes] == 0
+          # Write the axis ids for the secondary axes.
+          write_axis_id(@axis2_ids[0])
+          write_axis_id(@axis2_ids[1])
+        else
+          # Write the axis ids for the primary axes.
+          write_axis_id(@axis_ids[0])
+          write_axis_id(@axis_ids[1])
+        end
+      end
+
+      #
+      # Write the <c:axId> element.
+      #
+      def write_axis_id(val) # :nodoc:
+        @writer.empty_tag('c:axId', [['val', val]])
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/settings.rb

@@ -0,0 +1,226 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+###############################################################################
+#
+# settings.rb - common chart facade and orchestration
+#
+###############################################################################
+
+module Writexlsx
+  class Chart
+    module Settings
+      #
+      # Add a series and it's properties to a chart.
+      #
+      def add_series(params)
+        # Check that the required input has been specified.
+        raise "Must specify ':values' in add_series" unless params.has_key?(:values)
+
+        raise "Must specify ':categories' in add_series for this chart type" if @requires_category != 0 && !params.has_key?(:categories)
+
+        raise "The maximum number of series that can be added to an Excel Chart is 255." if @series.size == 255
+
+        @series << Series.new(self, params)
+
+        # Set the secondary axis properties.
+        x2_axis = params[:x2_axis]
+        y2_axis = params[:y2_axis]
+
+        # Store secondary status for combined charts.
+        @is_secondary = true if ptrue?(x2_axis) || ptrue?(y2_axis)
+
+        # Set the gap and overlap for Bar/Column charts.
+        if params[:gap]
+          if ptrue?(y2_axis)
+            @series_gap_2 = params[:gap]
+          else
+            @series_gap_1 = params[:gap]
+          end
+        end
+
+        # Set the overlap for Bar/Column charts.
+        if params[:overlap]
+          if ptrue?(y2_axis)
+            @series_overlap_2 = params[:overlap]
+          else
+            @series_overlap_1 = params[:overlap]
+          end
+        end
+      end
+
+      #
+      # Set the properties of the x-axis.
+      #
+      def set_x_axis(params = {})
+        @date_category = true if ptrue?(params[:date_axis])
+        @x_axis.apply_options(params)
+      end
+
+      #
+      # Set the properties of the Y-axis.
+      #
+      # The set_y_axis() method is used to set properties of the Y axis.
+      # The properties that can be set are the same as for set_x_axis,
+      #
+      def set_y_axis(params = {})
+        @date_category = true if ptrue?(params[:date_axis])
+        @y_axis.apply_options(params)
+      end
+
+      #
+      # Set the properties of the secondary X-axis.
+      #
+      def set_x2_axis(params = {})
+        @date_category = true if ptrue?(params[:date_axis])
+        @x2_axis.apply_options(params)
+      end
+
+      #
+      # Set the properties of the secondary Y-axis.
+      #
+      def set_y2_axis(params = {})
+        @date_category = true if ptrue?(params[:date_axis])
+        @y2_axis.apply_options(params)
+      end
+
+      #
+      # Set the properties of the chart title.
+      #
+      def set_title(params)
+        @title ||= Caption.new(self)
+        @title.apply_text_options(params)
+        @title.apply_format_options(params)
+      end
+
+      #
+      # Set the properties of the chart legend.
+      #
+      def set_legend(params)
+        # Convert the user default properties to internal properties.
+        legend_properties(params)
+      end
+
+      #
+      # Set the properties of the chart plotarea.
+      #
+      def set_plotarea(params)
+        # Convert the user defined properties to internal properties.
+        @plotarea = ChartArea.new(params)
+      end
+
+      #
+      # Set the properties of the chart chartarea.
+      #
+      def set_chartarea(params)
+        # Convert the user defined properties to internal properties.
+        @chartarea = ChartArea.new(params)
+      end
+
+      #
+      # Set on of the 42 built-in Excel chart styles. The default style is 2.
+      #
+      def set_style(style_id = 2)
+        style_id = 2 if style_id < 1 || style_id > 48
+        @style_id = style_id
+      end
+
+      #
+      # Set the option for displaying blank data in a chart. The default is 'gap'.
+      #
+      def show_blanks_as(option)
+        return unless option
+
+        raise "Unknown show_blanks_as() option '#{option}'\n" unless %i[gap zero span].include?(option.to_sym)
+
+        @show_blanks = option
+      end
+
+      #
+      # Display data in hidden rows or columns on the chart.
+      #
+      def show_hidden_data
+        @show_hidden_data = true
+      end
+
+      #
+      # Set dimensions for scale for the chart.
+      #
+      def set_size(params = {})
+        @width    = params[:width]    if params[:width]
+        @height   = params[:height]   if params[:height]
+        @x_scale  = params[:x_scale]  if params[:x_scale]
+        @y_scale  = params[:y_scale]  if params[:y_scale]
+        @x_offset = params[:x_offset] if params[:x_offset]
+        @y_offset = params[:y_offset] if params[:y_offset]
+      end
+
+      # Backward compatibility with poorly chosen method name.
+      alias size set_size
+
+      #
+      # The set_table method adds a data table below the horizontal axis with the
+      # data used to plot the chart.
+      #
+      def set_table(params = {})
+        @table = Table.new(params)
+        @table.palette = @palette
+      end
+
+      #
+      # Set properties for the chart up-down bars.
+      #
+      def set_up_down_bars(params = {})
+        # Map border to line.
+        %i[up down].each do |up_down|
+          if params[up_down]
+            params[up_down][:line] = params[up_down][:border] if params[up_down][:border]
+          else
+            params[up_down] = {}
+          end
+        end
+
+        # Set the up and down bar properties.
+        @up_down_bars = {
+          _up:   Chartline.new(params[:up]),
+          _down: Chartline.new(params[:down])
+        }
+      end
+
+      #
+      # Set properties for the chart drop lines.
+      #
+      def set_drop_lines(params = {})
+        @drop_lines = Chartline.new(params)
+      end
+
+      #
+      # Set properties for the chart high-low lines.
+      #
+      def set_high_low_lines(params = {})
+        @hi_low_lines = Chartline.new(params)
+      end
+
+      #
+      # Add another chart to create a combined chart.
+      #
+      def combine(chart)
+        @combined = chart
+      end
+
+      #
+      # Setup the default configuration data for an embedded chart.
+      #
+      def set_embedded_config_data
+        @embedded = true
+      end
+
+      #
+      # Set the option for displaying #N/A as an empty cell in a chart.
+      #
+      def show_na_as_empty_cell
+        @show_na_as_empty = true
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/stock.rb

@@ -15,7 +15,7 @@
 
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/chart'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   class Chart
@@ -24,7 +24,7 @@ module Writexlsx
     # A series must be added for each of these data sources.
     #
     class Stock < self
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       def initialize(subtype)
         super

data/lib/write_xlsx/chart/table.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/utility/common'
+require 'write_xlsx/utility/chart_formatting'
+require 'write_xlsx/utility/rich_text'
+
+module Writexlsx
+  class Chart
+    class Table
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::ChartFormatting
+      include Writexlsx::Utility::RichText
+
+      attr_reader :horizontal, :vertical, :outline, :show_keys, :font
+
+      def initialize(params = {})
+        @horizontal = true
+        @vertical   = true
+        @outline    = true
+        @show_keys  = false
+        @horizontal = params[:horizontal] if params.has_key?(:horizontal)
+        @vertical   = params[:vertical]   if params.has_key?(:vertical)
+        @outline    = params[:outline]    if params.has_key?(:outline)
+        @show_keys  = params[:show_keys]  if params.has_key?(:show_keys)
+        @font       = convert_font_args(params[:font])
+      end
+
+      attr_writer :palette
+
+      def write_d_table(writer)
+        @writer = writer
+        @writer.tag_elements('c:dTable') do
+          @writer.empty_tag('c:showHorzBorder', attributes) if ptrue?(horizontal)
+          @writer.empty_tag('c:showVertBorder', attributes) if ptrue?(vertical)
+          @writer.empty_tag('c:showOutline',    attributes) if ptrue?(outline)
+          @writer.empty_tag('c:showKeys',       attributes) if ptrue?(show_keys)
+          # Write the table font.
+          write_tx_pr(font)                                 if ptrue?(font)
+        end
+      end
+
+      private
+
+      def attributes
+        [['val', 1]]
+      end
+    end
+  end
+end