caxlsx 3.1.1 → 3.2.0

data/lib/axlsx/drawing/pie_series.rb

@@ -1,74 +1,74 @@
-# encoding: UTF-8
-module Axlsx
-
-  # A PieSeries defines the data and labels and explosion for pie charts series.
-  # @note The recommended way to manage series is to use Chart#add_series
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  class PieSeries < Series
-
-    # The data for this series.
-    # @return [SimpleTypedList]
-    attr_reader :data
-
-    # The labels for this series.
-    # @return [SimpleTypedList]
-    attr_reader :labels
-
-    # The explosion for this series
-    # @return [Integert]
-    attr_reader :explosion
-
-    # An array of rgb colors to apply to your bar chart.
-    attr_reader :colors
-
-    # Creates a new series
-    # @option options [Array, SimpleTypedList] data
-    # @option options [Array, SimpleTypedList] labels
-    # @option options [String] title
-    # @option options [Integer] explosion
-    # @param [Chart] chart
-    def initialize(chart, options={})
-      @explosion = nil
-      @colors = []
-      super(chart, options)
-      self.labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
-      self.data = NumDataSource.new(options) unless options[:data].nil?
-    end
-
-    # @see colors
-    def colors=(v) DataTypeValidator.validate "BarSeries.colors", [Array], v; @colors = v end
-
-    # @see explosion
-    def explosion=(v) Axlsx::validate_unsigned_int(v); @explosion = v; end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-        str << '<c:explosion val="' + @explosion.to_s + '"/>' unless @explosion.nil?
-        colors.each_with_index do |c, index|
-          str << '<c:dPt>'
-          str << ('<c:idx val="' << index.to_s << '"/>')
-          str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << c << '"/>')
-          str << '</a:solidFill></c:spPr></c:dPt>'
-        end
-        @labels.to_xml_string str unless @labels.nil?
-        @data.to_xml_string str unless @data.nil?
-      end
-      str
-    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
+# encoding: UTF-8
+module Axlsx
+
+  # A PieSeries defines the data and labels and explosion for pie charts series.
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class PieSeries < Series
+
+    # The data for this series.
+    # @return [SimpleTypedList]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [SimpleTypedList]
+    attr_reader :labels
+
+    # The explosion for this series
+    # @return [Integert]
+    attr_reader :explosion
+
+    # An array of rgb colors to apply to your bar chart.
+    attr_reader :colors
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @option options [String] title
+    # @option options [Integer] explosion
+    # @param [Chart] chart
+    def initialize(chart, options={})
+      @explosion = nil
+      @colors = []
+      super(chart, options)
+      self.labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
+      self.data = NumDataSource.new(options) unless options[:data].nil?
+    end
+
+    # @see colors
+    def colors=(v) DataTypeValidator.validate "BarSeries.colors", [Array], v; @colors = v end
+
+    # @see explosion
+    def explosion=(v) Axlsx::validate_unsigned_int(v); @explosion = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << '<c:explosion val="' + @explosion.to_s + '"/>' unless @explosion.nil?
+        colors.each_with_index do |c, index|
+          str << '<c:dPt>'
+          str << ('<c:idx val="' << index.to_s << '"/>')
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << c << '"/>')
+          str << '</a:solidFill></c:spPr></c:dPt>'
+        end
+        @labels.to_xml_string str unless @labels.nil?
+        @data.to_xml_string str unless @data.nil?
+      end
+      str
+    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/scaling.rb

@@ -1,60 +1,60 @@
-# encoding: UTF-8
-module Axlsx
-  # The Scaling class defines axis scaling
-  class Scaling
-
-    include Axlsx::OptionsParser
-
-    # creates a new Scaling object
-    # @option options [Integer] logBase
-    # @option options [Symbol] orientation
-    # @option options [Float] max
-    # @option options [Float] min
-    def initialize(options={})
-      @orientation = :minMax
-      @logBase, @min, @max = nil, nil, nil
-      parse_options options
-    end
-
-    # logarithmic base for a logarithmic axis.
-    # must be between 2 and 1000
-    # @return [Integer]
-    attr_reader :logBase
-
-    # the orientation of the axis
-    # must be one of [:minMax, :maxMin]
-    # @return [Symbol]
-    attr_reader :orientation
-
-    # the maximum scaling
-    # @return [Float]
-    attr_reader :max
-
-    # the minimu scaling
-    # @return [Float]
-    attr_reader :min
-
-    # @see logBase
-    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer], v, lambda { |arg| arg >= 2 && arg <= 1000}; @logBase = v; end
-    # @see orientation
-    def orientation=(v) RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v; @orientation = v; end
-    # @see max
-    def max=(v) DataTypeValidator.validate "Scaling.max", Float, v; @max = v; end
-
-    # @see min
-    def min=(v) DataTypeValidator.validate "Scaling.min", Float, v; @min = v; end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:scaling>'
-      str << ('<c:logBase val="' << @logBase.to_s << '"/>') unless @logBase.nil?
-      str << ('<c:orientation val="' << @orientation.to_s << '"/>') unless @orientation.nil?
-      str << ('<c:min val="' << @min.to_s << '"/>') unless @min.nil?
-      str << ('<c:max val="' << @max.to_s << '"/>') unless @max.nil?
-      str << '</c:scaling>'
-    end
-
-  end
-end
+# encoding: UTF-8
+module Axlsx
+  # The Scaling class defines axis scaling
+  class Scaling
+
+    include Axlsx::OptionsParser
+
+    # creates a new Scaling object
+    # @option options [Integer] logBase
+    # @option options [Symbol] orientation
+    # @option options [Float] max
+    # @option options [Float] min
+    def initialize(options={})
+      @orientation = :minMax
+      @logBase, @min, @max = nil, nil, nil
+      parse_options options
+    end
+
+    # logarithmic base for a logarithmic axis.
+    # must be between 2 and 1000
+    # @return [Integer]
+    attr_reader :logBase
+
+    # the orientation of the axis
+    # must be one of [:minMax, :maxMin]
+    # @return [Symbol]
+    attr_reader :orientation
+
+    # the maximum scaling
+    # @return [Float]
+    attr_reader :max
+
+    # the minimu scaling
+    # @return [Float]
+    attr_reader :min
+
+    # @see logBase
+    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer], v, lambda { |arg| arg >= 2 && arg <= 1000}; @logBase = v; end
+    # @see orientation
+    def orientation=(v) RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v; @orientation = v; end
+    # @see max
+    def max=(v) DataTypeValidator.validate "Scaling.max", Float, v; @max = v; end
+
+    # @see min
+    def min=(v) DataTypeValidator.validate "Scaling.min", Float, v; @min = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:scaling>'
+      str << ('<c:logBase val="' << @logBase.to_s << '"/>') unless @logBase.nil?
+      str << ('<c:orientation val="' << @orientation.to_s << '"/>') unless @orientation.nil?
+      str << ('<c:min val="' << @min.to_s << '"/>') unless @min.nil?
+      str << ('<c:max val="' << @max.to_s << '"/>') unless @max.nil?
+      str << '</c:scaling>'
+    end
+
+  end
+end

