caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/drawing/scatter_series.rb

@@ -1,129 +1,126 @@
-# encoding: UTF-8
-module Axlsx
-
-  # A ScatterSeries defines the x and y position of data in the chart
-  # @note The recommended way to manage series is to use Chart#add_series
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  # @see examples/example.rb
-  class ScatterSeries < Series
-
-    # The x data for this series.
-    # @return [NamedAxisData]
-    attr_reader :xData
-
-    # The y data for this series.
-    # @return [NamedAxisData]
-    attr_reader :yData
-
-    # The fill color for this series.
-    # Red, green, and blue is expressed as sequence of hex digits, RRGGBB. A perceptual gamma of 2.2 is used.
-    # @return [String]
-    attr_reader :color
-
-    # @return [String]
-    attr_reader :ln_width
-
-    # Line smoothing between data points
-    # @return [Boolean]
-    attr_reader :smooth
-
-    # Line markers presence
-    # @return [Boolean]
-    attr_reader :show_marker
-
-    # custom marker symbol
-    # @return [String]
-    attr_reader :marker_symbol
-
-    # Creates a new ScatterSeries
-    def initialize(chart, options={})
-      @xData, @yData = nil
-      if options[:smooth].nil?
-        # If caller hasn't specified smoothing or not, turn smoothing on or off based on scatter style
-        @smooth = [:smooth, :smoothMarker].include?(chart.scatter_style)
-      else
-        # Set smoothing according to the option provided
-        Axlsx::validate_boolean(options[:smooth])
-        @smooth = options[:smooth]
-      end
-      @ln_width = options[:ln_width] unless options[:ln_width].nil?
-      @show_marker = [:lineMarker, :marker, :smoothMarker].include?(chart.scatter_style)
-      @marker_symbol = :default
-
-      super(chart, options)
-      @xData = AxDataSource.new(:tag_name => :xVal, :data => options[:xData]) unless options[:xData].nil?
-      @yData = NumDataSource.new({:tag_name => :yVal, :data => options[:yData]}) unless options[:yData].nil?
-    end
-
-    # @see color
-    def color=(v)
-      @color = v
-    end
-
-    # @see smooth
-    def smooth=(v)
-      Axlsx::validate_boolean(v)
-      @smooth = v
-    end
-
-    # @see ln_width
-    def ln_width=(v)
-      @ln_width = v
-    end
-
-    # @see marker_symbol
-    def marker_symbol=(v)
-      Axlsx::validate_marker_symbol(v)
-      @marker_symbol = v
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-        # needs to override the super color here to push in ln/and something else!
-        if color
-          str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
-          str << '</a:solidFill>'
-          str << '<a:ln><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
-          str << '</c:spPr>'
-          str << '<c:marker>'
-          str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
-          str << '</a:solidFill>'
-          str << '<a:ln><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
-          str << '</c:spPr>'
-          str << marker_symbol_xml
-          str << '</c:marker>'
-        else
-          str << "<c:marker>#{marker_symbol_xml}</c:marker>"
-        end
-
-        if ln_width
-          str << '<c:spPr>'
-          str << '<a:ln w="' << ln_width.to_s << '"/>'
-          str << '</c:spPr>'
-        end
-        @xData.to_xml_string(str) unless @xData.nil?
-        @yData.to_xml_string(str) unless @yData.nil?
-        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
-      end
-      str
-    end
-
-    private
-
-    def marker_symbol_xml
-      if !@show_marker
-        '<c:symbol val="none"/>'
-      elsif @marker_symbol != :default
-        '<c:symbol val="' + @marker_symbol.to_s + '"/>'
-      end.to_s
-    end
-  end
-end
+module Axlsx
+  # A ScatterSeries defines the x and y position of data in the chart
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see examples/example.rb
+  class ScatterSeries < Series
+    # The x data for this series.
+    # @return [NamedAxisData]
+    attr_reader :xData
+
+    # The y data for this series.
+    # @return [NamedAxisData]
+    attr_reader :yData
+
+    # The fill color for this series.
+    # Red, green, and blue is expressed as sequence of hex digits, RRGGBB. A perceptual gamma of 2.2 is used.
+    # @return [String]
+    attr_reader :color
+
+    # @return [String]
+    attr_reader :ln_width
+
+    # Line smoothing between data points
+    # @return [Boolean]
+    attr_reader :smooth
+
+    # Line markers presence
+    # @return [Boolean]
+    attr_reader :show_marker
+
+    # custom marker symbol
+    # @return [String]
+    attr_reader :marker_symbol
+
+    # Creates a new ScatterSeries
+    def initialize(chart, options = {})
+      @xData, @yData = nil
+      if options[:smooth].nil?
+        # If caller hasn't specified smoothing or not, turn smoothing on or off based on scatter style
+        @smooth = [:smooth, :smoothMarker].include?(chart.scatter_style)
+      else
+        # Set smoothing according to the option provided
+        Axlsx::validate_boolean(options[:smooth])
+        @smooth = options[:smooth]
+      end
+      @ln_width = options[:ln_width] unless options[:ln_width].nil?
+      @show_marker = [:lineMarker, :marker, :smoothMarker].include?(chart.scatter_style)
+      @marker_symbol = :default
+
+      super(chart, options)
+      @xData = AxDataSource.new(:tag_name => :xVal, :data => options[:xData]) unless options[:xData].nil?
+      @yData = NumDataSource.new({ :tag_name => :yVal, :data => options[:yData] }) unless options[:yData].nil?
+    end
+
+    # @see color
+    def color=(v)
+      @color = v
+    end
+
+    # @see smooth
+    def smooth=(v)
+      Axlsx::validate_boolean(v)
+      @smooth = v
+    end
+
+    # @see ln_width
+    def ln_width=(v)
+      @ln_width = v
+    end
+
+    # @see marker_symbol
+    def marker_symbol=(v)
+      Axlsx::validate_marker_symbol(v)
+      @marker_symbol = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        # needs to override the super color here to push in ln/and something else!
+        if color
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '<a:ln><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
+          str << '</c:spPr>'
+          str << '<c:marker>'
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '<a:ln><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
+          str << '</c:spPr>'
+          str << marker_symbol_xml
+          str << '</c:marker>'
+        else
+          str << "<c:marker>#{marker_symbol_xml}</c:marker>"
+        end
+
+        if ln_width
+          str << '<c:spPr>'
+          str << '<a:ln w="' << ln_width.to_s << '"/>'
+          str << '</c:spPr>'
+        end
+        @xData.to_xml_string(str) unless @xData.nil?
+        @yData.to_xml_string(str) unless @yData.nil?
+        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
+      end
+      str
+    end
+
+    private
+
+    def marker_symbol_xml
+      if !@show_marker
+        '<c:symbol val="none"/>'
+      elsif @marker_symbol != :default
+        '<c:symbol val="' + @marker_symbol.to_s + '"/>'
+      end.to_s
+    end
+  end
+end

