Class: Axlsx::Drawing

Inherits:
Object
  • Object
show all
Defined in:
lib/axlsx/drawing/drawing.rb

Overview

Note:

The recommended way to manage drawings is to use the Worksheet.add_chart method.

A Drawing is a canvas for charts. Each worksheet has a single drawing that manages anchors. The anchors reference the charts via graphical frames. This is not a trivial relationship so please do follow the advice in the note. see README for an example of how to create a chart.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(worksheet) ⇒ Drawing

Creates a new Drawing object

Parameters:

  • worksheet (Worksheet) —

    The worksheet that owns this drawing



54
55
56
57
58
59
 
# File 'lib/axlsx/drawing/drawing.rb', line 54

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

Instance Attribute Details

#anchors ⇒ SimpleTypedList (readonly)

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

Returns:

  • (SimpleTypedList) 


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

def anchors
  @anchors
end

#worksheet ⇒ Worksheet (readonly)

The worksheet that owns the drawing

Returns:



45
46
47
 
# File 'lib/axlsx/drawing/drawing.rb', line 45

def worksheet
  @worksheet
end

Instance Method Details

#add_chart(chart_type, options = {}) ⇒ Object

Note:

The recommended way to manage charts is to use Worksheet.add_chart. Please refer to that method for documentation.

Adds a chart to the drawing.

See Also:



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

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

#add_image(options = {}) ⇒ Object

Note:

The recommended way to manage images is to use Worksheet.add_image. Please refer to that method for documentation.

Adds an image to the chart

See Also:



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

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

#charts ⇒ Array

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

Returns:

  • (Array) 


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

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

#hyperlinks ⇒ Array

An array of hyperlink objects associated with this drawings images

Returns:

  • (Array) 


86
87
88
89
 
# File 'lib/axlsx/drawing/drawing.rb', line 86

def hyperlinks
  links = self.images.select { |a| a.hyperlink.is_a?(Hyperlink) }
  links.map { |a| a.hyperlink }
end

#images ⇒ Array

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

Returns:

  • (Array) 


93
94
95
96
 
# File 'lib/axlsx/drawing/drawing.rb', line 93

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

#index ⇒ Integer

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

Returns:

  • (Integer) 


100
101
102
 
# File 'lib/axlsx/drawing/drawing.rb', line 100

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

#pn ⇒ String

The part name for this drawing

Returns:

  • (String) 


112
113
114
 
# File 'lib/axlsx/drawing/drawing.rb', line 112

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

#relationships ⇒ Relationships

The drawing’s relationships.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/axlsx/drawing/drawing.rb', line 124

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
  hyperlinks.each do |hyperlink|
    r << Relationship.new(HYPERLINK_R, hyperlink.href, :target_mode => :External)
  end
  r
end

#rels_pn ⇒ String

The relational part name for this drawing

Returns:

  • (String) 


118
119
120
 
# File 'lib/axlsx/drawing/drawing.rb', line 118

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

#rId ⇒ String

The relation reference id for this drawing

Returns:

  • (String) 


106
107
108
 
# File 'lib/axlsx/drawing/drawing.rb', line 106

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

#to_xml ⇒ String

Serializes the drawing

Returns:

  • (String) 


140
141
142
143
144
145
146
147
 
# File 'lib/axlsx/drawing/drawing.rb', line 140

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, :'xmlns:c'=>XML_NS_C) {
      anchors.each {|anchor| anchor.to_xml(xml) }
    }        
  end
  builder.to_xml(:save_with => 0)
end