caxlsx 2.0.2 → 3.0.4

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -125,19 +125,19 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      super(str) do |str_inner|
-        str_inner << '<c:bar3DChart>'
-        str_inner << '<c:barDir val="' << bar_dir.to_s << '"/>'
-        str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
-        str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
-        @series.each { |ser| ser.to_xml_string(str_inner) }
-        @d_lbls.to_xml_string(str_inner) if @d_lbls
-        str_inner << '<c:gapWidth val="' << @gap_width.to_s << '"/>' unless @gap_width.nil?
-        str_inner << '<c:gapDepth val="' << @gap_depth.to_s << '"/>' unless @gap_depth.nil?
-        str_inner << '<c:shape val="' << @shape.to_s << '"/>' unless @shape.nil?
-        axes.to_xml_string(str_inner, :ids => true)
-        str_inner << '</c:bar3DChart>'
-        axes.to_xml_string(str_inner)
+      super(str) do
+        str << '<c:bar3DChart>'
+        str << ('<c:barDir val="' << bar_dir.to_s << '"/>')
+        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
+        str << ('<c:gapWidth val="' << @gap_width.to_s << '"/>') unless @gap_width.nil?
+        str << ('<c:gapDepth val="' << @gap_depth.to_s << '"/>') unless @gap_depth.nil?
+        str << ('<c:shape val="' << @shape.to_s << '"/>') unless @shape.nil?
+        axes.to_xml_string(str, :ids => true)
+        str << '</c:bar3DChart>'
+        axes.to_xml_string(str)
       end
     end
 

data/lib/axlsx/drawing/bar_chart.rb

@@ -0,0 +1,143 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The BarChart is a two dimentional barchart that you can add to your worksheet.
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see Package#serialize
+  # @see README for an example
+  class BarChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    def cat_axis
+      axes[:cat_axis]
+    end
+    alias :catAxis :cat_axis
+
+    # the value axis
+    # @return [ValAxis]
+    def val_axis
+      axes[:val_axis]
+    end
+    alias :valAxis :val_axis
+
+    # The direction of the bars in the chart
+    # must be one of [:bar, :col]
+    # @return [Symbol]
+    def bar_dir
+      @bar_dir ||= :bar
+    end
+    alias :barDir :bar_dir
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    attr_reader :gap_depth
+    alias :gapDepth :gap_depth
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    def gap_width
+      @gap_width ||= 150
+    end
+    alias :gapWidth :gap_width
+
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    def grouping
+      @grouping ||= :clustered
+    end
+
+    # The shape of the bars or columns
+    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
+    # @return [Symbol]
+    def shape
+      @shape ||= :box
+    end
+
+    # validation regex for gap amount percent
+    GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
+
+    # Creates a new bar chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Symbol] bar_dir
+    # @option options [Symbol] grouping
+    # @option options [String] gap_width
+    # @option options [String] gap_depth
+    # @option options [Symbol] shape
+    # @see Chart
+    def initialize(frame, options={})
+      @vary_colors = true
+      @gap_width, @gap_depth, @shape = nil, nil, nil
+      super(frame, options)
+      @series_type = BarSeries
+      @d_lbls = nil
+    end
+
+    # The direction of the bars in the chart
+    # must be one of [:bar, :col]
+    def bar_dir=(v)
+      RestrictionValidator.validate "BarChart.bar_dir", [:bar, :col], v
+      @bar_dir = v
+    end
+    alias :barDir= :bar_dir=
+
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    def grouping=(v)
+      RestrictionValidator.validate "BarChart.grouping", [:percentStacked, :clustered, :standard, :stacked], v
+      @grouping = v
+    end
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    def gap_width=(v)
+      RegexValidator.validate "BarChart.gap_width", GAP_AMOUNT_PERCENT, v
+      @gap_width=(v)
+    end
+    alias :gapWidth= :gap_width=
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    def gap_depth=(v)
+      RegexValidator.validate "BarChart.gap_didth", GAP_AMOUNT_PERCENT, v
+      @gap_depth=(v)
+    end
+    alias :gapDepth= :gap_depth=
+
+    # The shape of the bars or columns
+    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
+    def shape=(v)
+      RestrictionValidator.validate "BarChart.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
+        str << '<c:barChart>'
+        str << ('<c:barDir val="' << bar_dir.to_s << '"/>')
+        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
+        str << ('<c:gapWidth val="' << @gap_width.to_s << '"/>') unless @gap_width.nil?
+        str << ('<c:gapDepth val="' << @gap_depth.to_s << '"/>') unless @gap_depth.nil?
+        str << ('<c:shape val="' << @shape.to_s << '"/>') unless @shape.nil?
+        axes.to_xml_string(str, :ids => true)
+        str << '</c:barChart>'
+        axes.to_xml_string(str)
+      end
+    end
+
+    # A hash of axes used by this chart. Bar charts have a value and
+    # category axes specified via axes[:val_axes] and axes[:cat_axis]
+    # @return [Axes]
+    def axes
+     @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+    end
+  end
+end

