axlsx 1.0.18 → 1.1.0

data/lib/axlsx/drawing/drawing.rb

@@ -4,8 +4,9 @@ module Axlsx
   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/bar_series.rb'
+  require 'axlsx/drawing/line_series.rb'
+  require 'axlsx/drawing/scatter_series.rb'
 
   require 'axlsx/drawing/scaling.rb'
   require 'axlsx/drawing/axis.rb'
@@ -15,9 +16,10 @@ module Axlsx
 
   require 'axlsx/drawing/cat_axis_data.rb'
   require 'axlsx/drawing/val_axis_data.rb'
+  require 'axlsx/drawing/named_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'
@@ -27,6 +29,7 @@ module Axlsx
   require 'axlsx/drawing/pie_3D_chart.rb'
   require 'axlsx/drawing/bar_3D_chart.rb'
   require 'axlsx/drawing/line_3D_chart.rb'
+  require 'axlsx/drawing/scatter_chart.rb'
 
   require 'axlsx/drawing/picture_locking.rb'
   require 'axlsx/drawing/pic.rb'
@@ -43,7 +46,7 @@ module Axlsx
     # 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]
@@ -135,15 +138,15 @@ module Axlsx
       r
     end
 
-    # Serializes the drawing
+    # Serializes the object
+    # @param [String] str
     # @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, :'xmlns:c'=>XML_NS_C) {
-          anchors.each {|anchor| anchor.to_xml(xml) }
-        }        
-      end
-      builder.to_xml(:save_with => 0)
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<xdr:wsDr xmlns:xdr="' << XML_NS_XDR << '" xmlns:a="' << XML_NS_A << '" xmlns:c="' << XML_NS_C << '">'
+      anchors.each { |anchor| anchor.to_xml_string(str) }
+      str << '</xdr:wsDr>'
     end
+
   end
 end

data/lib/axlsx/drawing/graphic_frame.rb

@@ -17,37 +17,37 @@ module Axlsx
     # @param [TwoCellAnchor] anchor
     # @param [Class] chart_type
     def initialize(anchor, chart_type, options)
-      DataTypeValidator.validate "Drawing.chart_type", Chart, chart_type 
+      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 
+    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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.graphicFrame {        
-        xml.nvGraphicFramePr {
-          xml.cNvPr :id=>2, :name=>chart.title
-          xml.cNvGraphicFramePr                
-        }
-        xml.xfrm {
-          xml[:a].off(:x=>0, :y=>0)
-          xml[:a].ext :cx=>0, :cy=>0
-        }
-        xml[:a].graphic {
-          xml.graphicData(:uri=>XML_NS_C) {
-            xml[:c].chart :'xmlns:c'=>XML_NS_C, :'xmlns:r'=>XML_NS_R, :'r:id'=>rId
-          }
-        }
-      }
-      
+    def to_xml_string(str = '')
+      str << '<xdr:graphicFrame>'
+      str << '<xdr:nvGraphicFramePr>'
+      str << '<xdr:cNvPr id="2" name="' << chart.title.text << '"/>'
+      str << '<xdr:cNvGraphicFramePr/>'
+      str << '</xdr:nvGraphicFramePr>'
+      str << '<xdr:xfrm>'
+      str << '<a:off x="0" y="0"/>'
+      str << '<a:ext cx="0" cy="0"/>'
+      str << '</xdr:xfrm>'
+      str << '<a:graphic>'
+      str << '<a:graphicData uri="' << XML_NS_C << '">'
+      str << '<c:chart xmlns:c="' << XML_NS_C << '" xmlns:r="' << XML_NS_R << '" r:id="' << rId.to_s << '"/>'
+      str << '</a:graphicData>'
+      str << '</a:graphic>'
+      str << '</xdr:graphicFrame>'
     end
+
   end
 end

data/lib/axlsx/drawing/hyperlink.rb

@@ -31,12 +31,12 @@ module Axlsx
     # indicates that the link has already been clicked.
     # @return [Boolean]
     attr_reader :highlightClick
-    
+
     # @see highlightClick
     # @param [Boolean] v The value to assign
     def highlightClick=(v) Axlsx::validate_boolean(v); @highlightClick = v end
 
