axlsx 1.1.4 → 1.3.1

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -70,7 +70,8 @@ module Axlsx
       @serAxis = SerAxis.new(@serAxId, @valAxId)
       super(frame, options)
       @series_type = LineSeries
-      @view3D = View3D.new({:perspective=>30}.merge(options))
+      @view_3D = View3D.new({:perspective=>30}.merge(options))
+      @d_lbls = nil
     end
 
     # @see grouping
@@ -94,14 +95,7 @@ module Axlsx
         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>'
+        @d_lbls.to_xml_string(str) if @d_lbls
         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 << '"/>'
@@ -112,6 +106,5 @@ module Axlsx
         @serAxis.to_xml_string str_inner
       end
     end
-
   end
 end

data/lib/axlsx/drawing/num_data.rb

@@ -25,8 +25,8 @@ module Axlsx
     def data=(values=[])
       @tag_name = values.first.is_a?(Cell) ? :numCache : :numLit
       values.each do |value|
-        v = value.is_a?(Cell) ? value.value : value
-        @pt << NumVal.new(:v => v)
+        value = value.is_formula? ? 0 : value.value if value.is_a?(Cell)
+        @pt << NumVal.new(:v => value)
       end
     end
 

data/lib/axlsx/drawing/num_data_source.rb

@@ -1,4 +1,5 @@
 module Axlsx
+
   # A numeric data source for use by charts.
   class NumDataSource
 
@@ -35,12 +36,14 @@ module Axlsx
     end
 
     # sets the tag name for this data source
-    # @param [Symbol] One of the allowed_tag_names
+    # @param [Symbol] v One of the allowed_tag_names
     def tag_name=(v)
       Axlsx::RestrictionValidator.validate "#{self.class.name}.tag_name", self.class.allowed_tag_names, v
       @tag_name = v
     end
 
+    # serialize the object
+    # @param [String] str
     def to_xml_string(str="")
       str << '<c:' << tag_name.to_s << '>'
       if @f

data/lib/axlsx/drawing/pic.rb

@@ -90,8 +90,7 @@ module Axlsx
     # @return [String]
     def extname
       File.extname(image_src).delete('.') unless image_src.nil?
-    end
-
+    end 
     # The index of this image in the workbooks images collections
     # @return [Index]
     def index
@@ -113,27 +112,32 @@ module Axlsx
     # @param [Integer] v
     # @see OneCellAnchor.width
     def width
+      return unless @anchor.is_a?(OneCellAnchor)
       @anchor.width
     end
 
     # @see width
     def width=(v)
+      use_one_cell_anchor unless @anchor.is_a?(OneCellAnchor)
       @anchor.width = v
     end
 
     # providing access to update the anchor's height attribute
     # @param [Integer] v
     # @see OneCellAnchor.width
+    # @note this is a noop if you are using a TwoCellAnchor
     def height
       @anchor.height
     end
 
     # @see height
+    # @note This is a noop if you are using a TwoCellAnchor
     def height=(v)
+      use_one_cell_anchor unless @anchor.is_a?(OneCellAnchor)
       @anchor.height = v
     end
-
-    # This is a short cut method to set the start anchor position
+    
+       # 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
@@ -142,6 +146,18 @@ module Axlsx
     def start_at(x, y)
       @anchor.from.col = x
       @anchor.from.row = y
+      @anchor.from
+    end
+    
+    # noop if not using a two cell anchor
+    # @param [Integer] x The column
+    # @param [Integer] y The row
+    # @return [Marker]
+    def end_at(x, y)
+      use_two_cell_anchor unless @anchor.is_a?(TwoCellAnchor)
+      @anchor.to.col = x
+      @anchor.to.row = y
+      @anchor.to
     end
 
     # Serializes the object
@@ -162,6 +178,30 @@ module Axlsx
       str << '<a:prstGeom prst="rect"><a:avLst/></a:prstGeom></xdr:spPr></xdr:pic>'
 
     end