data/lib/axlsx/drawing/ser_axis.rb

@@ -1,45 +1,41 @@
-# encoding: UTF-8
-module Axlsx
-  #A SerAxis object defines a series axis
-  class SerAxis < Axis
-
-    # The number of tick lables to skip between labels
-    # @return [Integer]
-    attr_reader :tick_lbl_skip
-    alias :tickLblSkip :tick_lbl_skip
-
-    # The number of tickmarks to be skipped before the next one is rendered.
-    # @return [Boolean]
-    attr_reader :tick_mark_skip
-    alias :tickMarkSkip :tick_mark_skip
-
-    # Creates a new SerAxis object
-    # @option options [Integer] tick_lbl_skip
-    # @option options [Integer] tick_mark_skip
-    def initialize(options={})
-      @tick_lbl_skip, @tick_mark_skip = 1, 1
-      super(options)
-    end
-
-    # @see tickLblSkip
-    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
-    alias :tickLblSkip= :tick_lbl_skip=
-
-    # @see tickMarkSkip
-    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
-    alias :tickMarkSkip= :tick_mark_skip=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:serAx>'
-      super(str)
-      str << ('<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>') unless @tick_lbl_skip.nil?
-      str << ('<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>') unless @tick_mark_skip.nil?
-      str << '</c:serAx>'
-    end
-  end
-
-
-end
+module Axlsx
+  # A SerAxis object defines a series axis
+  class SerAxis < Axis
+    # The number of tick lables to skip between labels
+    # @return [Integer]
+    attr_reader :tick_lbl_skip
+    alias :tickLblSkip :tick_lbl_skip
+
+    # The number of tickmarks to be skipped before the next one is rendered.
+    # @return [Boolean]
+    attr_reader :tick_mark_skip
+    alias :tickMarkSkip :tick_mark_skip
+
+    # Creates a new SerAxis object
+    # @option options [Integer] tick_lbl_skip
+    # @option options [Integer] tick_mark_skip
+    def initialize(options = {})
+      @tick_lbl_skip, @tick_mark_skip = 1, 1
+      super(options)
+    end
+
+    # @see tickLblSkip
+    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
+    alias :tickLblSkip= :tick_lbl_skip=
+
+    # @see tickMarkSkip
+    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
+    alias :tickMarkSkip= :tick_mark_skip=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:serAx>'
+      super(str)
+      str << ('<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>') unless @tick_lbl_skip.nil?
+      str << ('<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>') unless @tick_mark_skip.nil?
+      str << '</c:serAx>'
+    end
+  end
+end

