Sha256: be1613bfba9d6bac4ca9e0aaea2eb23c5dd4737163bad833015cd6de8805d02e

Contents?: true

Size: 1.81 KB

Versions: 14

Compression:

Stored size: 1.81 KB

Contents

# 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

    # 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

    # 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
    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
    # @param row the row of the marker
    def coord(col, row)
      self.col = col
      self.row = row
    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

  end

end

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
axlsx-1.3.1 lib/axlsx/drawing/marker.rb
axlsx-1.2.3 lib/axlsx/drawing/marker.rb
axlsx-1.2.2 lib/axlsx/drawing/marker.rb
axlsx-1.2.1 lib/axlsx/drawing/marker.rb
axlsx-1.2.0 lib/axlsx/drawing/marker.rb
axlsx-1.1.8 lib/axlsx/drawing/marker.rb
axlsx-1.1.7 lib/axlsx/drawing/marker.rb
axlsx-1.1.6 lib/axlsx/drawing/marker.rb
axlsx-1.1.5 lib/axlsx/drawing/marker.rb
axlsx-1.1.4 lib/axlsx/drawing/marker.rb
axlsx-1.1.3 lib/axlsx/drawing/marker.rb
axlsx-1.1.2 lib/axlsx/drawing/marker.rb
axlsx-1.1.1 lib/axlsx/drawing/marker.rb
axlsx-1.1.0 lib/axlsx/drawing/marker.rb