axlsx 1.0.11 → 1.0.12

data/lib/axlsx/drawing/drawing.rb

@@ -1,137 +0,0 @@
-module Axlsx
-  require 'axlsx/drawing/title.rb'
-  require 'axlsx/drawing/series_title.rb'
-  require 'axlsx/drawing/series.rb'
-  require 'axlsx/drawing/pie_series.rb'
-  require 'axlsx/drawing/bar_series.rb'  
-  require 'axlsx/drawing/line_series.rb'  
-
-  require 'axlsx/drawing/scaling.rb'
-  require 'axlsx/drawing/axis.rb'
-  require 'axlsx/drawing/ser_axis.rb'
-  require 'axlsx/drawing/cat_axis.rb'
-  require 'axlsx/drawing/val_axis.rb'
-
-  require 'axlsx/drawing/cat_axis_data.rb'
-  require 'axlsx/drawing/val_axis_data.rb'
-
-  require 'axlsx/drawing/marker.rb'
- 
-  require 'axlsx/drawing/one_cell_anchor.rb'
-  require 'axlsx/drawing/two_cell_anchor.rb'
-  require 'axlsx/drawing/graphic_frame.rb'
-
-  require 'axlsx/drawing/view_3D.rb'
-  require 'axlsx/drawing/chart.rb'
-  require 'axlsx/drawing/pie_3D_chart.rb'
-  require 'axlsx/drawing/bar_3D_chart.rb'
-  require 'axlsx/drawing/line_3D_chart.rb'
-
-  require 'axlsx/drawing/picture_locking.rb'
-  require 'axlsx/drawing/pic.rb'
-
-  # A Drawing is a canvas for charts. Each worksheet has a single drawing that manages anchors.
-  # The anchors reference the charts via graphical frames. This is not a trivial relationship so please do follow the advice in the note.
-  # @note The recommended way to manage drawings is to use the Worksheet.add_chart method.
-  # @see Worksheet#add_chart
-  # @see Chart
-  # see README for an example of how to create a chart.
-  class Drawing
-
-    # The worksheet that owns the drawing
-    # @return [Worksheet]
-    attr_reader :worksheet
-   
-    # A collection of anchors for this drawing
-    # only TwoCellAnchors are supported in this version
-    # @return [SimpleTypedList]
-    attr_reader :anchors
-
-    # Creates a new Drawing object
-    # @param [Worksheet] worksheet The worksheet that owns this drawing
-    def initialize(worksheet)
-      DataTypeValidator.validate "Drawing.worksheet", Worksheet, worksheet
-      @worksheet = worksheet
-      @worksheet.workbook.drawings << self
-      @anchors = SimpleTypedList.new [TwoCellAnchor, OneCellAnchor]
-    end
-
-    # Adds an image to the chart
-    # @note The recommended way to manage images is to use Worksheet.add_image. Please refer to that method for documentation.
-    # @see Worksheet#add_image
-    def add_image(options={})
-      OneCellAnchor.new(self, options)
-      @anchors.last.object
-    end
-
-    # Adds a chart to the drawing.
-    # @note The recommended way to manage charts is to use Worksheet.add_chart. Please refer to that method for documentation.
-    # @see Worksheet#add_chart
-    def add_chart(chart_type, options={})
-      TwoCellAnchor.new(self, options)
-      @anchors.last.add_chart(chart_type, options)
-    end
-
-    # An array of charts that are associated with this drawing's anchors
-    # @return [Array]
-    def charts
-      charts = @anchors.select { |a| a.object.is_a?(GraphicFrame) }
-      charts.map { |a| a.object.chart }
-    end
-
-    # An array of image objects that are associated with this drawing's anchors
-    # @return [Array]
-    def images
-      images = @anchors.select { |a| a.object.is_a?(Pic) }
-      images.map { |a| a.object }
-    end
-
-    # The index of this drawing in the owning workbooks's drawings collection.
-    # @return [Integer]
-    def index
-      @worksheet.workbook.drawings.index(self)
-    end
-
-    # The relation reference id for this drawing
-    # @return [String]
-    def rId
-      "rId#{index+1}"
-    end
-
-    # The part name for this drawing
-    # @return [String]
-    def pn
-      "#{DRAWING_PN % (index+1)}"
-    end
-
-    # The relational part name for this drawing
-    # @return [String]
-    def rels_pn
-      "#{DRAWING_RELS_PN % (index+1)}"
-    end
-
-    # The drawing's relationships.
-    # @return [Relationships]
-    def relationships
-      r = Relationships.new
-      charts.each do |chart|
-        r << Relationship.new(CHART_R, "../#{chart.pn}")
-      end
-      images.each do |image|
-        r << Relationship.new(IMAGE_R, "../#{image.pn}")
-      end
-      r
-    end
-
-    # Serializes the drawing
-    # @return [String]
-    def to_xml
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.send('xdr:wsDr', :'xmlns:xdr'=>XML_NS_XDR, :'xmlns:a'=>XML_NS_A) {
-          anchors.each {|anchor| anchor.to_xml(xml) }
-        }        
-      end
-      builder.to_xml
-    end
-  end
-end

