Class: Axlsx::Drawing

Inherits:

Object

• Object
• Axlsx::Drawing

show all

Defined in:

lib/axlsx/drawing/drawing.rb

Overview

Instance Attribute Summary (collapse)

• - (SimpleTypedList) anchors readonly

  A collection of anchors for this drawing only TwoCellAnchors are supported in this version.

• - (Array) charts readonly

  An array of charts that are associated with this drawing’s anchors.

• - (Array) images readonly

  An array of image objects that are associated with this drawing’s anchors.

• - (Integer) index readonly

  The index of this drawing in the owning workbooks’s drawings collection.

• - (String) pn readonly

  The part name for this drawing.

• - (Relationships) relationships readonly

  The drawing’s relationships.

• - (String) rels_pn readonly

  The relational part name for this drawing.

• - (String) rId readonly

  The relation reference id for this drawing.

• - (Worksheet) worksheet readonly

  The worksheet that owns the drawing.

Instance Method Summary (collapse)

• - (Object) add_chart(chart_type, options = {})

  Adds a chart to the drawing.

• - (Object) add_image(options = {})

  Adds an image to the chart.

• - (Drawing) initialize(worksheet) constructor

  Creates a new Drawing object.

• - (String) to_xml

  Serializes the drawing.

80
81
82
83
84
85

# File 'lib/axlsx/drawing/drawing.rb', line 80

def initialize(worksheet)
  DataTypeValidator.validate "Drawing.worksheet", Worksheet, worksheet
  @worksheet = worksheet
  @worksheet.workbook.drawings << self
  @anchors = SimpleTypedList.new [TwoCellAnchor, OneCellAnchor]
end

48
49
50

# File 'lib/axlsx/drawing/drawing.rb', line 48

def anchors
  @anchors
end

52
53
54
55

# File 'lib/axlsx/drawing/drawing.rb', line 52

def charts
  charts = @anchors.select { |a| a.object.is_a?(GraphicFrame) }
  charts.map { |a| a.object.chart }
end

56
57
58
59

# File 'lib/axlsx/drawing/drawing.rb', line 56

def images
  images = @anchors.select { |a| a.object.is_a?(Pic) }
  images.map { |a| a.object }
end

60
61
62

# File 'lib/axlsx/drawing/drawing.rb', line 60

def index
  @worksheet.workbook.drawings.index(self)
end

68
69
70

# File 'lib/axlsx/drawing/drawing.rb', line 68

def pn
  "#{DRAWING_PN % (index+1)}"
end

76
77
78
79
80
81
82
83
84
85

# File 'lib/axlsx/drawing/drawing.rb', line 76

def relationships
  r = Relationships.new
  charts.each do |chart|
    r << Relationship.new(CHART_R, "../#{chart.pn}")
  end
  images.each do |image|
    r << Relationship.new(IMAGE_R, "../#{image.pn}")
  end
  r
end

72
73
74

# File 'lib/axlsx/drawing/drawing.rb', line 72

def rels_pn
  "#{DRAWING_RELS_PN % (index+1)}"
end

64
65
66

# File 'lib/axlsx/drawing/drawing.rb', line 64

def rId
  "rId#{index+1}"
end

43
44
45

# File 'lib/axlsx/drawing/drawing.rb', line 43

def worksheet
  @worksheet
end

98
99
100
101

# File 'lib/axlsx/drawing/drawing.rb', line 98

def add_chart(chart_type, options={})
  TwoCellAnchor.new(self, options)
  @anchors.last.add_chart(chart_type, options)
end

90
91
92
93

# File 'lib/axlsx/drawing/drawing.rb', line 90

def add_image(options={})
  OneCellAnchor.new(self, options)
  @anchors.last.object
end

142
143
144
145
146
147
148
149

# File 'lib/axlsx/drawing/drawing.rb', line 142

def to_xml
  builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
    xml.send('xdr:wsDr', :'xmlns:xdr'=>XML_NS_XDR, :'xmlns:a'=>XML_NS_A) {
      anchors.each {|anchor| anchor.to_xml(xml) }
    }        
  end
  builder.to_xml
end