-    # From the specs: Specifies whether to add this URI to the history when navigating to it. This allows for the viewing of this presentation without the storing of history information on the viewing machine. If this attribute is omitted, then a value of 1 or true is assumed. 
+    # From the specs: Specifies whether to add this URI to the history when navigating to it. This allows for the viewing of this presentation without the storing of history information on the viewing machine. If this attribute is omitted, then a value of 1 or true is assumed.
     # @return [Boolean]
     attr_reader :history
 
@@ -52,12 +52,12 @@ module Axlsx
     # @return [String]
     attr_accessor :tooltip
 
-    #Creates a hyperlink object 
+    #Creates a hyperlink object
     # parent must be a Pic for now, although I expect that other object support this tag and its cNvPr parent
     # @param [Pic] parent
     # @option options [String] tooltip message shown when hyperlinked object is hovered over with mouse.
     # @option options [String] tgtFrame Target frame for opening hyperlink
-    # @option options [String] invalidUrl supposedly use to store the href when we know it is an invalid resource. 
+    # @option options [String] invalidUrl supposedly use to store the href when we know it is an invalid resource.
     # @option options [String] href the target resource this hyperlink links to.
     # @option options [String] action A string that can be used to perform specific actions. For excel please see this reference: http://msdn.microsoft.com/en-us/library/ff532419%28v=office.12%29.aspx
     # @option options [Boolean] endSnd terminate any sound events when processing this link
@@ -70,22 +70,23 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
       yield self if block_given?
-     
-    end
 
+    end
 
-    # Serializes the hyperlink
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml) 
+    def to_xml_string(str = '')
       h =  self.instance_values.merge({:'r:id' => "rId#{id}", :'xmlns:r' => XML_NS_R })
       h.delete('href')
       h.delete('parent')
-      xml[:a].hlinkClick h
+      str << '<a:hlinkClick '
+      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
     end
 
     private
-    # The relational ID for this hyperlink    
+    # The relational ID for this hyperlink
     # @return [Integer]
     def id
       @parent.anchor.drawing.charts.size + @parent.anchor.drawing.images.size + @parent.anchor.drawing.hyperlinks.index(self) + 1

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -44,11 +44,11 @@ module Axlsx
 
     # 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 [Boolean] show_legend
     # @option options [Symbol] grouping
     # @option options [String] gapDepth
     # @option options [Integer] rotX
@@ -68,7 +68,7 @@ module Axlsx
       @catAxis = CatAxis.new(@catAxId, @valAxId)
       @valAxis = ValAxis.new(@valAxId, @catAxId)
       @serAxis = SerAxis.new(@serAxId, @valAxId)
-      super(frame, options)      
+      super(frame, options)
       @series_type = LineSeries
       @view3D = View3D.new({:perspective=>30}.merge(options))
     end
@@ -85,31 +85,33 @@ module Axlsx
       @gapDepth=(v)
     end
 
-    # Serializes the bar chart
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml
-      super() do |xml|
-        xml.line3DChart {
-          xml.grouping :val=>grouping
-          xml.varyColors :val=>1
-          @series.each { |ser| ser.to_xml(xml) }
-          xml.dLbls {
-            xml.showLegendKey :val=>0
-            xml.showVal :val=>0
-            xml.showCatName :val=>0
-            xml.showSerName :val=>0
-            xml.showPercent :val=>0
-            xml.showBubbleSize :val=>0            
-          }
-          xml.gapDepth :val=>@gapDepth unless @gapDepth.nil?
-          xml.axId :val=>@catAxId
-          xml.axId :val=>@valAxId
-          xml.axId :val=>@serAxId
-        }
-        @catAxis.to_xml(xml)
-        @valAxis.to_xml(xml)
-        @serAxis.to_xml(xml)
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << '<c:line3DChart>'
+        str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
+        str_inner << '<c:varyColors val="1"/>'
+        @series.each { |ser| ser.to_xml_string(str_inner) }
+        str_inner << '<c:dLbls>'
+        str_inner << '<c:showLegendKey val="0"/>'
+        str_inner << '<c:showVal val="0"/>'
+        str_inner << '<c:showCatName val="0"/>'
+        str_inner << '<c:showSerName val="0"/>'
+        str_inner << '<c:showPercent val="0"/>'
+        str_inner << '<c:showBubbleSize val="0"/>'
+        str_inner << '</c:dLbls>'
+        str_inner << '<c:gapDepth val="' << @gapDepth.to_s << '"/>' unless @gapDepth.nil?
+        str_inner << '<c:axId val="' << @catAxId.to_s << '"/>'
+        str_inner << '<c:axId val="' << @valAxId.to_s << '"/>'
+        str_inner << '<c:axId val="' << @serAxId.to_s << '"/>'
+        str_inner << '</c:line3DChart>'
+        @catAxis.to_xml_string str_inner
+        @valAxis.to_xml_string str_inner
+        @serAxis.to_xml_string str_inner
       end