data/lib/axlsx/drawing/graphic_frame.rb

@@ -1,52 +0,0 @@
-module Axlsx
-  # A graphic frame defines a container for a chart object
-  # @note The recommended way to manage charts is Worksheet#add_chart
-  # @see Worksheet#add_chart
-  class GraphicFrame
-
-    # A reference to the chart object associated with this frame
-    # @return [Chart]
-    attr_reader :chart
-
-    # A anchor that holds this frame
-    # @return [TwoCellAnchor]
-    attr_reader :anchor
-
-    # Creates a new GraphicFrame object
-    # @param [TwoCellAnchor] anchor
-    # @param [Class] chart_type
-    def initialize(anchor, chart_type, options)
-      DataTypeValidator.validate "Drawing.chart_type", Chart, chart_type 
-      @anchor = anchor
-      @chart = chart_type.new(self, options)
-    end
-
-    # The relationship id for this graphic
-    # @return [String]
-    def rId 
-      "rId#{@anchor.index+1}"
-    end
-
-    # Serializes the graphic frame
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    # @return [String]
-    def to_xml(xml)
-      xml.send('xdr:graphicFrame') {        
-        xml.send('xdr:nvGraphicFramePr') {
-          xml.send('xdr:cNvPr', :id=>2, :name=>chart.title)
-          xml.send('xdr:cNvGraphicFramePr')                
-        }
-        xml.send('xdr:xfrm') {
-          xml.send('a:off', :x=>0, :y=>0)
-          xml.send('a:ext', :cx=>0, :cy=>0)
-        }
-        xml.send('a:graphic') {
-          xml.send('a:graphicData', :uri=>XML_NS_C) {
-            xml.send('c:chart', :'xmlns:c'=>XML_NS_C, :'xmlns:r'=>XML_NS_R, :'r:id'=>rId)
-          }
-        }
-      }
-      
-    end
-  end
-end

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -1,106 +0,0 @@
-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_reader :gapDepth
-
-    #grouping for a column, line, or area chart.
-    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
-    # @return [Symbol]
-    attr_reader :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 [Cell, String] title
-    # @option options [Boolean] show_legend    
-    # @option options [Symbol] grouping
-    # @option options [String] gapDepth
-    # @option options [Integer] rotX
-    # @option options [String] hPercent
-    # @option options [Integer] rotY
-    # @option options [String] depthPercent
-    # @option options [Boolean] rAngAx
-    # @option options [Integer] perspective
-    # @see Chart
-    # @see View3D
-    def initialize(frame, options={})
-      @gapDepth = nil
-      @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)
-      super(frame, options)      
-      @series_type = LineSeries
-      @view3D = View3D.new({:perspective=>30}.merge(options))
-    end
-
-    # @see grouping
-    def grouping=(v)
-      RestrictionValidator.validate "Bar3DChart.grouping", [:percentStacked, :standard, :stacked], v
-      @grouping = v
-    end
-
-    # @see gapDepth
-    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_series.rb

