axlsx 1.2.0 → 2.0.0

data/lib/axlsx/drawing/line_chart.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The LineChart is a two dimentional line chart (who would have guessed?) that you can add to your worksheet.
+  # @example Creating a chart
+  #   # This example creates a line in a single sheet.
+  #   require "rubygems" # if that is your preferred way to manage gems!
+  #   require "axlsx"
+  #
+  #   p = Axlsx::Package.new
+  #   ws = p.workbook.add_worksheet
+  #   ws.add_row ["This is a chart with no data in the sheet"]
+  #
+  #   chart = ws.add_chart(Axlsx::LineChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
+  #   chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
+  #
+  # @see Worksheet#add_chart
+  # @see Worksheet#add_row
+  # @see Chart#add_series
+  # @see Series
+  # @see Package#serialize
+  class LineChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    def cat_axis
+      axes[:cat_axis]
+    end
+    alias :catAxis :cat_axis
+
+    # the category axis
+    # @return [ValAxis]
+    def val_axis
+      axes[:val_axis]
+    end
+    alias :valAxis :val_axis
+
+     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_reader :grouping
+
+    # 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 [Symbol] grouping
+    # @see Chart
+    def initialize(frame, options={})
+      @vary_colors = false
+      @grouping = :standard
+      super(frame, options)
+      @series_type = LineSeries
+      @d_lbls = nil
+    end
+
+    # @see grouping
+    def grouping=(v)
+      RestrictionValidator.validate "LineChart.grouping", [:percentStacked, :standard, :stacked], v
+      @grouping = v
+    end
+
+    # The node name to use in serialization. As LineChart is used as the
+    # base class for Liine3DChart we need to be sure to serialize the
+    # chart based on the actual class type and not a fixed node name.
+    # @return [String]
+    def node_name
+      path = self.class.to_s
+      if i = path.rindex('::')
+        path = path[(i+2)..-1]
+      end
+      path[0] = path[0].chr.downcase
+      path
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << "<c:" << node_name << ">"
+        str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
+        str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
+        @series.each { |ser| ser.to_xml_string(str_inner) }
+        @d_lbls.to_xml_string(str_inner) if @d_lbls
+        yield str_inner if block_given?
+        axes.to_xml_string(str_inner, :ids => true)
+        str_inner << "</c:" << node_name << ">"
+        axes.to_xml_string(str_inner)
+      end
+    end
+
+    # The axes for this chart. LineCharts have a category and value
+    # axis.
+    # @return [Axes]
+    def axes
+      @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+    end
+  end
+end

data/lib/axlsx/drawing/line_series.rb

@@ -19,11 +19,16 @@ module Axlsx
     # @return [String]
     attr_reader :color
 
+    # show markers on values
+    # @return [Boolean]
+    attr_reader :show_marker
+
     # Creates a new series
     # @option options [Array, SimpleTypedList] data
     # @option options [Array, SimpleTypedList] labels
     # @param [Chart] chart
     def initialize(chart, options={})
+      @show_marker = false
       @labels, @data = nil, nil
       super(chart, options)
       @labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
@@ -35,6 +40,12 @@ module Axlsx
       @color = v
     end
 
+    # @see show_marker
+    def show_marker=(v)
+      Axlsx::validate_boolean(v)
+      @show_marker = v
+    end
+
     # Serializes the object
     # @param [String] str
     # @return [String]
@@ -43,9 +54,16 @@ module Axlsx
         if color
           str << '<c:spPr><a:solidFill>'
           str << '<a:srgbClr val="' << color << '"/>'
-          str << '</a:solidFill></c:spPr>'
+          str << '</a:solidFill>'
+          str << '<a:ln w="28800">'
+          str << '<a:solidFill>'
+          str << '<a:srgbClr val="' << color << '"/>'
+          str << '</a:solidFill>'
+          str << '</a:ln>'
+          str << '<a:round/>'
+          str << '</c:spPr>'
         end
-
+        str << '<c:marker><c:symbol val="none"/></c:marker>' unless @show_marker
         @labels.to_xml_string(str) unless @labels.nil?
         @data.to_xml_string(str) unless @data.nil?
       end

data/lib/axlsx/drawing/marker.rb

@@ -5,6 +5,18 @@ module Axlsx
   # @see Worksheet#add_chart
   class Marker
 
+    include Axlsx::OptionsParser
+
+    # Creates a new Marker object
+    # @option options [Integer] col
+    # @option options [Integer] colOff
+    # @option options [Integer] row
+    # @option options [Integer] rowOff
+    def initialize(options={})
+      @col, @colOff, @row, @rowOff = 0, 0, 0, 0
+      parse_options options
+    end
+
     # The column this marker anchors to
     # @return [Integer]
     attr_reader :col
