axlsx 1.0.7 → 1.0.8

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

@@ -1,138 +0,0 @@
-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~

@@ -1,91 +0,0 @@
-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/marker.rb~

@@ -1,50 +0,0 @@
-module Axlsx
-  # The Marker class defines a point in the worksheet that drawing anchors attach to.
-  # @note The recommended way to manage markers is Worksheet#add_chart Markers are created for a two cell anchor based on the :start and :end options.
-  # @see Worksheet#add_chart
-  class Marker
-
-    # The column this marker anchors to
-    # @return [Integer]
-    attr_accessor :col
-
-    # The offset distance from this marker's column
-    # @return [Integer]
-    attr_accessor :colOff
-
-    # The row this marker anchors to
-    # @return [Integer]
-    attr_accessor :row
-
-    # The offset distance from this marker's row
-    # @return [Integer]
-    attr_accessor :rowOff
-
-    # Creates a new Marker object
-    # @option options [Integer] col
-    # @option options [Integer] colOff
-    # @option options [Integer] row
-    # @option options [Integer] rowOff
-    def initialize(options={})
-      @col, @colOff, @row, @rowOff = 0, 0, 0, 0
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-      end      
-    end
-    
-    def col=(v) Axlsx::validate_unsigned_int v; @col = v end
-    def colOff=(v) Axlsx::validate_int v; @colOff = v end
-    def row=(v) Axlsx::validate_unsigned_int v; @row = v end
-    def rowOff=(v) Axlsx::validate_int v; @rowOff = v end
-
-    # Serializes the gradientStop
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    # @return [String]
-    def to_xml(xml)
-      [:col, :colOff, :row, :rowOff].each do |k|
-        xml.send("xdr:#{k.to_s}", self.send(k))
-      end      
-    end
-  end
-
-end

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

@@ -1,132 +0,0 @@
-module Axlsx
-
-  # A Chart is the class that real classes (e.g. Pie3DChart) inherit from. When you actually create a chart, you will not be creating a new instance of this class, but an instance of a subclass that defines the behavour and serialization for the chart.
-  # @note Worksheet#add_chart is the recommended way to create charts for your worksheets.
-  class Chart
-
-    # The title object for the chart.
-    # @return [Title]
-    attr_reader :title
-
-    # A reference to the workbook that owns this chart
-    # @return [Workbook]
-    attr_reader :workbook
-
-    # A collection of series objects that are applied to the chart
-    # @return [SimpleTypedList]
-    attr_reader :series
-
-    # The relation referece id for this object.
-    # @return [String]
-    attr_reader :rId
-    
-    # The index of this chart in the workbooks charts collection
-    # @return [Integer]
-    attr_reader :index
-
-    # The part name for this chart
-    # @return [String]
-    attr_reader :pn
-
-   
-    # Creates a new chart object
-    # @param [Workbook] workbook The workbook that owns this chart.
-    # @option options [Cell, String] title
-    def initialize(workbook, options={})
-      @workbook=workbook
-      @workbook.charts << self
-      @title = Title.new options[:title]      
-      @series = SimpleTypedList.new Series
-    end
-    
-
-    def rId
-      "rId#{index+1}"
-    end
-
-    def index
-      @workbook.charts.index(self)
-    end
-
-    def pn
-      "#{CHART_PN % (index+1)}"
-    end
-
-    # Adds a new series to the chart's series collection.
-    # 
-    # @return [Series]
-    # @see Series
-    def add_series(options={})
-      Series.new(self, options)
-      @series.last
-    end
-
-    # @raise [StandardError] This method must be overridden in subclasses.
-    def to_xml
-      raise "This method must be overriden in subclasses."
-    end
-  end
-
-  # The Pie3DChart is a three dimentional piechart (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::Pie3DChart, :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 Pie3DChart < Chart
-
-    # Serializes the pie chart
-    # @return [String]
-    def to_xml
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.send('c:chartSpace',:'xmlns:c' => XML_NS_C,
-                 :'xmlns:a' => XML_NS_A) {
-          xml.send('c:chart') {
-            @title.to_xml(xml)            
-            xml.send('c:view3D') {
-              xml.send('c:rotX', :val=>30)
-              xml.send('c:perspective', :val=>30)
-            }
-            xml.send('c:plotArea') {
-              xml.send('c:layout')
-              xml.send('c:pie3DChart') {
-                xml.send('c:varyColors', :val=>1)
-                @series.each { |ser| ser.to_xml(xml) }
-              }              
-            }
-            xml.send('c:legend') {
-              xml.send('c:legendPos', :val => "r")
-              xml.send('c:layout')
-            }
-          }
-        }
-      end
-      builder.to_xml
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-module Axlsx
-  #A CatAxis object defines a chart category 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] auto
-    # @option options [Symbol] lblAlgn
-    # @option options [Integer] lblOffset    
-    def initialize(axId, crossAx, options={})
-      super(axId, crossAx, options)
-      self.auto = true
-      self.lblAlgn = :ctr
-      self.lblOffset = "100%"
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end 
-
-    def auto=(v) Axlsx::validate_boolean(v); @auto = v; end
-    def lblAlgn=(v) RestrictionValidator.validate "#{self.class}.lblAlgn", [:ctr, :l, :r], v; @lblAlgn = v; end
-    def lblOffset=(v) RegexValidator.validate "#{self.class}.lblOffset", LBL_OFFSET_REGEX, v; @lblOffset = v; end
-
-    # Serializes the category 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:catAx') {
-        super(xml)
-        xml.send('c:auto', :val=>@auto)
-        xml.send('c:lblAlgn', :val=>@lblAlgn)
-        xml.send('c:lblOffset', :val=>@lblOffset)                 
-      }
-    end
-  end
-  
-
-end