@@ -1,46 +0,0 @@
-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 [ValAxisData]
-    attr_reader :data
-
-    # The labels for this series.
-    # @return [CatAxisData]
-    attr_reader :labels
-
-    # Creates a new series
-    # @option options [Array, SimpleTypedList] data
-    # @option options [Array, SimpleTypedList] labels
-    # @param [Chart] chart
-    def initialize(chart, options={})
-      @labels, @data = nil, nil
-      super(chart, options)
-      @labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
-      @data = ValAxisData.new(options[:data]) unless options[:data].nil?
-    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_inner|
-        @labels.to_xml(xml_inner) unless @labels.nil?
-        @data.to_xml(xml_inner) unless @data.nil?
-      end      
-    end
-
-    private 
-
-    # assigns the data for this series
-    def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end
-
-    # assigns the labels for this series
-    def labels=(v) DataTypeValidator.validate "Series.labels", [SimpleTypedList], v; @labels = v; end
-
-  end
-end

data/lib/axlsx/drawing/marker.rb

@@ -1,61 +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_reader :col
-
-    # The offset distance from this marker's column
-    # @return [Integer]
-    attr_reader :colOff
-
-    # The row this marker anchors to
-    # @return [Integer]
-    attr_reader :row
-
-    # The offset distance from this marker's row
-    # @return [Integer]
-    attr_reader :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
-    
-    # @see col
-    def col=(v) Axlsx::validate_unsigned_int v; @col = v end
-    # @see colOff
-    def colOff=(v) Axlsx::validate_int v; @colOff = v end
-    # @see row
-    def row=(v) Axlsx::validate_unsigned_int v; @row = v end
-    # @see rowOff
-    def rowOff=(v) Axlsx::validate_int v; @rowOff = v end
-    
-    # shortcut to set the column, row position for this marker
-    # @param col the column for the marker
-    # @param row the row of the marker
-    def coord(col, row)
-      self.col = col
-      self.row = row
-    end
-    # Serializes the marker
-    # @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/one_cell_anchor.rb

@@ -1,89 +0,0 @@
-module Axlsx
-  # This class details a single cell anchor for drawings.
-  # @note The recommended way to manage drawings, images and charts is Worksheet#add_chart or Worksheet#add_image.
-  # @see Worksheet#add_chart
-  # @see Worksheet#add_image
-  class OneCellAnchor
-
-    # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
-    # @return [Marker]
-    attr_reader :from
-
-    # The object this anchor hosts
-    # @return [Pic]
-    attr_reader :object
-
-    # The drawing that holds this anchor
-    # @return [Drawing]
-    attr_reader :drawing
-
-    # the width of the graphic object in pixels.
-    # this is converted to EMU at a 92 ppi resolution
-    # @return [Integer]
-    attr_reader :width
-
-    # the height of the graphic object in pixels
-    # this is converted to EMU at a 92 ppi resolution
-    # @return [Integer]
-    attr_reader :height
-
-
-    # Creates a new OneCellAnchor object and an Pic associated with it.
-    # @param [Drawing] drawing
-    # @option options [Array] start_at the col, row to start at
-    # @option options [Integer] width
-    # @option options [Integer] height    
-    # @option options [String] image_src the file location of the image you will render
-    # @option options [String] name the name attribute for the rendered image
-    # @option options [String] descr the description of the image rendered    
-    def initialize(drawing, options={})
-      @drawing = drawing
-      @width = 0
-      @height = 0
-      drawing.anchors << self      
-      @from = Marker.new
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      @object = Pic.new(self, options)
-    end
-
-    # @see height
-    def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end
-
-    # @see width
-    def width=(v) Axlsx::validate_unsigned_int(v); @width = v; end
-
-    # The index of this anchor in the drawing
-    # @return [Integer]
-    def index
-      @drawing.anchors.index(self)
-    end
-
-    # Serializes the anchor
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    # @return [String]
-    def to_xml(xml)
-      xml.send('xdr:oneCellAnchor') {
-        xml.send('xdr:from') {
-          from.to_xml(xml)
-        }
-        xml.send('xdr:ext', ext)
-        @object.to_xml(xml)
-        xml.send('xdr:clientData')
-      }
-    end    
-
-    private
-
-    # converts the pixel width and height to EMU units and returns a hash of 
-    # !{:cx=>[Integer], :cy=>[Integer]
-    # @return [Hash]
-    def ext
-      cy = @height * 914400 / 96
-      cx = @width * 914400 / 96
-      {:cy=>cy, :cx=>cx}
-    end
-
-  end
-end