axlsx 1.0.15 → 1.1.1

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

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 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.
@@ -32,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]}="
@@ -60,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

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: 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
@@ -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
@@ -39,6 +39,7 @@ module Axlsx
     # @option options [Intger] height
     def initialize(anchor, options={})
       @anchor = anchor
+      @hyperlink = nil
       @anchor.drawing.worksheet.workbook.images << self
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
@@ -47,8 +48,25 @@ module Axlsx
       yield self if block_given?
       @picture_locking = PictureLocking.new(options)
     end
-    
-    def image_src=(v) 
+
+    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.
+    def hyperlink=(v, options={})
+      options[:href] = v
+      if @hyperlink.is_a?(Hyperlink)
+        options.each do |o|
+          @hyperlink.send("#{o[0]}=", o[1]) if @hyperlink.respond_to? "#{o[0]}="
+        end
+      else
+        @hyperlink = Hyperlink.new(self, options)
+      end
+      @hyperlink
+    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)
@@ -66,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
@@ -86,6 +104,11 @@ module Axlsx
       "#{IMAGE_PN % [(index+1), extname]}"
     end
 
+    # The relational id withing the drawing's relationships
+    def id
+      @anchor.drawing.charts.size + @anchor.drawing.images.index(self) + 1
+    end
+
     # providing access to the anchor's width attribute
     # @param [Integer] v
     # @see OneCellAnchor.width
