caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/drawing/line_series.rb

@@ -1,110 +1,107 @@
-# encoding: UTF-8
-module Axlsx
-  # A LineSeries defines the title, data and labels for line charts
-  # @note The recommended way to manage series is to use Chart#add_series
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  class LineSeries < Series
-
-    # The data for this series.
-    # @return [ValAxisData]
-    attr_reader :data
-
-    # The labels for this series.
-    # @return [CatAxisData]
-    attr_reader :labels
-
-    # 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
-
-    # show markers on values
-    # @return [Boolean]
-    attr_reader :show_marker
-
-    # custom marker symbol
-    # @return [String]
-    attr_reader :marker_symbol
-
-    # line smoothing on values
-    # @return [Boolean]
-    attr_reader :smooth
-
-    # Creates a new series
-    # @option options [Array, SimpleTypedList] data
-    # @option options [Array, SimpleTypedList] labels
-    # @param [Chart] chart
-    def initialize(chart, options={})
-      @show_marker = false
-      @marker_symbol = options[:marker_symbol] ? options[:marker_symbol] : :default
-      @smooth = false
-      @labels, @data = nil, nil
-      super(chart, options)
-      @labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
-      @data = NumDataSource.new(options) unless options[:data].nil?
-    end
-
-    # @see color
-    def color=(v)
-      @color = v
-    end
-
-    # @see show_marker
-    def show_marker=(v)
-      Axlsx::validate_boolean(v)
-      @show_marker = v
-    end
-
-    # @see marker_symbol
-    def marker_symbol=(v)
-      Axlsx::validate_marker_symbol(v)
-      @marker_symbol = v
-    end
-
-    # @see smooth
-    def smooth=(v)
-      Axlsx::validate_boolean(v)
-      @smooth = v
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-        if color
-          str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
-          str << '</a:solidFill>'
-          str << '<a:ln w="28800">'
-          str << '<a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
-          str << '</a:solidFill>'
-          str << '</a:ln>'
-          str << '<a:round/>'
-          str << '</c:spPr>'
-        end
-
-        if !@show_marker
-          str << '<c:marker><c:symbol val="none"/></c:marker>'
-        elsif @marker_symbol != :default
-          str << '<c:marker><c:symbol val="' + @marker_symbol.to_s + '"/></c:marker>'
-        end
-
-        @labels.to_xml_string(str) unless @labels.nil?
-        @data.to_xml_string(str) unless @data.nil?
-        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
-      end
-    end
-
-    private
-
-    # assigns the data for this series
-    def data=(v) DataTypeValidator.validate "Series.data", [NumDataSource], v; @data = v; end
-
-    # assigns the labels for this series
-    def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
-
-  end
-end
+module Axlsx
+  # A LineSeries defines the title, data and labels for line charts
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class LineSeries < Series
+    # The data for this series.
+    # @return [ValAxisData]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [CatAxisData]
+    attr_reader :labels
+
+    # 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
+
+    # show markers on values
+    # @return [Boolean]
+    attr_reader :show_marker
+
+    # custom marker symbol
+    # @return [String]
+    attr_reader :marker_symbol
+
+    # line smoothing on values
+    # @return [Boolean]
+    attr_reader :smooth
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @param [Chart] chart
+    def initialize(chart, options = {})
+      @show_marker = false
+      @marker_symbol = options[:marker_symbol] ? options[:marker_symbol] : :default
+      @smooth = false
+      @labels, @data = nil, nil
+      super(chart, options)
+      @labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
+      @data = NumDataSource.new(options) unless options[:data].nil?
+    end
+
+    # @see color
+    def color=(v)
+      @color = v
+    end
+
+    # @see show_marker
+    def show_marker=(v)
+      Axlsx::validate_boolean(v)
+      @show_marker = v
+    end
+
+    # @see marker_symbol
+    def marker_symbol=(v)
+      Axlsx::validate_marker_symbol(v)
+      @marker_symbol = v
+    end
+
+    # @see smooth
+    def smooth=(v)
+      Axlsx::validate_boolean(v)
+      @smooth = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        if color
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '<a:ln w="28800">'
+          str << '<a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '</a:ln>'
+          str << '<a:round/>'
+          str << '</c:spPr>'
+        end
+
+        if !@show_marker
+          str << '<c:marker><c:symbol val="none"/></c:marker>'
+        elsif @marker_symbol != :default
+          str << '<c:marker><c:symbol val="' + @marker_symbol.to_s + '"/></c:marker>'
+        end
+
+        @labels.to_xml_string(str) unless @labels.nil?
+        @data.to_xml_string(str) unless @data.nil?
+        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
+      end
+    end
+
+    private
+
+    # assigns the data for this series
+    def data=(v) DataTypeValidator.validate "Series.data", [NumDataSource], v; @data = v; end
+
+    # assigns the labels for this series
+    def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
+  end
+end

