axlsx 1.0.4 → 1.0.5

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -0,0 +1,93 @@
+module Axlsx
+
+  # The Line3DChart is a three 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 :values => ["This is a chart with no data in the sheet"]
+  #
+  #   chart = ws.add_chart(Axlsx::Line3DChart, :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 Line3DChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    attr_reader :catAxis
+
+    # the category axis
+    # @return [ValAxis]
+    attr_reader :valAxis
+
+    # the category axis
+    # @return [Axis]
+    attr_reader :serAxis
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    attr_accessor :gapDepth
+
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_accessor :grouping
+
+    # 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 line chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Symbol] grouping
+    # @option options [String] gapDepth
+    def initialize(frame, options={})
+      @grouping = :standard
+      @catAxId = rand(8 ** 8)
+      @valAxId = rand(8 ** 8)
+      @serAxId = rand(8 ** 8)
+      @catAxis = CatAxis.new(@catAxId, @valAxId)
+      @valAxis = ValAxis.new(@valAxId, @catAxId)
+      @serAxis = SerAxis.new(@serAxId, @valAxId)
+      @view3D = View3D.new(:perspective=>30)
+      super(frame, options)      
+      @series_type = LineSeries
+    end
+
+    def grouping=(v)
+      RestrictionValidator.validate "Bar3DChart.grouping", [:percentStacked, :standard, :stacked], v
+      @grouping = v
+    end
+
+    def gapDepth=(v)
+      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
+      @gapDepth=(v)
+    end
+
+    # Serializes the bar chart
+    # @return [String]
+    def to_xml
+      super() do |xml|
+        xml.send('c:line3DChart') {
+          xml.send('c:grouping', :val=>grouping)
+          xml.send('c:varyColors', :val=>1)
+          @series.each { |ser| ser.to_xml(xml) }
+          xml.send('c:gapDepth', :val=>@gapDepth) unless @gapDepth.nil?
+          xml.send('c:axId', :val=>@catAxId)
+          xml.send('c:axId', :val=>@valAxId)
+          xml.send('c:axId', :val=>@serAxId)
+        }
+        @catAxis.to_xml(xml)
+        @valAxis.to_xml(xml)
+        @serAxis.to_xml(xml)
+      end
+    end    
+  end  
+end

data/lib/axlsx/drawing/line_3D_chart.rb~

