caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/drawing/bar_series.rb

@@ -1,97 +1,91 @@
-# encoding: UTF-8
-module Axlsx
-  # A BarSeries defines the title, data and labels for bar charts
-  # @note The recommended way to manage series is to use Chart#add_series
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  class BarSeries < Series
-
-
-    # The data for this series.
-    # @return [NumDataSource]
-    attr_reader :data
-
-    # The labels for this series.
-    # @return [Array, SimpleTypedList]
-    attr_reader :labels
-
-    # The shape of the bars or columns
-    # @return [Symbol] must be one of [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
-    attr_reader :shape
-
-    # An array of rgb colors to apply to your bar chart.
-    attr_reader :colors
-
-    # The fill color for this series.
-    # Red, green, and blue is expressed as sequence of hex digits, RRGGBB.
-    # @return [String]
-    attr_reader :series_color
-
-    # Creates a new series
-    # @option options [Array, SimpleTypedList] data
-    # @option options [Array, SimpleTypedList] labels
-    # @option options [String] title
-    # @option options [String] shape
-    # @option options [String] colors an array of colors to use when rendering each data point
-    # @option options [String] series_color a color to use when rendering series
-    # @param [Chart] chart
-    def initialize(chart, options={})
-      @shape = :box
-      @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
-
-    def series_color=(v)
-      @series_color = v
-    end
-
-    # @see shape
-    def shape=(v)
-      RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
-      @shape = v
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-
-        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
-
-        if series_color
-          str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << series_color << '"/>')
-          str << '</a:solidFill>'
-          str << '</c:spPr>'
-        end
-
-        @labels.to_xml_string(str) unless @labels.nil?
-        @data.to_xml_string(str) unless @data.nil?
-        # this is actually only required for shapes other than box
-        str << ('<c:shape val="' << shape.to_s << '"></c:shape>')
-      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 BarSeries defines the title, data and labels for bar charts
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class BarSeries < Series
+    # The data for this series.
+    # @return [NumDataSource]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [Array, SimpleTypedList]
+    attr_reader :labels
+
+    # The shape of the bars or columns
+    # @return [Symbol] must be one of [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
+    attr_reader :shape
+
+    # An array of rgb colors to apply to your bar chart.
+    attr_reader :colors
+
+    # The fill color for this series.
+    # Red, green, and blue is expressed as sequence of hex digits, RRGGBB.
+    # @return [String]
+    attr_reader :series_color
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @option options [String] title
+    # @option options [String] shape
+    # @option options [String] colors an array of colors to use when rendering each data point
+    # @option options [String] series_color a color to use when rendering series
+    # @param [Chart] chart
+    def initialize(chart, options = {})
+      @shape = :box
+      @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
+
+    def series_color=(v)
+      @series_color = v
+    end
+
+    # @see shape
+    def shape=(v)
+      RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
+      @shape = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        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
+
+        if series_color
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << series_color << '"/>')
+          str << '</a:solidFill>'
+          str << '</c:spPr>'
+        end
+
+        @labels.to_xml_string(str) unless @labels.nil?
+        @data.to_xml_string(str) unless @data.nil?
+        # this is actually only required for shapes other than box
+        str << ('<c:shape val="' << shape.to_s << '"></c:shape>')
+      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/bubble_chart.rb

@@ -1,59 +1,56 @@
-# encoding: UTF-8
-module Axlsx
-
-  # The BubbleChart allows you to insert a bubble chart into your worksheet
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  # @see README for an example
-  class BubbleChart < Chart
-
-    include Axlsx::OptionsParser
-
-    # 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 bubble chart
-    def initialize(frame, options={})
-      @vary_colors = 0
-
-           super(frame, options)
-      @series_type = BubbleSeries
-      @d_lbls = nil
-      parse_options options
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-        str << '<c:bubbleChart>'
-        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:bubbleChart>'
-        axes.to_xml_string(str)
-      end
-      str
-    end
-
-    # The axes for the bubble chart. BubbleChart 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
+module Axlsx
+  # The BubbleChart allows you to insert a bubble chart into your worksheet
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see README for an example
+  class BubbleChart < Chart
+    include Axlsx::OptionsParser
+
+    # 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 bubble chart
+    def initialize(frame, options = {})
+      @vary_colors = 0
+
+      super(frame, options)
+      @series_type = BubbleSeries
+      @d_lbls = nil
+      parse_options options
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << '<c:bubbleChart>'
+        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:bubbleChart>'
+        axes.to_xml_string(str)
+      end
+      str
+    end
+
+    # The axes for the bubble chart. BubbleChart 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/bubble_series.rb