@@ -21,19 +33,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :rowOff
 
-    # Creates a new Marker object
-    # @option options [Integer] col
-    # @option options [Integer] colOff
-    # @option options [Integer] row
-    # @option options [Integer] rowOff
-    def initialize(options={})
-      @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
-
-    # @see col
+     # @see col
     def col=(v) Axlsx::validate_unsigned_int v; @col = v end
     # @see colOff
     def colOff=(v) Axlsx::validate_int v; @colOff = v end
@@ -43,11 +43,14 @@ module Axlsx
     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
-    def coord(col, row)
-      self.col = col
-      self.row = row
+    # @param col the column for the marker, a Cell object or a string reference like "B7"
+    # or an Array.
+    # @param row the row of the marker. This is ignored if the col parameter is a Cell or
+    # String or Array.
+    def coord(col, row=0)
+      coordinates = parse_coord_args(col, row)
+      self.col = coordinates[0]
+      self.row = coordinates[1]
     end
 
     # Serializes the object
@@ -58,6 +61,23 @@ module Axlsx
         str << '<xdr:' << k.to_s << '>' << self.send(k).to_s << '</xdr:' << k.to_s << '>'
       end
     end
+    private
+
+    # 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
 

data/lib/axlsx/drawing/num_data.rb

@@ -4,9 +4,7 @@ module Axlsx
   #This class specifies data for a particular data point. It is used for both numCache and numLit object
   class NumData
 
-    # A string representing the format code to apply. For more information see see the SpreadsheetML numFmt element's (§18.8.30) formatCode attribute.
-    # @return [String]
-    attr_reader :format_code
+    include Axlsx::OptionsParser
 
     # creates a new NumVal object
     # @option options [String] formatCode
@@ -15,11 +13,13 @@ module Axlsx
     def initialize(options={})
       @format_code = "General"
       @pt = SimpleTypedList.new NumVal
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
+    # A string representing the format code to apply. For more information see see the SpreadsheetML numFmt element's (§18.8.30) formatCode attribute.
+    # @return [String]
+    attr_reader :format_code
+
     # Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.
     # @param [Array] values An array of cells or values.
     def data=(values=[])

data/lib/axlsx/drawing/num_data_source.rb

@@ -3,18 +3,7 @@ module Axlsx
   # A numeric data source for use by charts.
   class NumDataSource
 
-    # The tag name to use when serializing this data source.
-    # Only items defined in allowed_tag_names are allowed
-    # @return [Symbol]
-    attr_reader :tag_name
-
-    attr_reader :data
-
-    # allowed element tag names
-    # @return [Array]
-    def self.allowed_tag_names
-      [:yVal, :val]
-    end
+    include Axlsx::OptionsParser
 
     # creates a new NumDataSource object
     # @option options [Array] data An array of Cells or Numeric objects
@@ -30,12 +19,24 @@ module Axlsx
       if options[:data] && options[:data].first.is_a?(Cell)
         @f = Axlsx::cell_range(options[:data])
       end
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
+    end
+
+
+    # The tag name to use when serializing this data source.
+    # Only items defined in allowed_tag_names are allowed
+    # @return [Symbol]
+    attr_reader :tag_name
+
+    attr_reader :data
+
+    # allowed element tag names
+    # @return [Array]
+    def self.allowed_tag_names
+      [:yVal, :val]
     end
 
-    # sets the tag name for this data source
+     # sets the tag name for this data source
     # @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

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -6,6 +6,26 @@ module Axlsx
   # @see Worksheet#add_image
   class OneCellAnchor
 
+    include Axlsx::OptionsParser
+ 
+    # 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
+      parse_options options
+      @object = Pic.new(self, options)
+    end
+
     # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
     # @return [Marker]
     attr_reader :from
@@ -28,27 +48,15 @@ module Axlsx
     # @return [Integer]
     attr_reader :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)
+    # sets the starting position for the anchor.
+    # You can provide a String like "A1", an array like [0,0] or a cell object for the x parameter.
+    # We just 'figure it out' for you.
+    # @param [Array, String, Cell, Integer] x Accepts many inputs for defining the starting position of the cell.
+    # @param [Integer] y When x is an integer, this value is used for the row index at which the anchor starts.
+    def start_at(x, y=0)
+      from.coord x, y
     end
-
+    #
     # @see height
     def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end
 
