axlsx 1.0.11 → 1.0.12

data/lib/axlsx/drawing/pic.rb

@@ -1,153 +0,0 @@
-# -*- coding: utf-8 -*-
-module Axlsx
-  # a Pic object represents an image in your worksheet
-  # Worksheet#add_image is the recommended way to manage images in your sheets
-  # @see Worksheet#add_image
-  class Pic
-
-    # allowed file extenstions
-    ALLOWED_EXTENSIONS = ['gif', 'jpeg', 'png', 'jpg']
-
-    # The name to use for this picture
-    # @return [String]
-    attr_reader :name
-
-
-    # A description of the picture
-    # @return [String]
-    attr_reader :descr
-
-    # The path to the image you want to include
-    # Only local images are supported at this time and only jpg support
-    # @return [String]
-    attr_reader :image_src
-
-    # The anchor for this image
-    # @return [OneCellAnchor]
-    attr_reader :anchor
-
-    # The picture locking attributes for this picture
-    attr_reader :picture_locking
-   
-    # Creates a new Pic(ture) object
-    # @param [Anchor] anchor the anchor that holds this image
-    # @option options [String] name
-    # @option options [String] descr
-    # @option options [String] image_src
-    # @option options [Array] start_at
-    # @option options [Intger] width
-    # @option options [Intger] height
-    def initialize(anchor, options={})
-      @anchor = anchor
-      @anchor.drawing.worksheet.workbook.images << self
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      start_at(*options[:start_at]) if options[:start_at]
-      yield self if block_given?
-      @picture_locking = PictureLocking.new(options)
-    end
-    
-    def image_src=(v) 
-      Axlsx::validate_string(v)
-      RestrictionValidator.validate 'Pic.image_src', ALLOWED_EXTENSIONS, File.extname(v).delete('.')
-      raise ArgumentError, "File does not exist" unless File.exist?(v)
-      @image_src = v
-    end
-
-    # @see name
-    def name=(v) Axlsx::validate_string(v); @name = v; end
-
-    # @see descr
-    def descr=(v) Axlsx::validate_string(v); @descr = v; end
-
-
-    # The file name of image_src without any path information
-    # @return [String]
-    def file_name
-      File.basename(image_src) unless image_src.nil?
-    end    
-    
-    # returns the extension of image_src without the preceeding '.'
-    # @return [String]
-    def extname
-      File.extname(image_src).delete('.') unless image_src.nil?
-    end
-
-    # The index of this image in the workbooks images collections
-    # @return [Index]
-    def index
-      @anchor.drawing.worksheet.workbook.images.index(self)
-    end
-
-    # The part name for this image used in serialization and relationship building
-    # @return [String]
-    def pn
-      "#{IMAGE_PN % [(index+1), extname]}"
-    end
-
-    # providing access to the anchor's width attribute
-    # @param [Integer] v
-    # @see OneCellAnchor.width
-    def width
-      @anchor.width
-    end
-
-    # @see width
-    def width=(v)
-      @anchor.width = v
-    end
-    
-    # providing access to update the anchor's height attribute
-    # @param [Integer] v
-    # @see OneCellAnchor.width
-    def height
-      @anchor.height
-    end
-
-    # @see height
-    def height=(v)
-      @anchor.height = v
-    end
-
-    # This is a short cut method to set the start anchor position
-    # If you need finer granularity in positioning use
-    # graphic_frame.anchor.from.colOff / rowOff
-    # @param [Integer] x The column
-    # @param [Integer] y The row
-    # @return [Marker]
-    def start_at(x, y)
-      @anchor.from.col = x
-      @anchor.from.row = y
-    end
-
-    # Serializes the picture
-    # @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:pic') {
-        xml.send('xdr:nvPicPr') {
-          xml.send('xdr:cNvPr', :id=>"2", :name=>name, :descr=>descr)
-          xml.send('xdr:cNvPicPr') {
-            picture_locking.to_xml(xml)
-          }
-        }
-        xml.send('xdr:blipFill') {
-          xml.send('a:blip', :'xmlns:r' => XML_NS_R, :'r:embed'=>"rId1")
-          xml.send('a:stretch') {
-            xml.send('a:fillRect')
-          }
-        }
-        xml.send('xdr:spPr') {
-          xml.send('a:xfrm') {
-            xml.send('a:off', :x=>0, :y=>0)
-            xml.send('a:ext', :cx=>2336800, :cy=>2161540)
-          }
-          xml.send('a:prstGeom', :prst=>:rect) {
-            xml.send('a:avLst')
-          }
-        }
-      }
-    end
-  end
-end

data/lib/axlsx/drawing/picture_locking.rb