@@ -0,0 +1,138 @@
+module Axlsx
+
+  # The Line3DChart is a three dimentional barchart (who would have guessed?) that you can add to your worksheet.
+  # @example Creating a chart
+  #   # This example creates two charts in a single sheet.
+  #   # The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.
+  #
+  #   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 :values => ["This is a chart with no data in the sheet"]
+  #
+  #   chart = ws.add_chart(Axlsx::Line3DChart, :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"]
+  # 
+  #   ws.add_row :values => ["This chart uses the data below"]
+  #   title_row = ws.add_row :values => ["Least Popular Pets"]
+  #   label_row = ws.add_row :values => ["", "Dry Skinned Reptiles", "Bald Cats", "Violent Parrots"]
+  #   data_row = ws.add_row :values => ["Votes", 6, 4, 1]
+  #   
+  #   chart = ws.add_chart(Axlsx::Pie3DChart, :start_at => [0,11], :end_at =>[0,16], :title => title_row.cells.last)
+  #   chart.add_series :data => data_row.cells[(1..-1)], :labels => label_row.cells  
+  #
+  #   f = File.open('example_pie_3d_chart.xlsx', 'w')
+  #   p.serialize(f)
+  #
+  # @see Worksheet#add_chart
+  # @see Worksheet#add_row
+  # @see Chart#add_series
+  # @see Series
+  # @see Package#serialize
+  class Bar3DChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    attr_reader :catAxis
+
+    # the category axis
+    # @return [ValAxis]
+    attr_reader :valAxis
+
+    # The direction of the bars in the chart
+    # must be one of [:bar, :col]
+    # @return [Symbol]
+    attr_accessor :barDir
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    attr_accessor :gapDepth
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    attr_accessor :gapWidth
+
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_accessor :grouping
+
+    # The shabe of the bars or columns
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_accessor :shape
+
+    # 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] barDir
+    # @option options [Symbol] grouping
+    # @option options [String] gapWidth
+    # @option options [String] gapDepth
+    # @option options [Symbol] shape
+    def initialize(frame, options={})
+      super(frame, options)      
+      @series_type = BarSeries
+      @barDir = :bar
+      @grouping = :clustered
+      @catAxId = rand(8 ** 8)
+      @valAxId = rand(8 ** 8)
+      @catAxis = CatAxis.new(@catAxId, @valAxId)
+      @valAxis = ValAxis.new(@valAxId, @catAxId)
+      @view3D = View3D.new(:rAngAx=>1)
+    end
+    
+    def barDir=(v) 
+      RestrictionValidator.validate "Bar3DChart.barDir", [:bar, :col], v
+      @barDir = v
+    end
+
+
+    def grouping=(v)
+      RestrictionValidator.validate "Bar3DChart.grouping", [:percentStacked, :clustered, :standard, :stacked], v
+      @grouping = v
+    end
+
+    def gapWidth=(v)
+      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
+      @gapWidth=(v)
+    end
+
+    def gapDepth=(v)
+      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
+      @gapDepth=(v)
+    end
+
+    def shape=(v) 
+      RestrictionValidator.validate "Bar3DChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
+      @shape = v
+    end
+    
+    # Serializes the bar chart
+    # @return [String]
+    def to_xml
+      super() do |xml|
+        xml.send('c:bar3DChart') {
+          xml.send('c:barDir', :val => barDir)
+          xml.send('c:grouping', :val=>grouping)
+          xml.send('c:varyColors', :val=>1)
+          @series.each { |ser| ser.to_xml(xml) }
+          xml.send('c:gapWidth', :val=>@gapWidth) unless @gapWidth.nil?
+          xml.send('c:gapDepth', :val=>@gapDepth) unless @gapDepth.nil?
+          xml.send('c:shape', :val=>@shape) unless @shape.nil?
+          xml.send('c:axId', :val=>@catAxId)
+          xml.send('c:axId', :val=>@valAxId)
+          xml.send('c:axId', :val=>0)
+        }
+        @catAxis.to_xml(xml)
+        @valAxis.to_xml(xml)        
+      end
+    end    
+  end  
+end

data/lib/axlsx/drawing/line_series.rb

@@ -0,0 +1,76 @@
+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 [Array, SimpleTypedList]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [Array, SimpleTypedList]
+    attr_reader :labels
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @param [Chart] chart
+    def initialize(chart, options={})
+      super(chart, options)
+      self.data = options[:data]  || []
+      self.labels = options[:labels] || []
+    end 
+
+    # Serializes the series
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      super(xml) do |xml|
+        if !labels.empty?
+          xml.send('c:cat') {
+            xml.send('c:strRef') {
+              xml.send('c:f', Axlsx::cell_range(labels))
+              xml.send('c:strCache') {
+                xml.send('c:ptCount', :val=>labels.size)
+                labels.each_with_index do |cell, index|
+                  v = cell.is_a?(Cell) ? cell.value : cell
+                  xml.send('c:pt', :idx=>index) {
+                    xml.send('c:v', v)
+                  }                          
+                end
+              }
+            }
+          }
+        end
+        xml.send('c:val') {
+          xml.send('c:numRef') {
+            xml.send('c:f', Axlsx::cell_range(data))
+            xml.send('c:numCache') {
+              xml.send('c:formatCode', 'General')
+              xml.send('c:ptCount', :val=>data.size)
+              data.each_with_index do |cell, index|
+                v = cell.is_a?(Cell) ? cell.value : cell
+                xml.send('c:pt', :idx=>index) {
+                  xml.send('c:v', v) 
+                }
+              end
+            }                        
+          }
+        }
+      end      
+    end
+   
+    private 
+
+
+    # assigns the data for this series
+    def data=(v) DataTypeValidator.validate "Series.data", [Array, SimpleTypedList], v; @data = v; end
+
+    # assigns the labels for this series
+    def labels=(v) DataTypeValidator.validate "Series.labels", [Array, SimpleTypedList], v; @labels = v; end
+
+  end
+
+end