@@ -61,7 +69,6 @@ module Axlsx
       @drawing.anchors.index(self)
     end
 
-
     # Serializes the object
     # @param [String] str
     # @return [String]

data/lib/axlsx/drawing/pic.rb

@@ -5,6 +5,26 @@ module Axlsx
   # @see Worksheet#add_image
   class Pic
 
+    include Axlsx::OptionsParser
+
+    # 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
+      @hyperlink = nil
+      @anchor.drawing.worksheet.workbook.images << self
+      parse_options options
+      start_at(*options[:start_at]) if options[:start_at]
+      yield self if block_given?
+      @picture_locking = PictureLocking.new(options)
+    end
+
     # allowed file extenstions
     ALLOWED_EXTENSIONS = ['gif', 'jpeg', 'png', 'jpg']
 
@@ -12,13 +32,12 @@ module Axlsx
     # @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
+    # Only local images are supported at this time.
     # @return [String]
     attr_reader :image_src
 
@@ -29,26 +48,6 @@ 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
-    # @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
-      @hyperlink = nil
-      @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
-
     attr_reader :hyperlink
 
     # sets or updates a hyperlink for this image.
@@ -68,7 +67,7 @@ module Axlsx
 
     def image_src=(v)
       Axlsx::validate_string(v)
-      RestrictionValidator.validate 'Pic.image_src', ALLOWED_EXTENSIONS, File.extname(v).delete('.')
+      RestrictionValidator.validate 'Pic.image_src', ALLOWED_EXTENSIONS, File.extname(v.downcase).delete('.')
       raise ArgumentError, "File does not exist" unless File.exist?(v)
       @image_src = v
     end
@@ -90,7 +89,8 @@ 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
@@ -103,9 +103,10 @@ 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
+    # The relationship object for this pic.
+    # @return [Relationship]
+    def relationship
+      Relationship.new(self, IMAGE_R, "../#{pn}")
     end
 
     # providing access to the anchor's width attribute
@@ -136,27 +137,25 @@ module Axlsx
       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
     # @param [Integer] y The row
     # @return [Marker]
-    def start_at(x, y)
-      @anchor.from.col = x
-      @anchor.from.row = y
+    def start_at(x, y=nil)
+      @anchor.start_at x, 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)
+    def end_at(x, y=nil)
       use_two_cell_anchor unless @anchor.is_a?(TwoCellAnchor)
-      @anchor.to.col = x
-      @anchor.to.row = y
+      @anchor.end_at x, y
       @anchor.to
     end
 
@@ -172,36 +171,35 @@ module Axlsx
       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:blip xmlns:r ="' << XML_NS_R << '" r:embed="' << relationship.Id <<  '"/>'
       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
-     
+
     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))
+      new_anchor = OneCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
+      swap_anchor(new_anchor)
     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
+      new_anchor = TwoCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
+      swap_anchor(new_anchor)
     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
+      new_anchor.instance_variable_set "@object", @anchor.object
       @anchor = new_anchor
     end
-
   end
 end

data/lib/axlsx/drawing/picture_locking.rb

@@ -3,17 +3,17 @@ module Axlsx
   # The picture locking class defines the locking properties for pictures in your workbook.
   class PictureLocking
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
 
-    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
+    boolean_attr_accessor :noGrp, :noSelect, :noRot, :noChangeAspect,
+                            :noMove, :noResize, :noEditPoints, :noAdjustHandles,
+                            :noChangeArrowheads, :noChangeShapeType
+
+    serializable_attributes :noGrp, :noSelect, :noRot, :noChangeAspect,
+                            :noMove, :noResize, :noEditPoints, :noAdjustHandles,
+                            :noChangeArrowheads, :noChangeShapeType
 
     # Creates a new PictureLocking object
     # @option options [Boolean] noGrp
@@ -28,47 +28,15 @@ module Axlsx
     # @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
+      parse_options options
     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 object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<a:picLocks '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
 

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -23,6 +23,7 @@ module Axlsx
     # @see Chart
     # @see View3D
     def initialize(frame, options={})
+      @vary_colors = true
       super(frame, options)
       @series_type = PieSeries
       @view_3D = View3D.new({:rot_x =>30, :perspective=>30}.merge(options))
@@ -36,7 +37,7 @@ module Axlsx
       super(str) do |str_inner|
 
         str_inner << '<c:pie3DChart>'
-        str_inner << '<c:varyColors val="1"/>'
+        str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
         @series.each { |ser| ser.to_xml_string(str_inner) }
         d_lbls.to_xml_string(str) if @d_lbls
         str_inner << '</c:pie3DChart>'