@@ -1,72 +0,0 @@
-module Axlsx
-  # The picture locking class defines the locking properties for pictures in your workbook. 
-  class PictureLocking
-    
-    
-    attr_reader :noGrp
-    attr_reader :noSelect
-    attr_reader :noRot
-    attr_reader :noChangeAspect
-    attr_reader :noMove
-    attr_reader :noResize
-    attr_reader :noEditPoints
-    attr_reader :noAdjustHandles
-    attr_reader :noChangeArrowheads
-    attr_reader :noChangeShapeType
-
-    # Creates a new PictureLocking object
-    # @option options [Boolean] noGrp
-    # @option options [Boolean] noSelect
-    # @option options [Boolean] noRot
-    # @option options [Boolean] noChangeAspect
-    # @option options [Boolean] noMove
-    # @option options [Boolean] noResize
-    # @option options [Boolean] noEditPoints
-    # @option options [Boolean] noAdjustHandles
-    # @option options [Boolean] noChangeArrowheads
-    # @option options [Boolean] noChangeShapeType
-    def initialize(options={})
-      @noChangeAspect = true
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end        
-
-    # @see noGrp
-    def noGrp=(v) Axlsx::validate_boolean v; @noGrp = v end    
-
-    # @see noSelect
-    def noSelect=(v) Axlsx::validate_boolean v; @noSelect = v end    
-
-    # @see noRot
-    def noRot=(v) Axlsx::validate_boolean v; @noRot = v end    
-
-    # @see noChangeAspect
-    def noChangeAspect=(v) Axlsx::validate_boolean v; @noChangeAspect = v end    
-
-    # @see noMove
-    def noMove=(v) Axlsx::validate_boolean v; @noMove = v end    
-
-    # @see noResize
-    def noResize=(v) Axlsx::validate_boolean v; @noResize = v end    
-
-    # @see noEditPoints
-    def noEditPoints=(v) Axlsx::validate_boolean v; @noEditPoints = v end    
-
-    # @see noAdjustHandles
-    def noAdjustHandles=(v) Axlsx::validate_boolean v; @noAdjustHandles = v end    
-
-    # @see noChangeArrowheads
-    def noChangeArrowheads=(v) Axlsx::validate_boolean v; @noChangeArrowheads = v end    
-
-    # @see noChangeShapeType
-    def noChangeShapeType=(v) Axlsx::validate_boolean v; @noChangeShapeType = v end    
-
-    # Serializes the picture locking
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    # @return [String]
-    def to_xml(xml)
-      xml[:a].picLocks(self.instance_values)      
-    end
-  end
-end

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -1,41 +0,0 @@
-module Axlsx
-
-
-  # The Pie3DChart is a three dimentional piechart (who would have guessed?) that you can add to your worksheet.
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  # @see README for an example
-  class Pie3DChart < Chart
-
-    # Creates a new pie 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={})
-      super(frame, options)
-      @series_type = PieSeries
-      @view3D = View3D.new({:rotX=>30, :perspective=>30}.merge(options))
-    end
-
-    # Serializes the pie chart
-    # @return [String]
-    def to_xml
-      super() do |xml|
-        xml.send('c:pie3DChart') {
-          xml.send('c:varyColors', :val=>1)
-          @series.each { |ser| ser.to_xml(xml) }
-        }                      
-      end
-    end
-  end
-end

data/lib/axlsx/drawing/pie_series.rb

@@ -1,56 +0,0 @@
-module Axlsx
-  # A PieSeries defines the data and labels and explosion for pie charts series.
-  # @note The recommended way to manage series is to use Chart#add_series
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  class PieSeries < Series
-
-    # The data for this series. 
-    # @return [SimpleTypedList]
-    attr_reader :data
-
-    # The labels for this series.
-    # @return [SimpleTypedList]
-    attr_reader :labels
-
-    # The explosion for this series
-    # @return [Integert]
-    attr_reader :explosion
-
-    # Creates a new series
-    # @option options [Array, SimpleTypedList] data
-    # @option options [Array, SimpleTypedList] labels
-    # @option options [String] title
-    # @option options [Integer] explosion
-    # @param [Chart] chart
-    def initialize(chart, options={})
-      @explosion = nil
-      super(chart, options)
-      self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
-      self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
-    end 
-    
-    # @see explosion
-    def explosion=(v) Axlsx::validate_unsigned_int(v); @explosion = 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_inner|
-        xml_inner.send('c:explosion', :val=>@explosion) unless @explosion.nil?
-        @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/scaling.rb