data/lib/axlsx/drawing/bar_series.rb

@@ -15,9 +15,8 @@ module Axlsx
     # @return [Array, SimpleTypedList]
     attr_reader :labels
 
-    # The shabe of the bars or columns
-    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
-    # @return [Symbol]
+    # 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.
@@ -41,8 +40,7 @@ module Axlsx
     # @see colors
     def colors=(v) DataTypeValidator.validate "BarSeries.colors", [Array], v; @colors = v end
 
-    # The shabe of the bars or columns
-    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
+    # @see shape
     def shape=(v)
       RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
       @shape = v
@@ -52,20 +50,20 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      super(str) do |str_inner|
+      super(str) do
 
         colors.each_with_index do |c, index|
-          str_inner << '<c:dPt>'
-          str_inner << '<c:idx val="' << index.to_s << '"/>'
-          str_inner << '<c:spPr><a:solidFill>'
-          str_inner << '<a:srgbClr val="' << c << '"/>'
-          str_inner << '</a:solidFill></c:spPr></c:dPt>'
+          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_inner) unless @labels.nil?
-        @data.to_xml_string(str_inner) unless @data.nil?
+        @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_inner << '<c:shape val="' << shape.to_s << '"></c:shape>'
+        str << ('<c:shape val="' << shape.to_s << '"></c:shape>')
       end
     end
 

data/lib/axlsx/drawing/bubble_chart.rb

@@ -0,0 +1,59 @@
+# 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

data/lib/axlsx/drawing/bubble_series.rb

@@ -0,0 +1,63 @@
+# 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

data/lib/axlsx/drawing/cat_axis.rb

@@ -71,11 +71,11 @@ module Axlsx
     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: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
 

data/lib/axlsx/drawing/chart.rb

@@ -11,6 +11,7 @@ module Axlsx
     # @param [GraphicalFrame] frame The frame that holds this chart.
     # @option options [Cell, String] title
     # @option options [Boolean] show_legend
+    # @option options [Symbol] legend_position
     # @option options [Array|String|Cell] start_at The X, Y coordinates defining the top left corner of the chart.
     # @option options [Array|String|Cell] end_at The X, Y coordinates defining the bottom right corner of the chart.
     def initialize(frame, options={})
@@ -20,9 +21,11 @@ module Axlsx
       @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
       @series = SimpleTypedList.new Series
       @show_legend = true
+      @legend_position = :r
       @display_blanks_as = :gap
       @series_type = Series
       @title = Title.new
+      @bg_color = nil
       parse_options options
       start_at(*options[:start_at]) if options[:start_at]
       end_at(*options[:end_at]) if options[:end_at]
@@ -53,7 +56,7 @@ module Axlsx
     # Indicates that colors should be varied by datum
     # @return [Boolean]
     attr_reader :vary_colors
- 
+
     # Configures the vary_colors options for this chart
     # @param [Boolean] v The value to set
     def vary_colors=(v) Axlsx::validate_boolean(v); @vary_colors = v; end
@@ -71,6 +74,17 @@ module Axlsx
     # @return [Boolean]
     attr_reader :show_legend
 
+    # Set the location of the chart's legend
+    # @return [Symbol] The position of this legend
+    # @note
+    #  The following are allowed
+    #    :b
+    #    :l
+    #    :r
+    #    :t
+    #    :tr
+    attr_reader :legend_position
+
     # How to display blank values
     # Options are
     # * gap:  Display nothing
