dg-axlsx 2.1.0

data/lib/axlsx/drawing/line_series.rb

@@ -0,0 +1,110 @@
+# encoding: UTF-8
+module Axlsx
+  # A LineSeries defines the title, data and labels for line charts
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class LineSeries < Series
+
+    # The data for this series.
+    # @return [ValAxisData]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [CatAxisData]
+    attr_reader :labels
+
+    # The fill color for this series.
+    # Red, green, and blue is expressed as sequence of hex digits, RRGGBB. A perceptual gamma of 2.2 is used.
+    # @return [String]
+    attr_reader :color
+
+    # show markers on values
+    # @return [Boolean]
+    attr_reader :show_marker
+
+    # custom marker symbol
+    # @return [String]
+    attr_reader :marker_symbol
+
+    # line smoothing on values
+    # @return [Boolean]
+    attr_reader :smooth
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @param [Chart] chart
+    def initialize(chart, options={})
+      @show_marker = false
+      @marker_symbol = options[:marker_symbol] ? options[:marker_symbol] : :default
+      @smooth = false
+      @labels, @data = nil, nil
+      super(chart, options)
+      @labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
+      @data = NumDataSource.new(options) unless options[:data].nil?
+    end
+
+    # @see color
+    def color=(v)
+      @color = v
+    end
+
+    # @see show_marker
+    def show_marker=(v)
+      Axlsx::validate_boolean(v)
+      @show_marker = v
+    end
+
+    # @see marker_symbol
+    def marker_symbol=(v)
+      Axlsx::validate_marker_symbol(v)
+      @marker_symbol = v
+    end
+
+    # @see smooth
+    def smooth=(v)
+      Axlsx::validate_boolean(v)
+      @smooth = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        if color
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          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
+
+        if !@show_marker
+          str << '<c:marker><c:symbol val="none"/></c:marker>'
+        elsif @marker_symbol != :default
+          str << '<c:marker><c:symbol val="' + @marker_symbol.to_s + '"/></c:marker>'
+        end
+
+        @labels.to_xml_string(str) unless @labels.nil?
+        @data.to_xml_string(str) unless @data.nil?
+        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
+      end
+    end
+
+    private
+
+    # assigns the data for this series
+    def data=(v) DataTypeValidator.validate "Series.data", [NumDataSource], v; @data = v; end
+
+    # assigns the labels for this series
+    def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
+
+  end
+end

data/lib/axlsx/drawing/marker.rb

@@ -0,0 +1,84 @@
+# encoding: UTF-8
+module Axlsx
+  # The Marker class defines a point in the worksheet that drawing anchors attach to.
+  # @note The recommended way to manage markers is Worksheet#add_chart Markers are created for a two cell anchor based on the :start and :end options.
+  # @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
+
+    # The offset distance from this marker's column
+    # @return [Integer]
+    attr_reader :colOff
+
+    # The row this marker anchors to
+    # @return [Integer]
+    attr_reader :row
+
+    # The offset distance from this marker's row
+    # @return [Integer]
+    attr_reader :rowOff
+
+     # @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
+    # @see row
+    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, 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
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      [:col, :colOff, :row, :rowOff].each do |k|
+        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
+
+end

data/lib/axlsx/drawing/num_data.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+module Axlsx
+
+  #This class specifies data for a particular data point. It is used for both numCache and numLit object
+  class NumData
+
+    include Axlsx::OptionsParser
+
+    # creates a new NumVal object
+    # @option options [String] formatCode
+    # @option options [Array] :data
+    # @see StrData
+    def initialize(options={})
+      @format_code = "General"
+      @pt = SimpleTypedList.new NumVal
+      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=[])
+      @tag_name = values.first.is_a?(Cell) ? :numCache : :numLit
+      values.each do |value|
+        value = value.is_formula? ? 0 : value.value if value.is_a?(Cell)
+        @pt << NumVal.new(:v => value)
+      end
+    end
+
+    # @see format_code
+    def format_code=(v='General')
+      Axlsx::validate_string(v)
+      @format_code = v
+    end
+
+    # serialize the object
+    def to_xml_string(str = "")
+      str << ('<c:' << @tag_name.to_s << '>')
+      str << ('<c:formatCode>' << format_code.to_s << '</c:formatCode>')
+      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
+      @pt.each_with_index do |num_val, index|
+        num_val.to_xml_string index, str
+      end
+      str << ('</c:' << @tag_name.to_s << '>')
+    end
+
+  end
+
+end

data/lib/axlsx/drawing/num_data_source.rb

