axlsx 1.0.7 → 1.0.8

data/doc/top-level-namespace.html

@@ -94,7 +94,7 @@
 </div>
     
     <div id="footer">
-  Generated on Wed Nov 23 12:30:35 2011 by 
+  Generated on Wed Nov 23 21:48:07 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.8.7).
 </div>

data/examples/example.rb

@@ -82,5 +82,18 @@
          chart.add_series :data=>sheet.rows.first.cells[(1..-1)], :title=> sheet.rows.first.cells.first
          chart.add_series :data=>sheet.rows.last.cells[(1..-1)], :title=> sheet.rows.last.cells.first
        end
+       
      end  
      p.serialize("example6.xlsx")
+
+#Add an Image
+
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_image(:image_src => (File.dirname(__FILE__) + "/image1.png")) do |image|
+         image.width=720
+         image.height=666
+         image.start_at 2, 2
+       end
+     end  
+     p.serialize("example7.xlsx")

data/lib/axlsx/drawing/bar_series.rb

@@ -51,7 +51,6 @@ module Axlsx
     
     private 
 
-
     # assigns the data for this series
     def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end
 

data/lib/axlsx/drawing/cat_axis_data.rb

@@ -7,6 +7,7 @@ module Axlsx
     def initialize(data=[])
       super Object
       @list.concat data if data.is_a?(Array)
+      data.each { |i| @list << i } if data.is_a?(SimpleTypedList)
     end
 
     # Serializes the category axis data

data/lib/axlsx/drawing/chart.rb

@@ -90,7 +90,6 @@ module Axlsx
 
     # 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 start_at method
-    #   
     def from
       @graphic_frame.anchor.from
     end

data/lib/axlsx/drawing/drawing.rb

@@ -16,6 +16,8 @@ module Axlsx
   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'
 
@@ -25,6 +27,9 @@ module Axlsx
   require 'axlsx/drawing/bar_3D_chart.rb'
   require 'axlsx/drawing/line_3D_chart.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.
@@ -46,6 +51,10 @@ module Axlsx
     # @return [Array]
     attr_reader :charts
 
+    # An array of image objects that are associated with this drawing's anchors
+    # @return [Array]
+    attr_reader :images
+
     # The index of this drawing in the owning workbooks's drawings collection.
     # @return [Integer]
     attr_reader :index
@@ -72,20 +81,33 @@ module Axlsx
       DataTypeValidator.validate "Drawing.worksheet", Worksheet, worksheet
       @worksheet = worksheet
       @worksheet.workbook.drawings << self
-      @anchors = SimpleTypedList.new TwoCellAnchor
+      @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, chart_type, options)
-      @anchors.last.graphic_frame.chart
+      TwoCellAnchor.new(self, options)
+      @anchors.last.add_chart(chart_type, options)
     end
     
     def charts
-      @anchors.map { |a| a.graphic_frame.chart }
+      charts = @anchors.select { |a| a.object.is_a?(GraphicFrame) }
+      charts.map { |a| a.object.chart }
+    end
+
+    def images
+      images = @anchors.select { |a| a.object.is_a?(Pic) }
+      images.map { |a| a.object }
     end
 
     def index
@@ -106,10 +128,12 @@ module Axlsx
 
     def relationships
       r = Relationships.new
-      @anchors.each do |anchor|
-        chart = anchor.graphic_frame.chart
+      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
 

data/lib/axlsx/drawing/graphic_frame.rb

@@ -4,8 +4,6 @@ module Axlsx
   # @see Worksheet#add_chart
   class GraphicFrame
 
-    #TODO add in support for other graphical objects, primarily images.
-    
     # A reference to the chart object associated with this frame
     # @return [Chart]
     attr_reader :chart

data/lib/axlsx/drawing/line_series.rb

@@ -26,7 +26,6 @@ module Axlsx
     # Serializes the series
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
     # @return [String]
-    # TODO create series_cat and series_val classes as this serialization is duplicated
     def to_xml(xml)
       super(xml) do |xml|
         @labels.to_xml(xml) unless @labels.nil?

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -0,0 +1,89 @@
+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 index of this anchor in the drawing
+    # @return [Integer]
+    attr_reader :index
+
+
+    # the width of the graphic object in pixels.
+    # this is converted to EMU at a 92 ppi resolution
+    # @return [Integer]
+    attr_accessor :width
+
+    # the height of the graphic object in pixels
+    # this is converted to EMU at a 92 ppi resolution
+    # @return [Integer]
+    attr_accessor :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
+
+    def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end
+    def width=(v) Axlsx::validate_unsigned_int(v); @width = v; end
+
+    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