+     
+    private
+
+    # Changes the anchor to a one cell anchor.
+    def use_one_cell_anchor
+      return if @anchor.is_a?(OneCellAnchor)
+      swap_anchor(OneCellAnchor.new(@anchor.drawing, :from => @anchor.from))
+    end
+    
+    #changes the anchor type to a two cell anchor
+    def use_two_cell_anchor
+      return if @anchor.is_a?(TwoCellAnchor)
+      swap_anchor(TwoCellAnchor.new(@anchor.drawing)).tap do |new_anchor|
+        new_anchor.from.col = @anchor.from.col
+        new_anchor.from.row = @anchor.from.row
+      end
+    end
+
+    # refactoring of swapping code, law of demeter be damned!
+    def swap_anchor(new_anchor)
+      new_anchor.drawing.anchors.delete(new_anchor)
+      @anchor.drawing.anchors[@anchor.drawing.anchors.index(@anchor)] = new_anchor
+      @anchor = new_anchor
+    end
 
   end
 end

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -13,19 +13,20 @@ module Axlsx
     # @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 [String] gap_depth
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
     # @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))
+      @view_3D = View3D.new({:rot_x =>30, :perspective=>30}.merge(options))
+      @d_lbls = nil
     end
 
     # Serializes the object
@@ -33,9 +34,11 @@ module Axlsx
     # @return [String]
     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) }
+        d_lbls.to_xml_string(str) if @d_lbls
         str_inner << '</c:pie3DChart>'
       end
     end

data/lib/axlsx/drawing/scatter_chart.rb

@@ -29,6 +29,7 @@ module Axlsx
       @yValAxis = ValAxis.new(@yValAxId, @xValAxId)
       super(frame, options)
       @series_type = ScatterSeries
+      @d_lbls = nil
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
@@ -49,14 +50,7 @@ module Axlsx
         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>'
+        d_lbls.to_xml_string(str) if @d_lbls
         str_inner << '<c:axId val="' << @xValAxId.to_s << '"/>'
         str_inner << '<c:axId val="' << @yValAxId.to_s << '"/>'
         str_inner << '</c:scatterChart>'

data/lib/axlsx/drawing/title.rb

@@ -46,15 +46,27 @@ module Axlsx
       str << '<c:title>'
       unless @text.empty?
         str << '<c:tx>'
-        str << '<c:strRef>'
-        str << '<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>'
-        str << '<c:strCache>'
-        str << '<c:ptCount val="1"/>'
-        str << '<c:pt idx="0">'
-        str << '<c:v>' << @text << '</c:v>'
-        str << '</c:pt>'
-        str << '</c:strCache>'
-        str << '</c:strRef>'
+        if @cell.is_a?(Cell)
+          str << '<c:strRef>'
+          str << '<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>'
+          str << '<c:strCache>'
+          str << '<c:ptCount val="1"/>'
+          str << '<c:pt idx="0">'
+          str << '<c:v>' << @text << '</c:v>'
+          str << '</c:pt>'
+          str << '</c:strCache>'
+          str << '</c:strRef>'
+        else
+          str << '<c:rich>'
+            str << '<a:bodyPr/>'
+            str << '<a:lstStyle/>'
+            str << '<a:p>'
+              str << '<a:r>'
+                str << '<a:t>' << @text.to_s << '</a:t>'
+              str << '</a:r>'
+            str << '</a:p>'
+          str << '</c:rich>'
+        end
         str << '</c:tx>'
       end
       str << '<c:layout/>'

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -25,23 +25,33 @@ module Axlsx
     # @return [Drawing]
     attr_reader :drawing
 
-
-    # Creates a new TwoCellAnchor object and sets up a reference to the from and to markers in the
-    # graphic_frame's chart. That means that you can do stuff like
-    # c = worksheet.add_chart Axlsx::Chart
+    # Creates a new TwoCellAnchor object
     # 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
+    # @option options [Array] :start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
+    # @option options [Array] :end_at the col, row to end at
     def initialize(drawing, options={})
       @drawing = drawing
       drawing.anchors << self
       @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
     end
 