@@ -0,0 +1,62 @@
+module Axlsx
+
+  # A numeric data source for use by charts.
+  class NumDataSource
+
+    include Axlsx::OptionsParser
+
+    # creates a new NumDataSource object
+    # @option options [Array] data An array of Cells or Numeric objects
+    # @option options [Symbol] tag_name see tag_name
+    def initialize(options={})
+      # override these three in child classes
+      @data_type ||= NumData
+      @tag_name ||= :val
+      @ref_tag_name ||= :numRef
+
+      @f = nil
+      @data = @data_type.new(options)
+      if options[:data] && options[:data].first.is_a?(Cell)
+        @f = Axlsx::cell_range(options[:data])
+      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, :bubbleSize]
+    end
+
+     # 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
+      @tag_name = v
+    end
+
+    # serialize the object
+    # @param [String] str
+    def to_xml_string(str="")
+      str << ('<c:' << tag_name.to_s << '>')
+      if @f
+        str << ('<c:' << @ref_tag_name.to_s << '>')
+        str << ('<c:f>' << @f.to_s << '</c:f>')
+      end
+      @data.to_xml_string str
+      if @f
+        str << ('</c:' << @ref_tag_name.to_s << '>')
+      end
+      str << ('</c:' << tag_name.to_s << '>')
+    end
+  end
+end
+

data/lib/axlsx/drawing/num_val.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+module Axlsx
+
+  #This class specifies data for a particular data point.
+  class NumVal < StrVal
+
+    # 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 a new NumVal object
+    # @option options [String] formatCode
+    # @option options [Integer] v
+    def initialize(options={})
+      @format_code = "General"
+      super(options)
+    end
+
+    # @see format_code
+    def format_code=(v)
+      Axlsx::validate_string(v)
+      @format_code = v
+    end
+
+    # serialize the object
+    def to_xml_string(idx, str = "")
+      Axlsx::validate_unsigned_int(idx)
+      str << ('<c:pt idx="' << idx.to_s << '" formatCode="' << format_code << '"><c:v>' << v.to_s << '</c:v></c:pt>')
+    end
+  end
+end

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -0,0 +1,98 @@
+# 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.
+  # @see Worksheet#add_chart
+  # @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
+
+    # The object this anchor hosts
+    # @return [Pic]
+    attr_reader :object
+
+    # The drawing that holds this anchor
+    # @return [Drawing]
+    attr_reader :drawing
+
+    # the width of the graphic object in pixels.
+    # this is converted to EMU at a 92 ppi resolution
+    # @return [Integer]
+    attr_reader :width
+
+    # the height of the graphic object in pixels
+    # this is converted to EMU at a 92 ppi resolution
+    # @return [Integer]
+    attr_reader :height
+
+    # 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
+
+    # @see width
+    def width=(v) Axlsx::validate_unsigned_int(v); @width = v; end
+
+    # The index of this anchor in the drawing
+    # @return [Integer]
+    def index
+      @drawing.anchors.index(self)
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    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
+    # !{: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,213 @@
+# 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
+  # @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 [Integer] :width
+    # @option options [Integer] :height
+    # @option options [Float] :opacity - set the picture opacity, accepts a value between 0.0 and 1.0
+    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)
+      @opacity = (options[:opacity] * 100000).round if options[:opacity]
+    end
+
+    # allowed mime types
+    ALLOWED_MIME_TYPES = %w(image/jpeg image/png image/gif)
+
+    # The name to use for this picture
+    # @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.
+    # @return [String]
+    attr_reader :image_src
+
+    # The anchor for this image
+    # @return [OneCellAnchor]
+    attr_reader :anchor
+
+    # The picture locking attributes for this picture
+    attr_reader :picture_locking
+
+    attr_reader :hyperlink
+
+    # Picture opacity
+    # @return [Fixnum]
+    attr_reader :opacity
+
+    # 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_MIME_TYPES, MimeTypeUtils.get_mime_type(v)
+      raise ArgumentError, "File does not exist" unless File.exist?(v)
+      @image_src = v
+    end
+
+    # @see name
+    def name=(v) Axlsx::validate_string(v); @name = v; end
+
+    # @see descr
+    def descr=(v) Axlsx::validate_string(v); @descr = v; end
+
+    # The file name of image_src without any path information
+    # @return [String]
+    def file_name
+      File.basename(image_src) unless image_src.nil?
+    end
+
+    # returns the extension of image_src without the preceeding '.'
+    # @return [String]
+    def extname
+      File.extname(image_src).delete('.') unless image_src.nil?
+    end
+
+    # The index of this image in the workbooks images collections
+    # @return [Index]
+    def index
+      @anchor.drawing.worksheet.workbook.images.index(self)
+    end
+
+    # The part name for this image used in serialization and relationship building
+    # @return [String]
+    def pn
+      "#{IMAGE_PN % [(index+1), extname]}"
+    end
+
+    # 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
+    # @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
+    # 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=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=nil)
+      use_two_cell_anchor unless @anchor.is_a?(TwoCellAnchor)
+      @anchor.end_at x, y
+      @anchor.to
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    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="' << relationship.Id << '">')
+      if opacity
+        str << "<a:alphaModFix amt=\"#{opacity}\"/>"
+      end
+      str << '</a:blip>'
+      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)
+      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)
+      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