@@ -1,63 +1,60 @@
-# encoding: UTF-8
-module Axlsx
-
-  # A BubbleSeries defines the x/y position and bubble size 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 BubbleSeries < Series
-
-    # The x data for this series.
-    # @return [AxDataSource]
-    attr_reader :xData
-
-    # The y data for this series.
-    # @return [NumDataSource]
-    attr_reader :yData
-
-    # The bubble size for this series.
-    # @return [NumDataSource]
-    attr_reader :bubbleSize
-
-    # 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
-
-    # Creates a new BubbleSeries
-    def initialize(chart, options={})
-      @xData, @yData, @bubbleSize = 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?
-      @bubbleSize = NumDataSource.new({:tag_name => :bubbleSize, :data => options[:bubbleSize]}) unless options[:bubbleSize].nil?
-    end
-
-    # @see color
-    def color=(v)
-      @color = 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>'
-        end
-        @xData.to_xml_string(str) unless @xData.nil?
-        @yData.to_xml_string(str) unless @yData.nil?
-        @bubbleSize.to_xml_string(str) unless @bubbleSize.nil?
-      end
-      str
-    end
-  end
-end
+module Axlsx
+  # A BubbleSeries defines the x/y position and bubble size 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 BubbleSeries < Series
+    # The x data for this series.
+    # @return [AxDataSource]
+    attr_reader :xData
+
+    # The y data for this series.
+    # @return [NumDataSource]
+    attr_reader :yData
+
+    # The bubble size for this series.
+    # @return [NumDataSource]
+    attr_reader :bubbleSize
+
+    # 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
+
+    # Creates a new BubbleSeries
+    def initialize(chart, options = {})
+      @xData, @yData, @bubbleSize = 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?
+      @bubbleSize = NumDataSource.new({ :tag_name => :bubbleSize, :data => options[:bubbleSize] }) unless options[:bubbleSize].nil?
+    end
+
+    # @see color
+    def color=(v)
+      @color = 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>'
+        end
+        @xData.to_xml_string(str) unless @xData.nil?
+        @yData.to_xml_string(str) unless @yData.nil?
+        @bubbleSize.to_xml_string(str) unless @bubbleSize.nil?
+      end
+      str
+    end
+  end
+end

data/lib/axlsx/drawing/cat_axis.rb