data/lib/axlsx/drawing/pic.rb

@@ -0,0 +1,158 @@
+# -*- 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_accessor :name
+
+    # providing access to the anchor's width attribute
+    # @param [Integer] v
+    # @see OneCellAnchor.width
+    attr_accessor :width
+
+    # providing access to update the anchor's height attribute
+    # @param [Integer] v
+    # @see OneCellAnchor.width
+    attr_accessor :height
+
+    # A description of the picture
+    # @return [String]
+    attr_accessor :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_accessor :image_src
+
+    # The anchor for this image
+    # @return [OneCellAnchor]
+    attr_reader :anchor
+
+    # returns the extension of image_src without the preceeding '.'
+    # @return [String]
+    attr_reader :extname
+
+    # The file name of image_src without any path information
+    # @return [String]
+    attr_reader :file_name
+
+    # The part name for this image used in serialization and relationship building
+    # @return [String]
+    attr_reader :pn
+
+    # The index of this image in the workbooks images collections
+    # @return [Index]
+    attr_reader :index
+
+    # The name of the image file, sans directory info
+    # @return [String]
+    attr_reader :file_name
+   
+    # 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?
+    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
+
+    def name=(v) Axlsx::validate_string(v); @name = v; end
+    def descr=(v) Axlsx::validate_string(v); @descr = v; end
+
+    def file_name
+      File.basename(image_src) unless image_src.nil?
+    end    
+    
+    def extname
+      File.extname(image_src).delete('.') unless image_src.nil?
+    end
+
+    def index
+      @anchor.drawing.worksheet.workbook.images.index(self)
+    end
+    
+    def pn
+      "#{IMAGE_PN % [(index+1), extname]}"
+    end
+
+    def width
+      @anchor.width
+    end
+
+    def width=(v)
+      @anchor.width = v
+    end
+
+    def height=(v)
+      @anchor.height = v
+    end
+
+    def height
+      @anchor.height
+    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') {
+            xml.send('a:picLocks', :noChangeAspect=>1)
+          }
+        }
+        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/pie_3D_chart.rb

@@ -25,7 +25,6 @@ module Axlsx
       super(frame, options)
       @series_type = PieSeries
       @view3D = View3D.new({:rotX=>30, :perspective=>30}.merge(options))
-
     end
 
     # Serializes the pie chart

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -12,8 +12,13 @@ module Axlsx
     attr_reader :to
 
     # The frame for your chart
+    # @note this will be discontinued in version 2.0 please use object
     # @return [GraphicFrame]
-    attr_reader :graphic_frame
+    # attr_reader :graphic_frame
+
+    # The object this anchor hosts
+    # @return [Pic, GraphicFrame]
+    attr_reader :object
 
     # The drawing that holds this anchor
     # @return [Drawing]
@@ -27,15 +32,23 @@ module Axlsx
     # graphic_frame's chart. That means that you can do stuff like
     # c = worksheet.add_chart Axlsx::Chart
     # c.start_at 5, 9
+    # @note the chart_type parameter will be replaced with object in v. 2.0.0
     # @param [Drawing] drawing
     # @param [Class] chart_type This is passed to the graphic frame for instantiation. must be Chart or a subclass of Chart
+    # @param object The object this anchor holds.
     # @option options [Array] start_at the col, row to start at
     # @option options [Array] end_at the col, row to end at
-    def initialize(drawing, chart_type, options)
+    def initialize(drawing, options={})
       @drawing = drawing
       drawing.anchors << self      
       @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
-      @graphic_frame = GraphicFrame.new(self, chart_type, options)
+    end
+
+    # Creates a graphic frame and chart object associated with this anchor
+    # @return [Chart]
+    def add_chart(chart_type, options)      
+      @object = GraphicFrame.new(self, chart_type, options)
+      @object.chart
     end
 
     def index
@@ -53,7 +66,7 @@ module Axlsx
         xml.send('xdr:to') {
           to.to_xml(xml)
         }
-        @graphic_frame.to_xml(xml)
+        @object.to_xml(xml)
         xml.send('xdr:clientData')
       }
     end