summaryrefslogtreecommitdiffhomepage
path: root/lib/axlsx/drawing/two_cell_anchor.rb
blob: 06c0554aee58174fbf70e212f677c2f923f47a16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
module Axlsx
  # This class details the anchor points for drawings.
  # @note The recommended way to manage drawings and charts is Worksheet#add_chart. Anchors are specified by the :start_at and :end_at options to that method.
  # @see Worksheet#add_chart
  class TwoCellAnchor

    # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
    # @return [Marker]
    attr_reader :from
    # A marker that returns the to cell anchor. The default to column and row are 5 and 10 respectively
    # @return [Marker]
    attr_reader :to

    # The frame for your chart
    # @note this will be discontinued in version 2.0 please use object
    # @return [GraphicFrame]
    # attr_reader :graphic_frame

    # The object this anchor hosts
    # @return [Pic, GraphicFrame]
    attr_reader :object

    # The drawing that holds this anchor
    # @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
    # 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
    def initialize(drawing, options={})
      @drawing = drawing
      drawing.anchors << self      
      @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
    end

    # Creates a graphic frame and chart object associated with this anchor
    # @return [Chart]
    def add_chart(chart_type, options)      
      @object = GraphicFrame.new(self, chart_type, options)
      @object.chart
    end

    # The index of this anchor in the drawing
    # @return [Integer]
    def index
      @drawing.anchors.index(self)
    end
    # Serializes the two cell anchor
    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
    # @return [String]
    def to_xml(xml)
      #build it for now, break it down later!
      xml.send('xdr:twoCellAnchor') {
        xml.send('xdr:from') {
          from.to_xml(xml)
        }
        xml.send('xdr:to') {
          to.to_xml(xml)
        }
        @object.to_xml(xml)
        xml.send('xdr:clientData')
      }
    end    

    private

  end
end