+    # sets the col, row attributes for the from marker.
+    # @note The recommended way to set the start position for graphical
+    # objects is directly thru the object. 
+    # @see Chart#start_at
+    def start_at(x, y)
+      set_marker_coords(x, y, from)
+    end
+
+    # sets the col, row attributes for the to marker
+    # @note the recommended way to set the to position for graphical
+    # objects is directly thru the object
+    # @see Char#end_at
+    def end_at(x, y)
+      set_marker_coords(x, y, to) 
+    end
+
     # Creates a graphic frame and chart object associated with this anchor
     # @return [Chart]
     def add_chart(chart_type, options)
@@ -49,6 +59,11 @@ module Axlsx
       @object.chart
     end
 
+    # Creates an image associated with this anchor.
+    def add_pic(options={})
+      @object = Pic.new(self, options)
+    end
+
     # The index of this anchor in the drawing
     # @return [Integer]
     def index
@@ -70,6 +85,28 @@ module Axlsx
       str << '<xdr:clientData/>'
       str << '</xdr:twoCellAnchor>'
     end
+    private 
+
+    # parses coordinates and sets up a marker's row/col propery
+    def set_marker_coords(x, y, marker)
+      marker.col, marker.row = *parse_coord_args(x, y)
+    end
+
+    # handles multiple inputs for setting the position of a marker
+    # @see Chart#start_at
+    def parse_coord_args(x, y=0)
+      if x.is_a?(String)
+        x, y = *Axlsx::name_to_indices(x)
+      end
+      if x.is_a?(Cell)
+        x, y = *x.pos
+      end
+      if x.is_a?(Array)
+        x, y = *x
+      end
+      [x, y]
+    end
+
 
   end
 end

data/lib/axlsx/drawing/view_3D.rb

@@ -12,63 +12,73 @@ module Axlsx
     # x rotation for the chart
     # must be between -90 and 90
     # @return [Integer]
-    attr_reader :rotX
-
-    # height of chart as % of chart
+    attr_reader :rot_x
+    alias :rotX :rot_x
+    
+    # height of chart as % of chart width
     # must be between 5% and 500%
     # @return [String]
-    attr_reader :hPercent
+    attr_reader :h_percent
+    alias :hPercent :h_percent
 
     # y rotation for the chart
     # must be between 0 and 360
     # @return [Integer]
-    attr_reader :rotY
-
+    attr_reader :rot_y
+    alias :rotY :rot_y
+    
     # depth or chart as % of chart width
     # must be between 20% and 2000%
     # @return [String]
-    attr_reader :depthPercent
+    attr_reader :depth_percent
+    alias :depthPercent :depth_percent
 
     # Chart axis are at right angles
     # @return [Boolean]
-    attr_reader :rAngAx
+    attr_reader :r_ang_ax
+    alias :rAngAx :r_ang_ax
 
     # field of view angle
     # @return [Integer]
     attr_reader :perspective
 
     # Creates a new View3D for charts
-    # @option options [Integer] rotX
-    # @option options [String] hPercent
-    # @option options [Integer] rotY
-    # @option options [String] depthPercent
-    # @option options [Boolean] rAngAx
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
     # @option options [Integer] perspective
     def initialize(options={})
-      @rotX, @hPercent, @rotY, @depthPercent, @rAngAx, @perspective  = nil, nil, nil, nil, nil, nil
+      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end
 
-    # @see rotX
-    def rotX=(v) DataTypeValidator.validate "#{self.class}.rotX", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rotX = v; end
+    # @see rot_x
+    def rot_x=(v) DataTypeValidator.validate "#{self.class}.rot_x", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rot_x = v; end
+    alias :rotX= :rot_x=
 
-    # @see hPercent
-    def hPercent=(v)
-      RegexValidator.validate "#{self.class}.hPercent", H_PERCENT_REGEX, v
-      @hPercent = v
+    # @see h_percent
+    def h_percent=(v)
+      RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
+      @h_percent = v
     end