data/lib/axlsx/drawing/marker.rb

@@ -1,84 +1,80 @@
-# encoding: UTF-8
-module Axlsx
-  # The Marker class defines a point in the worksheet that drawing anchors attach to.
-  # @note The recommended way to manage markers is Worksheet#add_chart Markers are created for a two cell anchor based on the :start and :end options.
-  # @see Worksheet#add_chart
-  class Marker
-
-    include Axlsx::OptionsParser
-
-    # Creates a new Marker object
-    # @option options [Integer] col
-    # @option options [Integer] colOff
-    # @option options [Integer] row
-    # @option options [Integer] rowOff
-    def initialize(options={})
-      @col, @colOff, @row, @rowOff = 0, 0, 0, 0
-      parse_options options
-    end
-
-    # The column this marker anchors to
-    # @return [Integer]
-    attr_reader :col
-
-    # The offset distance from this marker's column
-    # @return [Integer]
-    attr_reader :colOff
-
-    # The row this marker anchors to
-    # @return [Integer]
-    attr_reader :row
-
-    # The offset distance from this marker's row
-    # @return [Integer]
-    attr_reader :rowOff
-
-     # @see col
-    def col=(v) Axlsx::validate_unsigned_int v; @col = v end
-    # @see colOff
-    def colOff=(v) Axlsx::validate_int v; @colOff = v end
-    # @see row
-    def row=(v) Axlsx::validate_unsigned_int v; @row = v end
-    # @see rowOff
-    def rowOff=(v) Axlsx::validate_int v; @rowOff = v end
-
-    # shortcut to set the column, row position for this marker
-    # @param col the column for the marker, a Cell object or a string reference like "B7"
-    # or an Array.
-    # @param row the row of the marker. This is ignored if the col parameter is a Cell or
-    # String or Array.
-    def coord(col, row=0)
-      coordinates = parse_coord_args(col, row)
-      self.col = coordinates[0]
-      self.row = coordinates[1]
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      [:col, :colOff, :row, :rowOff].each do |k|
-        str << ('<xdr:' << k.to_s << '>' << self.send(k).to_s << '</xdr:' << k.to_s << '>')
-      end
-    end
-    private
-
-    # handles multiple inputs for setting the position of a marker
-    # @see Chart#start_at
-    def parse_coord_args(x, y=0)
-      if x.is_a?(String)
-        x, y = *Axlsx::name_to_indices(x)
-      end
-      if x.is_a?(Cell)
-        x, y = *x.pos
-      end
-      if x.is_a?(Array)
-        x, y = *x
-      end
-      [x, y]
-    end
-
-
-  end
-
-end
+module Axlsx
+  # The Marker class defines a point in the worksheet that drawing anchors attach to.
+  # @note The recommended way to manage markers is Worksheet#add_chart Markers are created for a two cell anchor based on the :start and :end options.
+  # @see Worksheet#add_chart
+  class Marker
+    include Axlsx::OptionsParser
+
+    # Creates a new Marker object
+    # @option options [Integer] col
+    # @option options [Integer] colOff
+    # @option options [Integer] row
+    # @option options [Integer] rowOff
+    def initialize(options = {})
+      @col, @colOff, @row, @rowOff = 0, 0, 0, 0
+      parse_options options
+    end
+
+    # The column this marker anchors to
+    # @return [Integer]
+    attr_reader :col
+
+    # The offset distance from this marker's column
+    # @return [Integer]
+    attr_reader :colOff
+
+    # The row this marker anchors to
+    # @return [Integer]
+    attr_reader :row
+
+    # The offset distance from this marker's row
+    # @return [Integer]
+    attr_reader :rowOff
+
+    # @see col
+    def col=(v) Axlsx::validate_unsigned_int v; @col = v end
+    # @see colOff
+    def colOff=(v) Axlsx::validate_int v; @colOff = v end
+    # @see row
+    def row=(v) Axlsx::validate_unsigned_int v; @row = v end
+    # @see rowOff
+    def rowOff=(v) Axlsx::validate_int v; @rowOff = v end
+
+    # shortcut to set the column, row position for this marker
+    # @param col the column for the marker, a Cell object or a string reference like "B7"
+    # or an Array.
+    # @param row the row of the marker. This is ignored if the col parameter is a Cell or
+    # String or Array.
+    def coord(col, row = 0)
+      coordinates = parse_coord_args(col, row)
+      self.col = coordinates[0]
+      self.row = coordinates[1]
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      [:col, :colOff, :row, :rowOff].each do |k|
+        str << ('<xdr:' << k.to_s << '>' << self.send(k).to_s << '</xdr:' << k.to_s << '>')
+      end
+    end
+
+    private
+
+    # handles multiple inputs for setting the position of a marker
+    # @see Chart#start_at
+    def parse_coord_args(x, y = 0)
+      if x.is_a?(String)
+        x, y = *Axlsx::name_to_indices(x)
+      end
+      if x.is_a?(Cell)
+        x, y = *x.pos
+      end
+      if x.is_a?(Array)
+        x, y = *x
+      end
+      [x, y]
+    end
+  end
+end