-    end    
-  end  
+    end
+
+  end
 end

data/lib/axlsx/drawing/line_series.rb

@@ -5,8 +5,8 @@ module Axlsx
   # @see Worksheet#add_chart
   # @see Chart#add_series
   class LineSeries < Series
-  
-    # The data for this series. 
+
+    # The data for this series.
     # @return [ValAxisData]
     attr_reader :data
 
@@ -23,19 +23,19 @@ module Axlsx
       super(chart, options)
       @labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
       @data = ValAxisData.new(options[:data]) unless options[:data].nil?
-    end 
+    end
 
-    # Serializes the series
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @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      
+    def to_xml_string(str = '')
+      super(str) do
+        @labels.to_xml_string(str) unless @labels.nil?
+        @data.to_xml_string(str) unless @data.nil?
+      end
     end
 
-    private 
+    private
 
     # assigns the data for this series
     def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end

data/lib/axlsx/drawing/marker.rb

@@ -30,9 +30,9 @@ module Axlsx
       @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
     end
-    
+
     # @see col
     def col=(v) Axlsx::validate_unsigned_int v; @col = v end
     # @see colOff
@@ -41,7 +41,7 @@ module Axlsx
     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
@@ -49,14 +49,16 @@ module Axlsx
       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.
+
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
+    def to_xml_string(str = '')
       [:col, :colOff, :row, :rowOff].each do |k|
-        xml.send(k.to_sym, self.send(k))
-      end      
+        str << '<xdr:' << k.to_s << '>' << self.send(k).to_s << '</xdr:' << k.to_s << '>'
+      end
     end
+
   end
 
 end

data/lib/axlsx/drawing/named_axis_data.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+# TODO: review cat, val and named access data to extend this and reduce replicated code.
+module Axlsx
+  # The ValAxisData class manages the values for a chart value series.
+  class NamedAxisData < CatAxisData
+
+    # creates a new NamedAxisData Object
+    # @param [String] name The serialized node name for the axis data object
+    # @param [Array] The data to associate with the axis data object
+    def initialize(name, data=[])
+      super(data)
+      @name = name
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:' << @name.to_s << '>'
+      str << '<c:numRef>'
+      str << '<c:f>' << Axlsx::cell_range(@list) << '</c:f>'
+      str << '<c:numCache>'
+      str << '<c:formatCode>General</c:formatCode>'
+      str << '<c:ptCount val="' << size.to_s << '"/>'
+      each_with_index do |item, index|
+        v = item.is_a?(Cell) ?  item.value.to_s : item
+        str << '<c:pt idx="' << index.to_s << '"><c:v>' << v << '</c:v></c:pt>'
+      end
+      str << '</c:numCache>'
+      str << '</c:numRef>'
+      str << '</c:' << @name.to_s << '>'
+    end
+
+  end
+
+end

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -33,15 +33,15 @@ module Axlsx
     # @param [Drawing] drawing
     # @option options [Array] start_at the col, row to start at
     # @option options [Integer] width
-    # @option options [Integer] height    
+    # @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    
+    # @option options [String] descr the description of the image rendered
     def initialize(drawing, options={})
       @drawing = drawing
       @width = 0
       @height = 0
-      drawing.anchors << self      
+      drawing.anchors << self
       @from = Marker.new
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
@@ -61,23 +61,24 @@ module Axlsx
       @drawing.anchors.index(self)
     end
 