@@ -80,6 +94,10 @@ module Axlsx
     # Default :gap (although this really should vary by chart type and grouping)
     attr_reader :display_blanks_as
 
+    # Background color for the chart
+    # @return [String]
+    attr_reader :bg_color
+
     # The relationship object for this chart.
     # @return [Relationship]
     def relationship
@@ -110,6 +128,13 @@ module Axlsx
       end
     end
 
+    # The size of the Title object of the chart.
+    # @param [String] v The size for the title object
+    # @see Title
+    def title_size=(v)
+      @title.text_size = v unless v.to_s.empty?
+    end
+
     # Show the legend in the chart
     # @param [Boolean] v
     # @return [Boolean]
@@ -126,6 +151,9 @@ module Axlsx
     # @param [Integer] v must be between 1 and 48
     def style=(v) DataTypeValidator.validate "Chart.style", Integer, v, lambda { |arg| arg >= 1 && arg <= 48 }; @style = v; end
 
+    # @see legend_position
+    def legend_position=(v) RestrictionValidator.validate "Chart.legend_position", [:b, :l, :r, :t, :tr], v; @legend_position = v; end
+
     # backwards compatibility to allow chart.to and chart.from access to anchor markers
     # @note This will be disconinued in version 2.0.0. Please use the end_at method
     def to
@@ -146,36 +174,52 @@ module Axlsx
       @series.last
     end
 
+    # Assigns a background color to chart area
+    def bg_color=(v)
+      DataTypeValidator.validate(:color, Color, Color.new(:rgb => v))
+      @bg_color = v
+    end
+
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << '<c:chartSpace xmlns:c="' << XML_NS_C << '" xmlns:a="' << XML_NS_A << '" xmlns:r="' << XML_NS_R << '">'
-      str << '<c:date1904 val="' << Axlsx::Workbook.date1904.to_s << '"/>'
-      str << '<c:style val="' << style.to_s << '"/>'
+      str << ('<c:chartSpace xmlns:c="' << XML_NS_C << '" xmlns:a="' << XML_NS_A << '" xmlns:r="' << XML_NS_R << '">')
+      str << ('<c:date1904 val="' << Axlsx::Workbook.date1904.to_s << '"/>')
+      str << ('<c:style val="' << style.to_s << '"/>')
       str << '<c:chart>'
       @title.to_xml_string str
-      str << '<c:autoTitleDeleted val="' << (@title == nil).to_s << '"/>'
+      str << ('<c:autoTitleDeleted val="' << (@title == nil).to_s << '"/>')
       @view_3D.to_xml_string(str) if @view_3D
       str << '<c:floor><c:thickness val="0"/></c:floor>'
       str << '<c:sideWall><c:thickness val="0"/></c:sideWall>'
       str << '<c:backWall><c:thickness val="0"/></c:backWall>'
       str << '<c:plotArea>'
       str << '<c:layout/>'
-      yield str if block_given?
+      yield if block_given?
       str << '</c:plotArea>'
       if @show_legend
         str << '<c:legend>'
-        str << '<c:legendPos val="r"/>'
+        str << ('<c:legendPos val="' << @legend_position.to_s << '"/>')
         str << '<c:layout/>'
         str << '<c:overlay val="0"/>'
         str << '</c:legend>'
       end
       str << '<c:plotVisOnly val="1"/>'
-      str << '<c:dispBlanksAs val="' << display_blanks_as.to_s << '"/>'
+      str << ('<c:dispBlanksAs val="' << display_blanks_as.to_s << '"/>')
       str << '<c:showDLblsOverMax val="1"/>'
       str << '</c:chart>'
+      if bg_color
+        str << '<c:spPr>'
+        str << '<a:solidFill>'
+        str << '<a:srgbClr val="' << bg_color << '"/>'
+        str << '</a:solidFill>'
+        str << '<a:ln>'
+        str << '<a:noFill/>'
+        str << '</a:ln>'
+        str << '</c:spPr>'
+      end
       str << '<c:printSettings>'
       str << '<c:headerFooter/>'
       str << '<c:pageMargins b="1.0" l="0.75" r="0.75" t="1.0" header="0.5" footer="0.5"/>'