write_xlsx 1.12.3 → 1.15.0

data/lib/write_xlsx/chart/initialization.rb

@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'write_xlsx/chart/axis'
+require 'write_xlsx/chart/legend'
+
+module Writexlsx
+  class Chart
+    module Initialization
+      private
+
+      def axis_setup
+        @axis_ids          = []
+        @axis2_ids         = []
+        @cat_has_num_fmt   = false
+        @requires_category = 0
+        @cat_axis_position = 'b'
+        @val_axis_position = 'l'
+        @horiz_cat_axis    = 0
+        @horiz_val_axis    = 1
+        @x_axis            = Axis.new(self)
+        @y_axis            = Axis.new(self)
+        @x2_axis           = Axis.new(self)
+        @y2_axis           = Axis.new(self)
+      end
+
+      def display_setup
+        @orientation       = 0x0
+        @width             = 480
+        @height            = 288
+        @x_scale           = 1
+        @y_scale           = 1
+        @x_offset          = 0
+        @y_offset          = 0
+        @legend            = Legend.new
+        @smooth_allowed    = 0
+        @cross_between     = 'between'
+        @date_category     = false
+        @show_blanks       = 'gap'
+        @show_na_as_empty  = false
+        @show_hidden_data  = false
+        @show_crosses      = true
+      end
+
+      #
+      # Setup the default properties for a chart.
+      #
+      def set_default_properties # :nodoc:
+        display_setup
+        axis_setup
+        set_axis_defaults
+
+        set_x_axis
+        set_y_axis
+
+        set_x2_axis
+        set_y2_axis
+      end
+
+      def set_axis_defaults
+        @x_axis.defaults  = x_axis_defaults
+        @y_axis.defaults  = y_axis_defaults
+        @x2_axis.defaults = x2_axis_defaults
+        @y2_axis.defaults = y2_axis_defaults
+      end
+
+      def x_axis_defaults
+        {
+          num_format:      'General',
+          major_gridlines: { visible: 0 }
+        }
+      end
+
+      def y_axis_defaults
+        {
+          num_format:      'General',
+          major_gridlines: { visible: 1 }
+        }
+      end
+
+      def x2_axis_defaults
+        {
+          num_format:     'General',
+          label_position: 'none',
+          crossing:       'max',
+          visible:        0
+        }
+      end
+
+      def y2_axis_defaults
+        {
+          num_format:      'General',
+          major_gridlines: { visible: 0 },
+          position:        'right',
+          visible:         1
+        }
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/line.rb

@@ -14,13 +14,14 @@
 #
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
+require 'write_xlsx/chart/d_pt_point_writer'
 
 module Writexlsx
   class Chart
     class Line < self
-      include Writexlsx::Utility
-      include Writexlsx::WriteDPtPoint
+      include Writexlsx::Utility::XmlPrimitives
+      include DPtPointWriter
 
       def initialize(subtype)
         super

data/lib/write_xlsx/chart/pie.rb

@@ -15,7 +15,9 @@
 
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/chart'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/cell_reference'
+require 'write_xlsx/utility/xml_primitives'
+require 'write_xlsx/utility/sheetname_quoting'
 
 module Writexlsx
   class Chart
@@ -26,7 +28,9 @@ module Writexlsx
     #     chart.set_y_axis
     #
     class Pie < self
-      include Writexlsx::Utility
+      include Writexlsx::Utility::CellReference
+      include Writexlsx::Utility::XmlPrimitives
+      include Writexlsx::Utility::SheetnameQuoting
 
       def initialize(subtype)
         super

data/lib/write_xlsx/chart/radar.rb

@@ -14,7 +14,7 @@
 #
 
 require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
 
 module Writexlsx
   class Chart
@@ -28,7 +28,7 @@ module Writexlsx
     #     chart = workbook.add_chart( :type => 'column', :subtype => 'stacked' )
     #
     class Radar < self
-      include Writexlsx::Utility
+      include Writexlsx::Utility::XmlPrimitives
 
       def initialize(subtype)
         super

data/lib/write_xlsx/chart/scatter.rb

@@ -15,13 +15,14 @@
 
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/chart'
-require 'write_xlsx/utility'
+require 'write_xlsx/utility/xml_primitives'
+require 'write_xlsx/chart/d_pt_point_writer'
 
 module Writexlsx
   class Chart
     class Scatter < self
-      include Writexlsx::Utility
-      include Writexlsx::WriteDPtPoint
+      include Writexlsx::Utility::XmlPrimitives
+      include DPtPointWriter
 
       def initialize(subtype)
         super

data/lib/write_xlsx/chart/series.rb

@@ -3,10 +3,17 @@
 
 module Writexlsx
   class Chart
+    require 'write_xlsx/utility/common'
+    require 'write_xlsx/utility/cell_reference'
+    require 'write_xlsx/utility/chart_formatting'
+    require 'write_xlsx/utility/rich_text'
+    require 'write_xlsx/utility/sheetname_quoting'
     require 'write_xlsx/gradient'
 
     class Chartline
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::ChartFormatting
+      include Writexlsx::Utility::RichText
       include Writexlsx::Gradient
 
       attr_reader :line, :fill, :type, :gradient, :pattern
@@ -174,7 +181,7 @@ module Writexlsx
     end
 
     class Errorbars
-      include Writexlsx::Utility
+      include Writexlsx::Utility::ChartFormatting
 
       attr_reader :type, :direction, :endcap, :value, :line, :fill
       attr_reader :plus_values, :minus_values, :plus_data, :minus_data