data/lib/axlsx/drawing/num_data.rb

@@ -1,52 +1,47 @@
-# -*- coding: utf-8 -*-
-module Axlsx
-
-  #This class specifies data for a particular data point. It is used for both numCache and numLit object
-  class NumData
-
-    include Axlsx::OptionsParser
-
-    # creates a new NumVal object
-    # @option options [String] formatCode
-    # @option options [Array] :data
-    # @see StrData
-    def initialize(options={})
-      @format_code = "General"
-      @pt = SimpleTypedList.new NumVal
-      parse_options options
-    end
-
-    # A string representing the format code to apply. For more information see see the SpreadsheetML numFmt element's (§18.8.30) formatCode attribute.
-    # @return [String]
-    attr_reader :format_code
-
-    # 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) ? :numCache : :numLit
-      values.each do |value|
-        value = value.is_formula? ? 0 : value.value if value.is_a?(Cell)
-        @pt << NumVal.new(:v => value)
-      end
-    end
-
-    # @see format_code
-    def format_code=(v='General')
-      Axlsx::validate_string(v)
-      @format_code = v
-    end
-
-    # serialize the object
-    def to_xml_string(str = "")
-      str << ('<c:' << @tag_name.to_s << '>')
-      str << ('<c:formatCode>' << format_code.to_s << '</c:formatCode>')
-      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
-      @pt.each_with_index do |num_val, index|
-        num_val.to_xml_string index, str
-      end
-      str << ('</c:' << @tag_name.to_s << '>')
-    end
-
-  end
-
-end
+module Axlsx
+  # This class specifies data for a particular data point. It is used for both numCache and numLit object
+  class NumData
+    include Axlsx::OptionsParser
+
+    # creates a new NumVal object
+    # @option options [String] formatCode
+    # @option options [Array] :data
+    # @see StrData
+    def initialize(options = {})
+      @format_code = "General"
+      @pt = SimpleTypedList.new NumVal
+      parse_options options
+    end
+
+    # A string representing the format code to apply. For more information see see the SpreadsheetML numFmt element's (§18.8.30) formatCode attribute.
+    # @return [String]
+    attr_reader :format_code
+
+    # 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) ? :numCache : :numLit
+      values.each do |value|
+        value = value.is_formula? ? 0 : value.value if value.is_a?(Cell)
+        @pt << NumVal.new(:v => value)
+      end
+    end
+
+    # @see format_code
+    def format_code=(v = 'General')
+      Axlsx::validate_string(v)
+      @format_code = v
+    end
+
+    # serialize the object
+    def to_xml_string(str = "")
+      str << ('<c:' << @tag_name.to_s << '>')
+      str << ('<c:formatCode>' << format_code.to_s << '</c:formatCode>')
+      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
+      @pt.each_with_index do |num_val, index|
+        num_val.to_xml_string index, str
+      end
+      str << ('</c:' << @tag_name.to_s << '>')
+    end
+  end
+end