@@ -97,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
@@ -121,33 +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
-          xml.cNvPicPr {
-            picture_locking.to_xml(xml)
-          }
-        }
-        xml.blipFill {
-          xml[:a].blip :'xmlns:r' => XML_NS_R, :'r:embed'=>"rId1"
-          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

data/lib/axlsx/drawing/picture_locking.rb

@@ -1,8 +1,9 @@
+# encoding: UTF-8
 module Axlsx
-  # The picture locking class defines the locking properties for pictures in your workbook. 
+  # The picture locking class defines the locking properties for pictures in your workbook.
   class PictureLocking
-    
-    
+
+
     attr_reader :noGrp
     attr_reader :noSelect
     attr_reader :noRot
@@ -30,43 +31,46 @@ module Axlsx
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
-    end        
+    end
 
     # @see noGrp
-    def noGrp=(v) Axlsx::validate_boolean v; @noGrp = v end    
+    def noGrp=(v) Axlsx::validate_boolean v; @noGrp = v end
 
     # @see noSelect
-    def noSelect=(v) Axlsx::validate_boolean v; @noSelect = v end    
+    def noSelect=(v) Axlsx::validate_boolean v; @noSelect = v end
 
     # @see noRot
-    def noRot=(v) Axlsx::validate_boolean v; @noRot = v end    
+    def noRot=(v) Axlsx::validate_boolean v; @noRot = v end
 
     # @see noChangeAspect
-    def noChangeAspect=(v) Axlsx::validate_boolean v; @noChangeAspect = v end    
+    def noChangeAspect=(v) Axlsx::validate_boolean v; @noChangeAspect = v end
 
     # @see noMove
-    def noMove=(v) Axlsx::validate_boolean v; @noMove = v end    
+    def noMove=(v) Axlsx::validate_boolean v; @noMove = v end
 
     # @see noResize
-    def noResize=(v) Axlsx::validate_boolean v; @noResize = v end    
+    def noResize=(v) Axlsx::validate_boolean v; @noResize = v end
 
     # @see noEditPoints
-    def noEditPoints=(v) Axlsx::validate_boolean v; @noEditPoints = v end    
+    def noEditPoints=(v) Axlsx::validate_boolean v; @noEditPoints = v end
 
     # @see noAdjustHandles
-    def noAdjustHandles=(v) Axlsx::validate_boolean v; @noAdjustHandles = v end    
+    def noAdjustHandles=(v) Axlsx::validate_boolean v; @noAdjustHandles = v end
 
     # @see noChangeArrowheads
-    def noChangeArrowheads=(v) Axlsx::validate_boolean v; @noChangeArrowheads = v end    
+    def noChangeArrowheads=(v) Axlsx::validate_boolean v; @noChangeArrowheads = v end
 
     # @see noChangeShapeType
-    def noChangeShapeType=(v) Axlsx::validate_boolean v; @noChangeShapeType = v end    
+    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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml[:a].picLocks(self.instance_values)      
+    def to_xml_string(str = '')
+      str << '<a:picLocks '
+      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
     end
+
   end
 end

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
 
 
@@ -10,7 +11,7 @@ module Axlsx
     # 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 [Boolean] show_legend
     # @option options [Symbol] grouping
     # @option options [String] gapDepth
     # @option options [Integer] rotX
@@ -27,15 +28,17 @@ module Axlsx
       @view3D = View3D.new({:rotX=>30, :perspective=>30}.merge(options))
     end
 
-    # Serializes the pie chart
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml
-      super() do |xml|
-        xml[:c].pie3DChart {
-          xml[:c].varyColors :val=>1
-          @series.each { |ser| ser.to_xml(xml) }
-        }                      
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << '<c:pie3DChart>'
+        str_inner << '<c:varyColors val="1"/>'
+        @series.each { |ser| ser.to_xml_string(str_inner) }
+        str_inner << '</c:pie3DChart>'
       end
     end
+
   end
 end

data/lib/axlsx/drawing/pie_series.rb

@@ -1,11 +1,13 @@
+# encoding: UTF-8
 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. 
+    # The data for this series.
     # @return [SimpleTypedList]
     attr_reader :data
 
@@ -28,22 +30,24 @@ module Axlsx
       super(chart, options)
       self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
       self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
-    end 
-    
+    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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      super(xml) do  |xml_inner|
-        xml_inner.explosion :val=>@explosion unless @explosion.nil?
-        @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 |str_inner|
+        str_inner << '<c:explosion val="' << @explosion << '"/>' unless @explosion.nil?
+        @labels.to_xml_string str_inner unless @labels.nil?
+        @data.to_xml_string str_inner unless @data.nil?
+      end
+      str
     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/scaling.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The Scaling class defines axis scaling
   class Scaling
@@ -32,7 +33,7 @@ module Axlsx
         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
@@ -43,16 +44,16 @@ module Axlsx
     # @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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml[:c].scaling {
-        xml[:c].logBase :val=> @logBase unless @logBase.nil?
-        xml[:c].orientation :val=> @orientation unless @orientation.nil?
-        xml[:c].min :val => @min unless @min.nil?
-        xml[:c].max :val => @max unless @max.nil?
-      }
+    def to_xml_string(str = '')
+      str << '<c:scaling>'
+      str << '<c:logBase val="' << @logBase.to_s << '"/>' unless @logBase.nil?
+      str << '<c:orientation val="' << @orientation.to_s << '"/>' unless @orientation.nil?
+      str << '<c:min val="' << @min.to_s << '"/>' unless @min.nil?
+      str << '<c:max val="' << @max.to_s << '"/>' unless @max.nil?
+      str << '</c:scaling>'
     end
 
   end

data/lib/axlsx/drawing/scatter_chart.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The ScatterChart allows you to insert a scatter chart into your worksheet
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see README for an example
+  class ScatterChart < Chart
+
+    # The Style for the scatter chart
+    # must be one of :none | :line | :lineMarker | :marker | :smooth | :smoothMarker
+    # return [Symbol]
+    attr_reader :scatterStyle
+
+    # the x value axis
+    # @return [ValAxis]
+    attr_reader :xValAxis
+
+    # the y value axis
+    # @return [ValAxis]
+    attr_reader :yValAxis
+
+    # Creates a new scatter chart
+    def initialize(frame, options={})
+      @scatterStyle = :lineMarker
+      @xValAxId = rand(8 ** 8)
+      @yValAxId = rand(8 ** 8)
+      @xValAxis = ValAxis.new(@xValAxId, @yValAxId)
+      @yValAxis = ValAxis.new(@yValAxId, @xValAxId)
+      super(frame, options)
+      @series_type = ScatterSeries
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+
+    # see #scatterStyle
+    def scatterStyle=(v)
+      Axlsx.validate_scatter_style(v)
+      @scatterStyle = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << '<c:scatterChart>'
+        str_inner << '<c:scatterStyle val="' << scatterStyle.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:axId val="' << @xValAxId.to_s << '"/>'
+        str_inner << '<c:axId val="' << @yValAxId.to_s << '"/>'
+        str_inner << '</c:scatterChart>'
+        @xValAxis.to_xml_string str_inner
+        @yValAxis.to_xml_string str_inner
+      end
+      str
+    end
+  end
+end

