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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
# -*- coding: utf-8 -*-
module Axlsx
# A Chart is the superclass for specific charts
# @note Worksheet#add_chart is the recommended way to create charts for your worksheets.
# @see README for examples
class Chart
# The 3D view properties for the chart
attr_reader :view3D
# A reference to the graphic frame that owns this chart
# @return [GraphicFrame]
attr_reader :graphic_frame
# A collection of series objects that are applied to the chart
# @return [SimpleTypedList]
attr_reader :series
# The type of series to use for this chart.
# @return [Series]
attr_reader :series_type
#TODO data labels!
#attr_reader :dLabls
# The title object for the chart.
# @return [Title]
attr_reader :title
# The style for the chart.
# see ECMA Part 1 §21.2.2.196
# @return [Integer]
attr_reader :style
# Show the legend in the chart
# @return [Boolean]
attr_reader :show_legend
# Creates a new chart object
# @param [GraphicalFrame] frame The frame that holds this chart.
# @option options [Cell, String] title
# @option options [Boolean] show_legend
def initialize(frame, options={})
@style = 2
@graphic_frame=frame
@graphic_frame.anchor.drawing.worksheet.workbook.charts << self
@series = SimpleTypedList.new Series
@show_legend = true
@series_type = Series
@title = Title.new
options.each do |o|
self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
end
start_at *options[:start_at] if options[:start_at]
end_at *options[:end_at] if options[:start_at]
yield self if block_given?
end
# The index of this chart in the workbooks charts collection
# @return [Integer]
def index
@graphic_frame.anchor.drawing.worksheet.workbook.charts.index(self)
end
# The part name for this chart
# @return [String]
def pn
"#{CHART_PN % (index+1)}"
end
# The title object for the chart.
# @param [String, Cell] v
# @return [Title]
def title=(v)
DataTypeValidator.validate "#{self.class}.title", [String, Cell], v
if v.is_a?(String)
@title.text = v
elsif v.is_a?(Cell)
@title.cell = v
end
end
# Show the legend in the chart
# @param [Boolean] v
# @return [Boolean]
def show_legend=(v) Axlsx::validate_boolean(v); @show_legend = v; end
# The style for the chart.
# see ECMA Part 1 §21.2.2.196
# @param [Integer] v must be between 1 and 48
def style=(v) DataTypeValidator.validate "Chart.style", Integer, v, lambda { |arg| arg >= 1 && arg <= 48 }; @style = v; end
# backwards compatibility to allow chart.to and chart.from access to anchor markers
# @note This will be disconinued in version 2.0.0. Please use the end_at method
def to
@graphic_frame.anchor.to
end
# backwards compatibility to allow chart.to and chart.from access to anchor markers
# @note This will be disconinued in version 2.0.0. please use the start_at method
def from
@graphic_frame.anchor.from
end
# Adds a new series to the chart's series collection.
# @return [Series]
# @see Series
def add_series(options={})
@series_type.new(self, options)
@series.last
end
# Chart Serialization
# serializes the chart
def to_xml
builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
xml.send('c:chartSpace', :'xmlns:c' => XML_NS_C, :'xmlns:a' => XML_NS_A) {
xml[:c].date1904 :val => Axlsx::Workbook.date1904
xml[:c].style :val=>style
xml[:c].chart {
@title.to_xml(xml)
xml.autoTitleDeleted :val=>0
@view3D.to_xml(xml) unless @view3D.nil?
xml.floor { xml.thickness(:val=>0) }
xml.sideWall { xml.thickness(:val=>0) }
xml.backWall { xml.thickness(:val=>0) }
xml.plotArea {
xml.layout
yield xml if block_given?
}
if @show_legend
xml.legend {
xml.legendPos :val => "r"
xml.layout
xml.overlay :val => 0
}
end
xml.plotVisOnly :val => 1
xml.dispBlanksAs :val => :zero
xml.showDLblsOverMax :val => 1
}
}
end
builder.to_xml(:save_with => 0)
end
# This is a short cut method to set the start anchor position
# If you need finer granularity in positioning use
# graphic_frame.anchor.from.colOff / rowOff
# @param [Integer] x The column
# @param [Integer] y The row
# @return [Marker]
def start_at(x, y=0)
x, y = *parse_coord_args(x, y)
@graphic_frame.anchor.from.col = x
@graphic_frame.anchor.from.row = y
end
# This is a short cut method to set the end anchor position
# If you need finer granularity in positioning use
# graphic_frame.anchor.to.colOff / rowOff
# @param [Integer] x The column
# @param [Integer] y The row
# @return [Marker]
def end_at(x, y=0)
x, y = *parse_coord_args(x, y)
@graphic_frame.anchor.to.col = x
@graphic_frame.anchor.to.row = y
end
private
def parse_coord_args(x, y=0)
if x.is_a?(String)
x, y = *Axlsx::name_to_indices(x)
end
if x.is_a?(Cell)
x, y = *x.pos
end
if x.is_a?(Array)
x, y = *x
end
[x, y]
end
def view3D=(v) DataTypeValidator.validate "#{self.class}.view3D", View3D, v; @view3D = v; end
end
end
|
