summaryrefslogtreecommitdiffhomepage
path: root/lib/axlsx/drawing/title.rb
blob: a85d8e113c71eff488a06e659db4dd7c55d7305b (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
# encoding: UTF-8
module Axlsx
  # A Title stores information about the title of a chart
  class Title

    # The text to be shown. Setting this property directly with a string will remove the cell reference.
    # @return [String]
    attr_reader :text

    # The cell that holds the text for the title. Setting this property will automatically update the text attribute.
    # @return [Cell]
    attr_reader :cell

    # Creates a new Title object
    # @param [String, Cell] title The cell or string to be used for the chart's title
    def initialize(title="")
      self.cell = title if title.is_a?(Cell)
      self.text = title.to_s unless title.is_a?(Cell)
    end

    # @see text
    def text=(v)
      DataTypeValidator.validate 'Title.text', String, v
      @text = v
      @cell = nil
      v
    end

    # @see cell
    def cell=(v)
      DataTypeValidator.validate 'Title.text', Cell, v
      @cell = v
      @text = v.value.to_s
      v
    end

    # Not implemented at this time.
    #def layout=(v) DataTypeValidator.validate 'Title.layout', Layout, v; @layout = v; end
    #def overlay=(v) Axlsx::validate_boolean v; @overlay=v; end
    #def spPr=(v) DataTypeValidator.validate 'Title.spPr', SpPr, v; @spPr = v; end

    # Serializes the object
    # @param [String] str
    # @return [String]
    def to_xml_string(str = '')
      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>'
        str << '</c:tx>'
      end
      str << '<c:layout/>'
      str << '<c:overlay val="0"/>'
      str << '</c:title>'
    end

  end
end