data/lib/axlsx/drawing/scatter_series.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+module Axlsx
+
+  # A ScatterSeries defines the x and y position of data in the chart
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see examples/example.rb
+  class ScatterSeries < Series
+
+    # The x data for this series.
+    # @return [NamedAxisData]
+    attr_reader :xData
+
+    # The y data for this series.
+    # @return [NamedAxisData]
+    attr_reader :yData
+
+    # Creates a new ScatterSeries
+    def initialize(chart, options={})
+      @xData, @yData = nil
+      super(chart, options)
+
+      @xData = NamedAxisData.new("xVal", options[:xData]) unless options[:xData].nil?
+      @yData = NamedAxisData.new("yVal", options[:yData]) unless options[:yData].nil?
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |inner_str|
+        @xData.to_xml_string(inner_str) unless @xData.nil?
+        @yData.to_xml_string(inner_str) unless @yData.nil?
+      end
+      str
+    end
+  end
+end

data/lib/axlsx/drawing/ser_axis.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   #A SerAxis object defines a series axis
   class SerAxis < Axis
@@ -21,7 +22,7 @@ module Axlsx
     def initialize(axId, crossAx, options={})
       @tickLblSkip, @tickMarkSkip = nil, nil
       super(axId, crossAx, options)
-    end 
+    end
 
     # @see tickLblSkip
     def tickLblSkip=(v) Axlsx::validate_unsigned_int(v); @tickLblSkip = v; end
@@ -29,17 +30,17 @@ module Axlsx
     # @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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml[:c].serAx {
-        super(xml)
-        xml[:c].tickLblSkip :val=>@tickLblSkip unless @tickLblSkip.nil?
-        xml[:c].tickMarkSkip :val=>@tickMarkSkip unless @tickMarkSkip.nil?
-      }
+    def to_xml_string(str = '')
+      str << '<c:serAx>'
+      super(str)
+      str << '<c:tickLblSkip val="' << @tickLblSkip.to_s << '"/>' unless @tickLblSkip.nil?
+      str << '<c:tickMarkSkip val="' << @tickMarkSkip.to_s << '"/>' unless @tickMarkSkip.nil?
+      str << '</c:serAx>'
     end
   end
-  
+
 
 end

data/lib/axlsx/drawing/series.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 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
@@ -24,7 +25,7 @@ module Axlsx
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
-    end    
+    end
 
     # The index of this series in the chart's series.
     # @return [Integer]
@@ -43,27 +44,27 @@ module Axlsx
     def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end
 
     # @see title
-    def title=(v) 
+    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 
-    
+
+    private
+
     # assigns the chart for this series
-    def chart=(v)  DataTypeValidator.validate "Series.chart", Chart, v; @chart = v; end    
+    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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.ser {
-        xml.idx :val=>index
-        xml.order :val=>order || index
-        title.to_xml(xml) unless title.nil?
-        yield xml if block_given?
-      }
+    def to_xml_string(str = '')
+      str << '<c:ser>'
+      str << '<c:idx val="' << index.to_s << '"/>'
+      str << '<c:order val="' << (order || index).to_s << '"/>'
+      title.to_xml_string(str) unless title.nil?
+      yield str if block_given?
+      str << '</c:ser>'
     end
 
   end