data/lib/axlsx/drawing/num_data_source.rb

@@ -1,62 +1,58 @@
-module Axlsx
-
-  # A numeric data source for use by charts.
-  class NumDataSource
-
-    include Axlsx::OptionsParser
-
-    # creates a new NumDataSource object
-    # @option options [Array] data An array of Cells or Numeric objects
-    # @option options [Symbol] tag_name see tag_name
-    def initialize(options={})
-      # override these three in child classes
-      @data_type ||= NumData
-      @tag_name ||= :val
-      @ref_tag_name ||= :numRef
-
-      @f = nil
-      @data = @data_type.new(options)
-      if options[:data] && options[:data].first.is_a?(Cell)
-        @f = Axlsx::cell_range(options[:data])
-      end
-      parse_options options
-    end
-
-
-    # The tag name to use when serializing this data source.
-    # Only items defined in allowed_tag_names are allowed
-    # @return [Symbol]
-    attr_reader :tag_name
-
-    attr_reader :data
-
-    # allowed element tag names
-    # @return [Array]
-    def self.allowed_tag_names
-      [:yVal, :val, :bubbleSize]
-    end
-
-     # sets the tag name for this data source
-    # @param [Symbol] v One of the allowed_tag_names
-    def tag_name=(v)
-      Axlsx::RestrictionValidator.validate "#{self.class.name}.tag_name", self.class.allowed_tag_names, v
-      @tag_name = v
-    end
-
-    # serialize the object
-    # @param [String] str
-    def to_xml_string(str="")
-      str << ('<c:' << tag_name.to_s << '>')
-      if @f
-        str << ('<c:' << @ref_tag_name.to_s << '>')
-        str << ('<c:f>' << @f.to_s << '</c:f>')
-      end
-      @data.to_xml_string str
-      if @f
-        str << ('</c:' << @ref_tag_name.to_s << '>')
-      end
-      str << ('</c:' << tag_name.to_s << '>')
-    end
-  end
-end
-
+module Axlsx
+  # A numeric data source for use by charts.
+  class NumDataSource
+    include Axlsx::OptionsParser
+
+    # creates a new NumDataSource object
+    # @option options [Array] data An array of Cells or Numeric objects
+    # @option options [Symbol] tag_name see tag_name
+    def initialize(options = {})
+      # override these three in child classes
+      @data_type ||= NumData
+      @tag_name ||= :val
+      @ref_tag_name ||= :numRef
+
+      @f = nil
+      @data = @data_type.new(options)
+      if options[:data] && options[:data].first.is_a?(Cell)
+        @f = Axlsx::cell_range(options[:data])
+      end
+      parse_options options
+    end
+
+    # The tag name to use when serializing this data source.
+    # Only items defined in allowed_tag_names are allowed
+    # @return [Symbol]
+    attr_reader :tag_name
+
+    attr_reader :data
+
+    # allowed element tag names
+    # @return [Array]
+    def self.allowed_tag_names
+      [:yVal, :val, :bubbleSize]
+    end
+
+    # sets the tag name for this data source
+    # @param [Symbol] v One of the allowed_tag_names
+    def tag_name=(v)
+      Axlsx::RestrictionValidator.validate "#{self.class.name}.tag_name", self.class.allowed_tag_names, v
+      @tag_name = v
+    end
+
+    # serialize the object
+    # @param [String] str
+    def to_xml_string(str = "")
+      str << ('<c:' << tag_name.to_s << '>')
+      if @f
+        str << ('<c:' << @ref_tag_name.to_s << '>')
+        str << ('<c:f>' << @f.to_s << '</c:f>')
+      end
+      @data.to_xml_string str
+      if @f
+        str << ('</c:' << @ref_tag_name.to_s << '>')
+      end
+      str << ('</c:' << tag_name.to_s << '>')
+    end
+  end
+end