Class: Axlsx::Drawing
- Inherits:
-
Object
- Object
- Axlsx::Drawing
- Defined in:
- lib/axlsx/drawing/drawing.rb
Overview
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.
Instance Attribute Summary collapse
-
#anchors ⇒ SimpleTypedList
readonly
A collection of anchors for this drawing only TwoCellAnchors are supported in this version.
-
#worksheet ⇒ Worksheet
readonly
The worksheet that owns the drawing.
Instance Method Summary collapse
-
#add_chart(chart_type, options = {}) ⇒ Object
Adds a chart to the drawing.
-
#add_image(options = {}) ⇒ Pic
Adds an image to the chart If th end_at option is specified we create a two cell anchor.
-
#charts ⇒ Array
An array of charts that are associated with this drawing’s anchors.
-
#hyperlinks ⇒ Array
An array of hyperlink objects associated with this drawings images.
-
#images ⇒ Array
An array of image objects that are associated with this drawing’s anchors.
-
#index ⇒ Integer
The index of this drawing in the owning workbooks’s drawings collection.
-
#initialize(worksheet) ⇒ Drawing
constructor
Creates a new Drawing object.
-
#pn ⇒ String
The part name for this drawing.
-
#relationships ⇒ Relationships
The drawing’s relationships.
-
#rels_pn ⇒ String
The relational part name for this drawing.
-
#rId ⇒ String
The relation reference id for this drawing.
-
#to_xml_string(str = '') ⇒ String
Serializes the object.
Constructor Details
#initialize(worksheet) ⇒ Drawing
Creates a new Drawing object
64 65 66 67 68 69 |
# File 'lib/axlsx/drawing/drawing.rb', line 64 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
60 61 62 |
# File 'lib/axlsx/drawing/drawing.rb', line 60 def anchors @anchors end |
#worksheet ⇒ Worksheet (readonly)
The worksheet that owns the drawing
55 56 57 |
# File 'lib/axlsx/drawing/drawing.rb', line 55 def worksheet @worksheet end |
Instance Method Details
#add_chart(chart_type, options = {}) ⇒ Object
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.
87 88 89 90 |
# File 'lib/axlsx/drawing/drawing.rb', line 87 def add_chart(chart_type, ={}) TwoCellAnchor.new(self, ) @anchors.last.add_chart(chart_type, ) end |
#add_image(options = {}) ⇒ Pic
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 If th end_at option is specified we create a two cell anchor. By default we use a one cell anchor.
75 76 77 78 79 80 81 82 |
# File 'lib/axlsx/drawing/drawing.rb', line 75 def add_image(={}) if [:end_at] TwoCellAnchor.new(self, ).add_pic() else OneCellAnchor.new(self, ) end @anchors.last.object end |
#charts ⇒ Array
An array of charts that are associated with this drawing’s anchors
94 95 96 97 |
# File 'lib/axlsx/drawing/drawing.rb', line 94 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
101 102 103 104 |
# File 'lib/axlsx/drawing/drawing.rb', line 101 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
108 109 110 111 |
# File 'lib/axlsx/drawing/drawing.rb', line 108 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.
115 116 117 |
# File 'lib/axlsx/drawing/drawing.rb', line 115 def index @worksheet.workbook.drawings.index(self) end |
#pn ⇒ String
The part name for this drawing
127 128 129 |
# File 'lib/axlsx/drawing/drawing.rb', line 127 def pn "#{DRAWING_PN % (index+1)}" end |
#relationships ⇒ Relationships
The drawing’s relationships.
139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/axlsx/drawing/drawing.rb', line 139 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
133 134 135 |
# File 'lib/axlsx/drawing/drawing.rb', line 133 def rels_pn "#{DRAWING_RELS_PN % (index+1)}" end |
#rId ⇒ String
The relation reference id for this drawing
121 122 123 |
# File 'lib/axlsx/drawing/drawing.rb', line 121 def rId "rId#{index+1}" end |
#to_xml_string(str = '') ⇒ String
Serializes the object
156 157 158 159 160 161 162 |
# File 'lib/axlsx/drawing/drawing.rb', line 156 def to_xml_string(str = '') str << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' str << '<xdr:wsDr xmlns:xdr="' << XML_NS_XDR << '" xmlns:a="' << XML_NS_A << '">' anchors.each { |anchor| anchor.to_xml_string(str) } str << '</xdr:wsDr>' end |