data/lib/axlsx/drawing/series.rb

@@ -1,69 +1,67 @@
-# encoding: UTF-8
-module Axlsx
-  # A Series defines the common series attributes and is the super class for all concrete series types.
-  # @note The recommended way to manage series is to use Chart#add_series
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  class Series
-
-    include Axlsx::OptionsParser
-
-    # The chart that owns this series
-    # @return [Chart]
-    attr_reader :chart
-
-    # The title of the series
-    # @return [SeriesTitle]
-    attr_reader :title
-
-    # Creates a new series
-    # @param [Chart] chart
-    # @option options [Integer] order
-    # @option options [String] title
-    def initialize(chart, options={})
-      @order = nil
-      self.chart = chart
-      @chart.series << self
-      parse_options options
-    end
-
-    # The index of this series in the chart's series.
-    # @return [Integer]
-    def index
-      @chart.series.index(self)
-    end
-
-    # The order of this series in the chart's series. By default the order is the index of the series.
-    # @return [Integer]
-    def order
-      @order || index
-    end
-
-    # @see order
-    def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end
-
-    # @see title
-    def title=(v)
-      v = SeriesTitle.new(v) if v.is_a?(String) || v.is_a?(Cell)
-      DataTypeValidator.validate "#{self.class}.title", SeriesTitle, v
-      @title = v
-    end
-
-    private
-
-    # assigns the chart for this series
-    def chart=(v)  DataTypeValidator.validate "Series.chart", Chart, v; @chart = v; end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:ser>'
-      str << ('<c:idx val="' << index.to_s << '"/>')
-      str << ('<c:order val="' << (order || index).to_s << '"/>')
-      title.to_xml_string(str) unless title.nil?
-      yield if block_given?
-      str << '</c:ser>'
-    end
-  end
-end
+module Axlsx
+  # A Series defines the common series attributes and is the super class for all concrete series types.
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class Series
+    include Axlsx::OptionsParser
+
+    # The chart that owns this series
+    # @return [Chart]
+    attr_reader :chart
+
+    # The title of the series
+    # @return [SeriesTitle]
+    attr_reader :title
+
+    # Creates a new series
+    # @param [Chart] chart
+    # @option options [Integer] order
+    # @option options [String] title
+    def initialize(chart, options = {})
+      @order = nil
+      self.chart = chart
+      @chart.series << self
+      parse_options options
+    end
+
+    # The index of this series in the chart's series.
+    # @return [Integer]
+    def index
+      @chart.series.index(self)
+    end
+
+    # The order of this series in the chart's series. By default the order is the index of the series.
+    # @return [Integer]
+    def order
+      @order || index
+    end
+
+    # @see order
+    def order=(v) Axlsx::validate_unsigned_int(v); @order = v; end
+
+    # @see title
+    def title=(v)
+      v = SeriesTitle.new(v) if v.is_a?(String) || v.is_a?(Cell)
+      DataTypeValidator.validate "#{self.class}.title", SeriesTitle, v
+      @title = v
+    end
+
+    private
+
+    # assigns the chart for this series
+    def chart=(v) DataTypeValidator.validate "Series.chart", Chart, v; @chart = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:ser>'
+      str << ('<c:idx val="' << index.to_s << '"/>')
+      str << ('<c:order val="' << (order || index).to_s << '"/>')
+      title.to_xml_string(str) unless title.nil?
+      yield if block_given?
+      str << '</c:ser>'
+    end
+  end
+end