@@ -1,59 +0,0 @@
-module Axlsx
-  # The Scaling class defines axis scaling
-  class Scaling
-
-    # logarithmic base for a logarithmic axis.
-    # must be between 2 and 1000
-    # @return [Integer]
-    attr_reader :logBase
-
-    # the orientation of the axis
-    # must be one of [:minMax, :maxMin]
-    # @return [Symbol]
-    attr_reader :orientation
-
-    # the maximum scaling
-    # @return [Float]
-    attr_reader :max
-
-    # the minimu scaling
-    # @return [Float]
-    attr_reader :min
-
-    # creates a new Scaling object
-    # @option options [Integer, Fixnum] logBase
-    # @option options [Symbol] orientation
-    # @option options [Float] max
-    # @option options [Float] min
-    def initialize(options={})
-      @orientation = :minMax
-      @logBase, @min, @max = nil, nil, nil
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
-    # @see logBase
-    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer, Fixnum], v, lambda { |arg| arg >= 2 && arg <= 1000}; @logBase = v; end
-    # @see orientation
-    def orientation=(v) RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v; @orientation = v; end
-    # @see max
-    def max=(v) DataTypeValidator.validate "Scaling.max", Float, v; @max = v; end
-
-    # @see min
-    def min=(v) DataTypeValidator.validate "Scaling.min", Float, v; @min = v; end
-
-    # Serializes the axId
-    # @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:scaling') {
-        xml.send('c:logBase', :val=> @logBase) unless @logBase.nil?
-        xml.send('c:orientation', :val=> @orientation) unless @orientation.nil?
-        xml.send('c:min', :val => @min) unless @min.nil?
-        xml.send('c:max', :val => @max) unless @max.nil?
-      }
-    end
-
-  end
-end

data/lib/axlsx/drawing/ser_axis.rb

@@ -1,45 +0,0 @@
-module Axlsx
-  #A SerAxis object defines a series axis
-  class SerAxis < Axis
-
-    # The number of tick lables to skip between labels
-    # @return [Integer]
-    attr_reader :tickLblSkip
-
-    # The number of tickmarks to be skipped before the next one is rendered.
-    # @return [Boolean]
-    attr_reader :tickMarkSkip
-
-    # Creates a new SerAxis object
-    # @param [Integer] axId the id of this axis. Inherited
-    # @param [Integer] crossAx the id of the perpendicular axis. Inherited
-    # @option options [Symbol] axPos. Inherited
-    # @option options [Symbol] tickLblPos. Inherited
-    # @option options [Symbol] crosses. Inherited
-    # @option options [Integer] tickLblSkip
-    # @option options [Integer] tickMarkSkip
-    def initialize(axId, crossAx, options={})
-      @tickLblSkip, @tickMarkSkip = nil, nil
-      super(axId, crossAx, options)
-    end 
-
-    # @see tickLblSkip
-    def tickLblSkip=(v) Axlsx::validate_unsigned_int(v); @tickLblSkip = v; end
-
-    # @see tickMarkSkip
-    def tickMarkSkip=(v) Axlsx::validate_unsigned_int(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

data/lib/axlsx/drawing/series.rb

@@ -1,71 +0,0 @@
-module Axlsx
-  # A Series defines the common series attributes and is the super class for all concrete series types.
-  # @note The recommended way to manage series is to use Chart#add_series
-  # @see Worksheet#add_chart
-  # @see Chart#add_series
-  class Series
-
-    # The chart that owns this series
-    # @return [Chart]
-    attr_reader :chart
-
-    # The title of the series
-    # @return [SeriesTitle]
-    attr_reader :title
-
-    # Creates a new series
-    # @param [Chart] chart
-    # @option options [Integer] order
-    # @option options [String] title
-    def initialize(chart, options={})
-      @order = nil
-      self.chart = chart
-      @chart.series << self
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end    
-
-    # The index of this series in the chart's series.
-    # @return [Integer]
-    def index
-      @chart.series.index(self)
-    end
-
-
-    # The order of this series in the chart's series. By default the order is the index of the series.
-    # @return [Integer]
-    def order
-      @order || index
-    end
-
-    # @see order
-    def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end
-
-    # @see title
-    def title=(v) 
-      v = SeriesTitle.new(v) if v.is_a?(String) || v.is_a?(Cell)
-      DataTypeValidator.validate "#{self.class}.title", SeriesTitle, v
-      @title = v
-    end
-   
-    private 
-    
-    # assigns the chart for this series
-    def chart=(v)  DataTypeValidator.validate "Series.chart", Chart, v; @chart = 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)
-      xml.send('c:ser') {
-        xml.send('c:idx', :val=>index)
-        xml.send('c:order', :val=>order || index)        
-        title.to_xml(xml) unless title.nil?
-        yield xml if block_given?
-      }
-    end
-
-  end
-
-end