data/lib/axlsx/drawing/scatter_chart.rb

@@ -1,74 +1,74 @@
-# encoding: UTF-8
-module Axlsx
-
-  # The ScatterChart allows you to insert a scatter chart into your worksheet
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  # @see README for an example
-  class ScatterChart < Chart
-
-    include Axlsx::OptionsParser
-
-    # The Style for the scatter chart
-    # must be one of :none | :line | :lineMarker | :marker | :smooth | :smoothMarker
-    # return [Symbol]
-    attr_reader :scatter_style
-    alias :scatterStyle :scatter_style
-
-    # the x value axis
-    # @return [ValAxis]
-    def x_val_axis
-      axes[:x_val_axis]
-    end
-    alias :xValAxis :x_val_axis
-
-    # the y value axis
-    # @return [ValAxis]
-    def y_val_axis
-      axes[:y_val_axis]
-    end
-    alias :yValAxis :y_val_axis
-
-    # Creates a new scatter chart
-    def initialize(frame, options={})
-      @vary_colors = 0
-      @scatter_style = :lineMarker
-
-           super(frame, options)
-      @series_type = ScatterSeries
-      @d_lbls = nil
-      parse_options options
-    end
-
-    # see #scatterStyle
-    def scatter_style=(v)
-      Axlsx.validate_scatter_style(v)
-      @scatter_style = v
-    end
-    alias :scatterStyle= :scatter_style=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-        str << '<c:scatterChart>'
-        str << ('<c:scatterStyle val="' << scatter_style.to_s << '"/>')
-        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
-        @series.each { |ser| ser.to_xml_string(str) }
-        d_lbls.to_xml_string(str) if @d_lbls
-        axes.to_xml_string(str, :ids => true)
-        str << '</c:scatterChart>'
-        axes.to_xml_string(str)
-      end
-      str
-    end
-
-    # The axes for the scatter chart. ScatterChart has an x_val_axis and
-    # a y_val_axis
-    # @return [Axes]
-    def axes
-      @axes ||= Axes.new(:x_val_axis => ValAxis, :y_val_axis => ValAxis)
-    end
-  end
-end
+# encoding: UTF-8
+module Axlsx
+
+  # The ScatterChart allows you to insert a scatter chart into your worksheet
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see README for an example
+  class ScatterChart < Chart
+
+    include Axlsx::OptionsParser
+
+    # The Style for the scatter chart
+    # must be one of :none | :line | :lineMarker | :marker | :smooth | :smoothMarker
+    # return [Symbol]
+    attr_reader :scatter_style
+    alias :scatterStyle :scatter_style
+
+    # the x value axis
+    # @return [ValAxis]
+    def x_val_axis
+      axes[:x_val_axis]
+    end
+    alias :xValAxis :x_val_axis
+
+    # the y value axis
+    # @return [ValAxis]
+    def y_val_axis
+      axes[:y_val_axis]
+    end
+    alias :yValAxis :y_val_axis
+
+    # Creates a new scatter chart
+    def initialize(frame, options={})
+      @vary_colors = 0
+      @scatter_style = :lineMarker
+
+           super(frame, options)
+      @series_type = ScatterSeries
+      @d_lbls = nil
+      parse_options options
+    end
+
+    # see #scatterStyle
+    def scatter_style=(v)
+      Axlsx.validate_scatter_style(v)
+      @scatter_style = v
+    end
+    alias :scatterStyle= :scatter_style=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << '<c:scatterChart>'
+        str << ('<c:scatterStyle val="' << scatter_style.to_s << '"/>')
+        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
+        @series.each { |ser| ser.to_xml_string(str) }
+        d_lbls.to_xml_string(str) if @d_lbls
+        axes.to_xml_string(str, :ids => true)
+        str << '</c:scatterChart>'
+        axes.to_xml_string(str)
+      end
+      str
+    end
+
+    # The axes for the scatter chart. ScatterChart has an x_val_axis and
+    # a y_val_axis
+    # @return [Axes]
+    def axes
+      @axes ||= Axes.new(:x_val_axis => ValAxis, :y_val_axis => ValAxis)
+    end
+  end
+end

data/lib/axlsx/drawing/scatter_series.rb

@@ -1,98 +1,129 @@
-# 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
-
-    # 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?
-      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
-
-    # 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 << '</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
-  end
-end
+# 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