@@ -1,85 +1,80 @@
-# encoding: UTF-8
-module Axlsx
-  #A CatAxis object defines a chart category axis
-  class CatAxis < Axis
-
-    # Creates a new CatAxis object
-    # @option options [Integer] tick_lbl_skip
-    # @option options [Integer] tick_mark_skip
-    def initialize(options={})
-      @tick_lbl_skip = 1
-      @tick_mark_skip = 1
-      self.auto = 1
-      self.lbl_algn = :ctr
-      self.lbl_offset = "100"
-      super(options)
-    end
-
-    # From the docs: This element specifies that this axis is a date or text axis based on the data that is used for the axis labels, not a specific choice.
-    # @return [Boolean]
-    attr_reader :auto
-
-    # specifies how the perpendicular axis is crossed
-    # must be one of [:ctr, :l, :r]
-    # @return [Symbol]
-    attr_reader :lbl_algn
-    alias :lblAlgn :lbl_algn
-
-    # The offset of the labels
-    # must be between a string between 0 and 1000
-    # @return [Integer]
-    attr_reader :lbl_offset
-    alias :lblOffset :lbl_offset
-
-    # 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
-
-    # regex for validating label offset
-    LBL_OFFSET_REGEX = /0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)/
-
-    # @see tick_lbl_skip
-    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
-    alias :tickLblSkip= :tick_lbl_skip=
-
-    # @see tick_mark_skip
-    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
-    alias :tickMarkSkip= :tick_mark_skip=
-
-    # From the docs: This element specifies that this axis is a date or text axis based on the data that is used for the axis labels, not a specific choice.
-    def auto=(v) Axlsx::validate_boolean(v); @auto = v; end
-
-    # specifies how the perpendicular axis is crossed
-    # must be one of [:ctr, :l, :r]
-    def lbl_algn=(v) RestrictionValidator.validate "#{self.class}.lbl_algn", [:ctr, :l, :r], v; @lbl_algn = v; end
-    alias :lblAlgn= :lbl_algn=
-
-    # The offset of the labels
-    # must be between a string between 0 and 1000
-    def lbl_offset=(v) RegexValidator.validate "#{self.class}.lbl_offset", LBL_OFFSET_REGEX, v; @lbl_offset = v; end
-    alias :lblOffset= :lbl_offset=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:catAx>'
-      super(str)
-      str << ('<c:auto val="' << @auto.to_s << '"/>')
-      str << ('<c:lblAlgn val="' << @lbl_algn.to_s << '"/>')
-      str << ('<c:lblOffset val="' << @lbl_offset.to_i.to_s << '"/>')
-      str << ('<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>')
-      str << ('<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>')
-      str << '</c:catAx>'
-    end
-
-  end
-
-
-end
+module Axlsx
+  # A CatAxis object defines a chart category axis
+  class CatAxis < Axis
+    # Creates a new CatAxis object
+    # @option options [Integer] tick_lbl_skip
+    # @option options [Integer] tick_mark_skip
+    def initialize(options = {})
+      @tick_lbl_skip = 1
+      @tick_mark_skip = 1
+      self.auto = 1
+      self.lbl_algn = :ctr
+      self.lbl_offset = "100"
+      super(options)
+    end
+
+    # From the docs: This element specifies that this axis is a date or text axis based on the data that is used for the axis labels, not a specific choice.
+    # @return [Boolean]
+    attr_reader :auto
+
+    # specifies how the perpendicular axis is crossed
+    # must be one of [:ctr, :l, :r]
+    # @return [Symbol]
+    attr_reader :lbl_algn
+    alias :lblAlgn :lbl_algn
+
+    # The offset of the labels
+    # must be between a string between 0 and 1000
+    # @return [Integer]
+    attr_reader :lbl_offset
+    alias :lblOffset :lbl_offset
+
+    # 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
+
+    # regex for validating label offset
+    LBL_OFFSET_REGEX = /0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)/
+
+    # @see tick_lbl_skip
+    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
+    alias :tickLblSkip= :tick_lbl_skip=
+
+    # @see tick_mark_skip
+    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
+    alias :tickMarkSkip= :tick_mark_skip=
+
+    # From the docs: This element specifies that this axis is a date or text axis based on the data that is used for the axis labels, not a specific choice.
+    def auto=(v) Axlsx::validate_boolean(v); @auto = v; end
+
+    # specifies how the perpendicular axis is crossed
+    # must be one of [:ctr, :l, :r]
+    def lbl_algn=(v) RestrictionValidator.validate "#{self.class}.lbl_algn", [:ctr, :l, :r], v; @lbl_algn = v; end
+    alias :lblAlgn= :lbl_algn=
+
+    # The offset of the labels
+    # must be between a string between 0 and 1000
+    def lbl_offset=(v) RegexValidator.validate "#{self.class}.lbl_offset", LBL_OFFSET_REGEX, v; @lbl_offset = v; end
+    alias :lblOffset= :lbl_offset=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:catAx>'
+      super(str)
+      str << ('<c:auto val="' << @auto.to_s << '"/>')
+      str << ('<c:lblAlgn val="' << @lbl_algn.to_s << '"/>')
+      str << ('<c:lblOffset val="' << @lbl_offset.to_i.to_s << '"/>')
+      str << ('<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>')
+      str << ('<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>')
+      str << '</c:catAx>'
+    end
+  end
+end