@@ -223,7 +230,11 @@ module Writexlsx
     end
 
     class Series
-      include Writexlsx::Utility
+      include Writexlsx::Utility::Common
+      include Writexlsx::Utility::CellReference
+      include Writexlsx::Utility::ChartFormatting
+      include Writexlsx::Utility::RichText
+      include Writexlsx::Utility::SheetnameQuoting
       include Writexlsx::Gradient
 
       attr_reader :values, :categories, :name, :name_formula, :name_id
@@ -322,19 +333,10 @@ module Writexlsx
       def labels_properties(labels) # :nodoc:
         return nil unless labels
 
+        labels = labels.dup
+
         # Map user defined label positions to Excel positions.
-        position = labels[:position]
-        if ptrue?(position)
-          if @label_positions[position]
-            labels[:position] = if position == @label_position_default
-                                  nil
-                                else
-                                  @label_positions[position]
-                                end
-          else
-            raise "Unsupported label position '#{position}' for this chart type"
-          end
-        end
+        map_label_position!(labels)
 
         # Map the user defined label separator to the Excel separator.
         separators = {
@@ -400,6 +402,9 @@ module Writexlsx
 
             property[:font] = convert_font_args(property[:font]) if property[:font]
 
+            # Map user defined label positions to Excel positions.
+            map_label_position!(property)
+
             # Allow 'border' as a synonym for 'line'.
             line = line_properties(property[:border] || property[:line])
 
@@ -431,6 +436,21 @@ module Writexlsx
 
         labels
       end
+
+      def map_label_position!(property)
+        position = property[:position]
+        return unless ptrue?(position)
+
+        if @label_positions[position]
+          property[:position] = if position == @label_position_default
+                                  nil
+                                else
+                                  @label_positions[position]
+                                end
+        else
+          raise "Unsupported label position '#{position}' for this chart type"
+        end
+      end
     end
   end
 end

data/lib/write_xlsx/chart/series_data.rb

@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+###############################################################################
+#
+# series_data.rb - series/formula bookkeeping and axis id management
+#
+###############################################################################
+
+module Writexlsx
+  class Chart
+    module SeriesData
+      #
+      # Switch name and name_formula parameters if required.
+      #
+      def process_names(name = nil, name_formula = nil) # :nodoc:
+        # Name looks like a formula, use it to set name_formula.
+        if name.respond_to?(:to_ary)
+          cell = xl_rowcol_to_cell(name[1], name[2], 1, 1)
+          name_formula = "#{quote_sheetname(name[0])}!#{cell}"
+          name = ''
+        elsif name && name =~ /^=[^!]+!\$/
+          name_formula = name
+          name         = ''
+        end
+
+        [name, name_formula]
+      end
+
+      #
+      # Assign an id to a each unique series formula or title/axis formula. Repeated
+      # formulas such as for categories get the same id. If the series or title
+      # has user specified data associated with it then that is also stored. This
+      # data is used to populate cached Excel data when creating a chart.
+      # If there is no user defined data then it will be populated by the parent
+      # workbook in Workbook::_add_chart_data
+      #
+      def data_id(full_formula, data) # :nodoc:
+        return unless full_formula
+
+        # Strip the leading '=' from the formula.
+        formula = full_formula.sub(/^=/, '')
+
+        # Store the data id in a hash keyed by the formula and store the data
+        # in a separate array with the same id.
+        if @formula_ids.has_key?(formula)
+          # Formula already seen. Return existing id.
+          id = @formula_ids[formula]
+          # Store user defined data if it isn't already there.
+          @formula_data[id] ||= data
+        else
+          # Haven't seen this formula before.
+          id = @formula_ids[formula] = @formula_data.size
+          @formula_data << data
+        end
+
+        id
+      end
+
+      private
+
+      #
+      # retun primary/secondary series by :primary_axes flag
+      #
+      def axes_series(params)
+        if params[:primary_axes] == 0
+          secondary_axes_series
+        else
+          primary_axes_series
+        end
+      end
+
+      #
+      # Find the overall type of the data associated with a series.
+      #
+      # TODO. Need to handle date type.
+      #
+      def get_data_type(data) # :nodoc:
+        # Check for no data in the series.
+        return 'none' unless data
+        return 'none' if data.empty?
+        return 'multi_str' if data.first.is_a?(Array)
+
+        # If the token isn't a number assume it is a string.
+        data.each do |token|
+          next unless token
+          return 'str' unless token.is_a?(Numeric)
+        end
+
+        # The series data was all numeric.
+        'num'
+      end
+
+      #
+      # Returns series which use the primary axes.
+      #
+      def get_primary_axes_series
+        @series.reject(&:y2_axis)
+      end
+      alias primary_axes_series get_primary_axes_series
+
+      #
+      # Returns series which use the secondary axes.
+      #
+      def get_secondary_axes_series
+        @series.select(&:y2_axis)
+      end
+      alias secondary_axes_series get_secondary_axes_series
+
+      #
+      # Add a unique ids for primary or secondary axis.
+      #
+      def add_axis_ids(params) # :nodoc:
+        if ptrue?(params[:primary_axes])
+          @axis_ids  += ids
+        else
+          @axis2_ids += ids
+        end
+      end
+
+      def ids
+        chart_id   = 5001 + @id
+        axis_count = 1 + @axis2_ids.size + @axis_ids.size
+
+        id1 = sprintf('%04d%04d', chart_id, axis_count)
+        id2 = sprintf('%04d%04d', chart_id, axis_count + 1)
+
+        [id1, id2]
+      end
+    end
+  end
+end