data/lib/axlsx/drawing/series_title.rb

@@ -1,25 +1,23 @@
-# encoding: UTF-8
-module Axlsx
-  # A series title is a Title with a slightly different serialization than chart titles.
-  class SeriesTitle < Title
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      clean_value = Axlsx::trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@text.to_s))
-
-      str << '<c:tx>'
-      str << '<c:strRef>'
-      str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
-      str << '<c:strCache>'
-      str << '<c:ptCount val="1"/>'
-      str << '<c:pt idx="0">'
-      str << ('<c:v>' << clean_value << '</c:v>')
-      str << '</c:pt>'
-      str << '</c:strCache>'
-      str << '</c:strRef>'
-      str << '</c:tx>'
-    end
-  end
-end
+module Axlsx
+  # A series title is a Title with a slightly different serialization than chart titles.
+  class SeriesTitle < Title
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      clean_value = Axlsx::trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@text.to_s))
+
+      str << '<c:tx>'
+      str << '<c:strRef>'
+      str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
+      str << '<c:strCache>'
+      str << '<c:ptCount val="1"/>'
+      str << '<c:pt idx="0">'
+      str << ('<c:v>' << clean_value << '</c:v>')
+      str << '</c:pt>'
+      str << '</c:strCache>'
+      str << '</c:strRef>'
+      str << '</c:tx>'
+    end
+  end
+end

data/lib/axlsx/drawing/str_data.rb

@@ -1,42 +1,37 @@
-# -*- coding: utf-8 -*-
-module Axlsx
-
-  #This specifies the last string data used for a chart. (e.g. strLit and strCache)
-  # This class is extended for NumData to include the formatCode attribute required for numLit and numCache
-  class StrData
-
-    include Axlsx::OptionsParser
-
-    # creates a new StrVal object
-    # @option options [Array] :data
-    # @option options [String] :tag_name
-    def initialize(options={})
-      @tag_prefix = :str
-      @type = StrVal
-      @pt = SimpleTypedList.new(@type)
-      parse_options options
-    end
-
-    # Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.
-    # @param [Array] values An array of cells or values.
-    def data=(values=[])
-      @tag_name = values.first.is_a?(Cell) ? :strCache : :strLit
-      values.each do |value|
-        v = value.is_a?(Cell) ? value.value : value
-        @pt << @type.new(:v => v)
-      end
-    end
-
-    # serialize the object
-    def to_xml_string(str = "")
-      str << ('<c:' << @tag_name.to_s << '>')
-      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
-      @pt.each_with_index do |value, index|
-        value.to_xml_string index, str
-      end
-      str << ('</c:' << @tag_name.to_s << '>')
-    end
-
-  end
-
-end
+module Axlsx
+  # This specifies the last string data used for a chart. (e.g. strLit and strCache)
+  # This class is extended for NumData to include the formatCode attribute required for numLit and numCache
+  class StrData
+    include Axlsx::OptionsParser
+
+    # creates a new StrVal object
+    # @option options [Array] :data
+    # @option options [String] :tag_name
+    def initialize(options = {})
+      @tag_prefix = :str
+      @type = StrVal
+      @pt = SimpleTypedList.new(@type)
+      parse_options options
+    end
+
+    # Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.
+    # @param [Array] values An array of cells or values.
+    def data=(values = [])
+      @tag_name = values.first.is_a?(Cell) ? :strCache : :strLit
+      values.each do |value|
+        v = value.is_a?(Cell) ? value.value : value
+        @pt << @type.new(:v => v)
+      end
+    end
+
+    # serialize the object
+    def to_xml_string(str = "")
+      str << ('<c:' << @tag_name.to_s << '>')
+      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
+      @pt.each_with_index do |value, index|
+        value.to_xml_string index, str
+      end
+      str << ('</c:' << @tag_name.to_s << '>')
+    end
+  end
+end