+    alias :hPercent= :h_percent=
 
-    # @see rotY
-    def rotY=(v) DataTypeValidator.validate "#{self.class}.rotY", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rotY = v; end
-
-    # @see depthPercent
-    def depthPercent=(v) RegexValidator.validate "#{self.class}.depthPercent", DEPTH_PERCENT_REGEX, v; @depthPercent = v; end
+    # @see rot_y
+    def rot_y=(v) DataTypeValidator.validate "#{self.class}.rot_y", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rot_y = v; end
+    alias :rotY= :rot_y=
 
-    # @see rAngAx
-    def rAngAx=(v) Axlsx::validate_boolean(v); @rAngAx = v; end
+    # @see depth_percent
+    def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+    alias :depthPercent= :depth_percent=
 
+    # @see r_ang_ax
+    def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+    alias :rAngAx= :r_ang_ax=
+     
     # @see perspective
     def perspective=(v) DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
 
@@ -78,11 +88,11 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<c:view3D>'
-      str << '<c:rotX val="' << @rotX.to_s << '"/>' unless @rotX.nil?
-      str << '<c:hPercent val="' << @hPercent.to_s << '"/>' unless @hPercent.nil?
-      str << '<c:rotY val="' << @rotY.to_s << '"/>' unless @rotY.nil?
-      str << '<c:depthPercent val="' << @depthPercent.to_s << '"/>' unless @depthPercent.nil?
-      str << '<c:rAngAx val="' << @rAngAx.to_s << '"/>' unless @rAngAx.nil?
+      str << '<c:rotX val="' << @rot_x.to_s << '"/>' unless @rot_x.nil?
+      str << '<c:hPercent val="' << @h_percent.to_s << '"/>' unless @h_percent.nil?
+      str << '<c:rotY val="' << @rot_y.to_s << '"/>' unless @rot_y.nil?
+      str << '<c:depthPercent val="' << @depth_percent.to_s << '"/>' unless @depth_percent.nil?
+      str << '<c:rAngAx val="' << @r_ang_ax.to_s << '"/>' unless @r_ang_ax.nil?
       str << '<c:perspective val="' << @perspective.to_s << '"/>' unless @perspective.nil?
       str << '</c:view3D>'
     end

data/lib/axlsx/drawing/vml_drawing.rb

@@ -0,0 +1,42 @@
+module Axlsx
+
+  # a vml drawing used for comments in excel.
+  class VmlDrawing
+
+    # creates a new Vml Drawing object.
+    # @param [Comments] comments the comments object this drawing is associated with
+    def initialize(comments)
+      raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
+      @comments = comments
+    end
+
+    # The part name for this vml drawing
+    # @return [String]
+    def pn
+      "#{VML_DRAWING_PN}" % (@comments.worksheet.index + 1)
+    end
+
+    # serialize the vml_drawing to xml.
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str = <<BAD_PROGRAMMER
+<xml xmlns:v="urn:schemas-microsoft-com:vml"
+ xmlns:o="urn:schemas-microsoft-com:office:office"
+ xmlns:x="urn:schemas-microsoft-com:office:excel">
+ <o:shapelayout v:ext="edit">
+  <o:idmap v:ext="edit" data="#{@comments.worksheet.index+1}"/>
+ </o:shapelayout>
+ <v:shapetype id="_x0000_t202" coordsize="21600,21600" o:spt="202"
+  path="m0,0l0,21600,21600,21600,21600,0xe">
+  <v:stroke joinstyle="miter"/>
+  <v:path gradientshapeok="t" o:connecttype="rect"/>
+ </v:shapetype>
+BAD_PROGRAMMER
+      @comments.each { |comment| comment.vml_shape.to_xml_string str }
+      str << "</xml>"
+
+    end
+
+  end
+end

data/lib/axlsx/drawing/vml_shape.rb