data/lib/axlsx/drawing/line_series.rb~

@@ -0,0 +1,91 @@
+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 [Array, SimpleTypedList]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [Array, SimpleTypedList]
+    attr_reader :labels
+
+    # The shabe of the bars or columns
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_accessor :shape
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @option options [String] title
+    # @option options [String] shape
+    # @param [Chart] chart
+    def initialize(chart, options={})
+      @shape = :box
+      super(chart, options)
+      self.data = options[:data]  || []
+      self.labels = options[:labels] || []
+    end 
+
+    def shape=(v) 
+      RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
+      @shape = v
+    end
+
+    # Serializes the series
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      super(xml) do |xml|
+        if !labels.empty?
+          xml.send('c:cat') {
+            xml.send('c:strRef') {
+              xml.send('c:f', Axlsx::cell_range(labels))
+              xml.send('c:strCache') {
+                xml.send('c:ptCount', :val=>labels.size)
+                labels.each_with_index do |cell, index|
+                  v = cell.is_a?(Cell) ? cell.value : cell
+                  xml.send('c:pt', :idx=>index) {
+                    xml.send('c:v', v)
+                  }                          
+                end
+              }
+            }
+          }
+        end
+        xml.send('c:val') {
+          xml.send('c:numRef') {
+            xml.send('c:f', Axlsx::cell_range(data))
+            xml.send('c:numCache') {
+              xml.send('c:formatCode', 'General')
+              xml.send('c:ptCount', :val=>data.size)
+              data.each_with_index do |cell, index|
+                v = cell.is_a?(Cell) ? cell.value : cell
+                xml.send('c:pt', :idx=>index) {
+                  xml.send('c:v', v) 
+                }
+              end
+            }                        
+          }
+        }
+      end      
+    end
+
+    
+    private 
+
+
+    # assigns the data for this series
+    def data=(v) DataTypeValidator.validate "Series.data", [Array, SimpleTypedList], v; @data = v; end
+
+    # assigns the labels for this series
+    def labels=(v) DataTypeValidator.validate "Series.labels", [Array, SimpleTypedList], v; @labels = v; end
+
+  end
+
+end

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -39,8 +39,8 @@ module Axlsx
     # @param [Workbook] workbook The workbook that owns this chart.
     # @option options [Cell, String] title
     def initialize(workbook, options={})
-      super(workbook, options)
       # this charts series type
+      super(workbook, options)
       @series_type = PieSeries
       @view3D = View3D.new(:rotX => 30, :perspective => 30)
     end

data/lib/axlsx/drawing/ser_axis.rb

@@ -0,0 +1,42 @@
+module Axlsx
+  #A SarAxis object defines a series axis
+  class SerAxis < Axis
+
+    # @return [Boolean]
+    attr_accessor :tickLblSkip
+
+    # @return [Boolean]
+    attr_accessor :tickMarkSkip
+
+    # Creates a new SerAxis object
+    # @param [Integer] axId the id of this axis
+    # @param [Integer] crossAx the id of the perpendicular axis
+    # @option options [Symbol] axPos
+    # @option options [Symbol] tickLblPos
+    # @option options [Symbol] crosses
+    # @option options [Boolean] tickLblSkip
+    # @option options [Symbol] tickMarkSkip
+    def initialize(axId, crossAx, options={})
+      super(axId, crossAx, options)
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end 
+
+    def tickLblSkip=(v) Axlsx::validate_boolean(v); @tickLblSkip = v; end
+    def tickMarkSkip=(v) Axlsx::validate_boolean(v); @tickMarkSkip = v; end
+
+    # Serializes the series axis
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.send('c:serAx') {
+        super(xml)
+        xml.send('c:tickLblSkip', :val=>@tickLblSkip) unless @tickLblSkip.nil?
+        xml.send('c:tickMarkSkip', :val=>@tickMarkSkip) unless @tickMarkSkip.nil?
+      }
+    end
+  end
+  
+
+end