-    # Serializes the anchor
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml[:xdr].oneCellAnchor {
-        xml.from {
-          from.to_xml(xml)
-        }
-        xml.ext ext
-        @object.to_xml(xml)
-        xml.clientData
-      }
-    end    
+    def to_xml_string(str = '')
+      str << '<xdr:oneCellAnchor>'
+      str << '<xdr:from>'
+      from.to_xml_string(str)
+      str << '</xdr:from>'
+      str << '<xdr:ext cx="' << ext[:cx].to_s << '" cy="' << ext[:cy].to_s << '"/>'
+      @object.to_xml_string(str)
+      str << '<xdr:clientData/>'
+      str << '</xdr:oneCellAnchor>'
+    end
 
     private
 
-    # converts the pixel width and height to EMU units and returns a hash of 
+    # converts the pixel width and height to EMU units and returns a hash of
     # !{:cx=>[Integer], :cy=>[Integer]
     # @return [Hash]
     def ext

data/lib/axlsx/drawing/pic.rb

@@ -28,7 +28,7 @@ module Axlsx
 
     # 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
@@ -50,7 +50,7 @@ module Axlsx
     end
 
     attr_reader :hyperlink
-    
+
     # sets or updates a hyperlink for this image.
     # @param [String] v The href value for the hyper link
     # @option options @see Hyperlink#initialize All options available to the Hyperlink class apply - however href will be overridden with the v parameter value.
@@ -66,7 +66,7 @@ module Axlsx
       @hyperlink
     end
 
-    def image_src=(v) 
+    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)
@@ -84,8 +84,8 @@ module Axlsx
     # @return [String]
     def file_name
       File.basename(image_src) unless image_src.nil?
-    end    
-    
+    end
+
     # returns the extension of image_src without the preceeding '.'
     # @return [String]
     def extname
@@ -93,7 +93,7 @@ module Axlsx
     end
 
     # The index of this image in the workbooks images collections
-    # @return [Index]    
+    # @return [Index]
     def index
       @anchor.drawing.worksheet.workbook.images.index(self)
     end
@@ -120,7 +120,7 @@ module Axlsx
     def width=(v)
       @anchor.width = v
     end
-    
+
     # providing access to update the anchor's height attribute
     # @param [Integer] v
     # @see OneCellAnchor.width
@@ -144,37 +144,24 @@ module Axlsx
       @anchor.from.row = y
     end
 
-    # Serializes the picture
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.pic {
-        xml.nvPicPr {
-          xml.cNvPr(:id=>"2", :name=>name, :descr=>descr) {
-            if @hyperlink.is_a?(Hyperlink)
-              @hyperlink.to_xml(xml)
-            end
-          }
-          xml.cNvPicPr {
-            picture_locking.to_xml(xml)
-          }
-        }
-        xml.blipFill {
-          xml[:a].blip :'xmlns:r' => XML_NS_R, :'r:embed'=>"rId#{id}"
-          xml[:a].stretch {
-            xml.fillRect
-          }
-        }
-        xml.spPr {
-          xml[:a].xfrm {
-            xml.off :x=>0, :y=>0
-            xml.ext :cx=>2336800, :cy=>2161540
-          }
-          xml[:a].prstGeom(:prst=>:rect) {
-            xml.avLst
-          }
-        }
-      }
+    def to_xml_string(str = '')
+      str << '<xdr:pic>'
+      str << '<xdr:nvPicPr>'
+      str << '<xdr:cNvPr id="2" name="' << name.to_s << '" descr="' << descr.to_s << '">'
+      @hyperlink.to_xml_string(str) if @hyperlink.is_a?(Hyperlink)
+      str << '</xdr:cNvPr><xdr:cNvPicPr>'
+      picture_locking.to_xml_string(str)
+      str << '</xdr:cNvPicPr></xdr:nvPicPr>'
+      str << '<xdr:blipFill>'
+      str << '<a:blip xmlns:r ="' << XML_NS_R << '" r:embed="rId' << id.to_s <<  '"/>'
+      str << '<a:stretch><a:fillRect/></a:stretch></xdr:blipFill><xdr:spPr>'
+      str << '<a:xfrm><a:off x="0" y="0"/><a:ext cx="2336800" cy="2161540"/></a:xfrm>'
+      str << '<a:prstGeom prst="rect"><a:avLst/></a:prstGeom></xdr:spPr></xdr:pic>'
+
     end
+
   end
 end