@@ -0,0 +1,125 @@
+module Axlsx
+
+  # A VmlShape is used to position and render a comment.
+  class VmlShape
+
+    # The row anchor position for this shape determined by the comment's ref value
+    # @return [Integer]
+    attr_reader :row
+
+    # The column anchor position for this shape determined by the comment's ref value
+    # @return [Integer]
+    attr_reader :column
+
+    # The left column for this shape
+    # @return [Integer]
+    attr_reader :left_column
+
+    # The left offset for this shape
+    # @return [Integer]
+    attr_reader :left_offset
+
+    # The top row for this shape
+    # @return [Integer]
+    attr_reader :top_row
+
+    # The top offset for this shape
+    # @return [Integer]
+    attr_reader :top_offset
+
+    # The right column for this shape
+    # @return [Integer]
+    attr_reader :right_column
+
+    # The right offset for this shape
+    # @return [Integer]
+    attr_reader :right_offset
+
+    # The botttom row for this shape
+    # @return [Integer]
+    attr_reader :bottom_row
+
+    # The bottom offset for this shape
+    # @return [Integer]
+    attr_reader :bottom_offset
+
+    # Creates a new VmlShape
+    # @option options [Integer|String] left_column
+    # @option options [Integer|String] left_offset
+    # @option options [Integer|String] top_row
+    # @option options [Integer|String] top_offset
+    # @option options [Integer|String] right_column
+    # @option options [Integer|String] right_offset
+    # @option options [Integer|String] bottom_row
+    # @option options [Integer|String] bottom_offset
+    def initialize(options={})
+      @row = @column = @left_column = @top_row = @right_column = @bottom_row = 0
+      @left_offset = 15
+      @top_offset = 2
+      @right_offset = 50
+      @bottom_offset = 5
+      @id = (0...8).map{65.+(rand(25)).chr}.join
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      yield self if block_given?
+    end
+
+    # @see column
+    def column=(v); Axlsx::validate_integerish(v); @column = v.to_i end
+ 
+    # @see row
+    def row=(v); Axlsx::validate_integerish(v); @row = v.to_i end
+    # @see left_column
+    def left_column=(v); Axlsx::validate_integerish(v); @left_column = v.to_i end
+
+    # @see left_offset
+    def left_offset=(v); Axlsx::validate_integerish(v); @left_offset = v.to_i end
+
+    # @see top_row
+    def top_row=(v); Axlsx::validate_integerish(v); @top_row = v.to_i end
+
+    # @see top_offset
+    def top_offset=(v); Axlsx::validate_integerish(v); @top_offset = v.to_i end
+
+    # @see right_column
+    def right_column=(v); Axlsx::validate_integerish(v); @right_column = v.to_i end
+
+    # @see right_offset
+    def right_offset=(v); Axlsx::validate_integerish(v); @right_offset = v.to_i end
+
+    # @see bottom_row
+    def bottom_row=(v); Axlsx::validate_integerish(v); @bottom_row = v.to_i end
+
+    # @see bottom_offset
+    def bottom_offset=(v); Axlsx::validate_integerish(v); @bottom_offset = v.to_i end
+
+    # serialize the shape to a string
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str ='')
+str << <<SHAME_ON_YOU
+
+<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto">
+  <v:fill color2="#ffffa1 [80]"/>
+  <v:shadow on="t" obscured="t"/>
+  <v:path o:connecttype="none"/>
+  <v:textbox style='mso-fit-text-with-word-wrap:t'>
+   <div style='text-align:left'></div>
+  </v:textbox>
+
+  <x:ClientData ObjectType="Note">
+   <x:MoveWithCells/>
+   <x:SizeWithCells/>
+   <x:Anchor>#{left_column}, #{left_offset}, #{top_row}, #{top_offset}, #{right_column}, #{right_offset}, #{bottom_row}, #{bottom_offset}</x:Anchor>
+   <x:AutoFill>False</x:AutoFill>
+   <x:Row>#{row}</x:Row>
+   <x:Column>#{column}</x:Column>
+   <x:Visible/>
+  </x:ClientData>
+ </v:shape>
+SHAME_ON_YOU
+
+    end
+  end
+end