caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/drawing/area_chart.rb

@@ -1,99 +1,96 @@
-# encoding: UTF-8
-module Axlsx
-
-  # The AreaChart is a two dimentional line chart (who would have guessed?) that you can add to your worksheet.
-  # @example Creating a chart
-  #   # This example creates a line in a single sheet.
-  #   require "rubygems" # if that is your preferred way to manage gems!
-  #   require "axlsx"
-  #
-  #   p = Axlsx::Package.new
-  #   ws = p.workbook.add_worksheet
-  #   ws.add_row ["This is a chart with no data in the sheet"]
-  #
-  #   chart = ws.add_chart(Axlsx::AreaChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
-  #   chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
-  #
-  # @see Worksheet#add_chart
-  # @see Worksheet#add_row
-  # @see Chart#add_series
-  # @see Series
-  # @see Package#serialize
-  class AreaChart < Chart
-
-    # the category axis
-    # @return [CatAxis]
-    def cat_axis
-      axes[:cat_axis]
-    end
-    alias :catAxis :cat_axis
-
-    # the category axis
-    # @return [ValAxis]
-    def val_axis
-      axes[:val_axis]
-    end
-    alias :valAxis :val_axis
-
-     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
-    # @return [Symbol]
-    attr_reader :grouping
-
-    # Creates a new line chart object
-    # @param [GraphicFrame] frame The workbook that owns this chart.
-    # @option options [Cell, String] title
-    # @option options [Boolean] show_legend
-    # @option options [Symbol] grouping
-    # @see Chart
-    def initialize(frame, options={})
-      @vary_colors = false
-      @grouping = :standard
-      super(frame, options)
-      @series_type = AreaSeries
-      @d_lbls = nil
-    end
-
-    # @see grouping
-    def grouping=(v)
-      RestrictionValidator.validate "AreaChart.grouping", [:percentStacked, :standard, :stacked], v
-      @grouping = v
-    end
-
-    # The node name to use in serialization. As AreaChart is used as the
-    # base class for Liine3DChart we need to be sure to serialize the
-    # chart based on the actual class type and not a fixed node name.
-    # @return [String]
-    def node_name
-      path = self.class.to_s
-      if i = path.rindex('::')
-        path = path[(i+2)..-1]
-      end
-      path[0] = path[0].chr.downcase
-      path
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do
-        str << ("<c:" << node_name << ">")
-        str << ('<c:grouping val="' << grouping.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
-        yield if block_given?
-        axes.to_xml_string(str, :ids => true)
-        str << ("</c:" << node_name << ">")
-        axes.to_xml_string(str)
-      end
-    end
-
-    # The axes for this chart. AreaCharts have a category and value
-    # axis.
-    # @return [Axes]
-    def axes
-      @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
-    end
-  end
-end
+module Axlsx
+  # The AreaChart is a two dimentional line chart (who would have guessed?) that you can add to your worksheet.
+  # @example Creating a chart
+  #   # This example creates a line in a single sheet.
+  #   require "rubygems" # if that is your preferred way to manage gems!
+  #   require "axlsx"
+  #
+  #   p = Axlsx::Package.new
+  #   ws = p.workbook.add_worksheet
+  #   ws.add_row ["This is a chart with no data in the sheet"]
+  #
+  #   chart = ws.add_chart(Axlsx::AreaChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
+  #   chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
+  #
+  # @see Worksheet#add_chart
+  # @see Worksheet#add_row
+  # @see Chart#add_series
+  # @see Series
+  # @see Package#serialize
+  class AreaChart < Chart
+    # the category axis
+    # @return [CatAxis]
+    def cat_axis
+      axes[:cat_axis]
+    end
+    alias :catAxis :cat_axis
+
+    # the category axis
+    # @return [ValAxis]
+    def val_axis
+      axes[:val_axis]
+    end
+    alias :valAxis :val_axis
+
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_reader :grouping
+
+    # Creates a new line chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Symbol] grouping
+    # @see Chart
+    def initialize(frame, options = {})
+      @vary_colors = false
+      @grouping = :standard
+      super(frame, options)
+      @series_type = AreaSeries
+      @d_lbls = nil
+    end
+
+    # @see grouping
+    def grouping=(v)
+      RestrictionValidator.validate "AreaChart.grouping", [:percentStacked, :standard, :stacked], v
+      @grouping = v
+    end
+
+    # The node name to use in serialization. As AreaChart is used as the
+    # base class for Liine3DChart we need to be sure to serialize the
+    # chart based on the actual class type and not a fixed node name.
+    # @return [String]
+    def node_name
+      path = self.class.to_s
+      if i = path.rindex('::')
+        path = path[(i + 2)..-1]
+      end
+      path[0] = path[0].chr.downcase
+      path
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << ("<c:" << node_name << ">")
+        str << ('<c:grouping val="' << grouping.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
+        yield if block_given?
+        axes.to_xml_string(str, :ids => true)
+        str << ("</c:" << node_name << ">")
+        axes.to_xml_string(str)
+      end
+    end
+
+    # The axes for this chart. AreaCharts have a category and value
+    # axis.
+    # @return [Axes]
+    def axes
+      @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+    end
+  end
+end

data/lib/axlsx/drawing/area_series.rb

@@ -1,110 +1,107 @@
-# encoding: UTF-8
-module Axlsx
-  # A AreaSeries 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 AreaSeries < 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 AreaSeries 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 AreaSeries < 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/ax_data_source.rb

@@ -1,26 +1,21 @@
-module Axlsx
-
-  # An axis data source that can contain referenced or literal strings or numbers
-  # @note only string data types are supported - mainly because we have not implemented a chart type that requires a numerical axis value
-  class AxDataSource < NumDataSource
-
-    # 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={})
-      @tag_name = :cat
-      @data_type = StrData
-      @ref_tag_name = :strRef
-      super(options)
-    end
-
-    # allowed element tag names for serialization
-    # @return [Array]
-    def self.allowed_tag_names
-      [:xVal, :cat]
-    end
-
-  end
-
-end
-
+module Axlsx
+  # An axis data source that can contain referenced or literal strings or numbers
+  # @note only string data types are supported - mainly because we have not implemented a chart type that requires a numerical axis value
+  class AxDataSource < NumDataSource
+    # 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 = {})
+      @tag_name = :cat
+      @data_type = StrData
+      @ref_tag_name = :strRef
+      super(options)
+    end
+
+    # allowed element tag names for serialization
+    # @return [Array]
+    def self.allowed_tag_names
+      [:xVal, :cat]
+    end
+  end
+end

data/lib/axlsx/drawing/axes.rb

@@ -1,61 +1,60 @@
-module Axlsx
-  
-  # The Axes class creates and manages axis information and
-  # serialization for charts.
-  class Axes
-
-    # @param [Hash] options options used to generate axis each key
-    # should be an axis name like :val_axis and its value should be the
-    # class of the axis type to construct. The :cat_axis, if there is one,
-    # must come first (we assume a Ruby 1.9+ Hash or an OrderedHash).
-    def initialize(options={})
-      raise(ArgumentError, "CatAxis must come first") if options.keys.include?(:cat_axis) && options.keys.first != :cat_axis
-      options.each do |name, axis_class|
-        add_axis(name, axis_class)
-      end
-    end
-
-    # [] provides assiciative access to a specic axis store in an axes
-    # instance. 
-    # @return [Axis]
-    def [](name)
-      axes.assoc(name)[1]
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @param [Hash] options
-    # @option options ids
-    # If the ids option is specified only the axis identifier is
-    # serialized. Otherwise, each axis is serialized in full. 
-    def to_xml_string(str = '', options = {})
-      if options[:ids]
-        # CatAxis must come first in the XML (for Microsoft Excel at least)
-        sorted = axes.sort_by { |name, axis| axis.kind_of?(CatAxis) ? 0 : 1 }
-        sorted.each { |axis| str << ('<c:axId val="' << axis[1].id.to_s << '"/>') }        
-      else
-        axes.each { |axis| axis[1].to_xml_string(str) }
-      end
-    end
-
-    # Adds an axis to the collection
-    # @param [Symbol] name The name of the axis
-    # @param [Axis] axis_class The axis class to generate
-    def add_axis(name, axis_class)
-      axis = axis_class.new
-      set_cross_axis(axis)
-      axes << [name, axis]
-    end
-
-    private
-
-    def axes
-      @axes ||= []
-    end
-
-    def set_cross_axis(axis)
-      axes.first[1].cross_axis = axis if axes.size == 1
-      axis.cross_axis = axes.first[1] unless axes.empty?
-    end
-  end
-end
+module Axlsx
+  # The Axes class creates and manages axis information and
+  # serialization for charts.
+  class Axes
+    # @param [Hash] options options used to generate axis each key
+    # should be an axis name like :val_axis and its value should be the
+    # class of the axis type to construct. The :cat_axis, if there is one,
+    # must come first (we assume a Ruby 1.9+ Hash or an OrderedHash).
+    def initialize(options = {})
+      raise(ArgumentError, "CatAxis must come first") if options.keys.include?(:cat_axis) && options.keys.first != :cat_axis
+
+      options.each do |name, axis_class|
+        add_axis(name, axis_class)
+      end
+    end
+
+    # [] provides assiciative access to a specic axis store in an axes
+    # instance.
+    # @return [Axis]
+    def [](name)
+      axes.assoc(name)[1]
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @param [Hash] options
+    # @option options ids
+    # If the ids option is specified only the axis identifier is
+    # serialized. Otherwise, each axis is serialized in full.
+    def to_xml_string(str = '', options = {})
+      if options[:ids]
+        # CatAxis must come first in the XML (for Microsoft Excel at least)
+        sorted = axes.sort_by { |name, axis| axis.kind_of?(CatAxis) ? 0 : 1 }
+        sorted.each { |axis| str << ('<c:axId val="' << axis[1].id.to_s << '"/>') }
+      else
+        axes.each { |axis| axis[1].to_xml_string(str) }
+      end
+    end
+
+    # Adds an axis to the collection
+    # @param [Symbol] name The name of the axis
+    # @param [Axis] axis_class The axis class to generate
+    def add_axis(name, axis_class)
+      axis = axis_class.new
+      set_cross_axis(axis)
+      axes << [name, axis]
+    end
+
+    private
+
+    def axes
+      @axes ||= []
+    end
+
+    def set_cross_axis(axis)
+      axes.first[1].cross_axis = axis if axes.size == 1
+      axis.cross_axis = axes.first[1] unless axes.empty?
+    end
+  end
+end