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
194
195
196
197
198
199
200
201
202
203
204
|
# encoding: 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
include Axlsx::OptionsParser
# Creates a new chart object
# @param [GraphicalFrame] frame The frame that holds this chart.
# @option options [Cell, String] title
# @option options [Boolean] show_legend
# @option options [Array|String|Cell] start_at The X, Y coordinates defining the top left corner of the chart.
# @option options [Array|String|Cell] end_at The X, Y coordinates defining the bottom right corner of the chart.
def initialize(frame, options={})
@style = 18
@view_3D = nil
@graphic_frame=frame
@graphic_frame.anchor.drawing.worksheet.workbook.charts << self
@series = SimpleTypedList.new Series
@show_legend = true
@series_type = Series
@title = Title.new
parse_options options
start_at(*options[:start_at]) if options[:start_at]
end_at(*options[:end_at]) if options[:end_at]
yield self if block_given?
end
# The 3D view properties for the chart
attr_reader :view_3D
alias :view3D :view_3D
# 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!
def d_lbls
@d_lbls ||= DLbls.new(self.class)
end
# 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
# 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
# Serializes the object
# @param [String] str
# @return [String]
def to_xml_string(str = '')
str << '<?xml version="1.0" encoding="UTF-8"?>'
str << '<c:chartSpace xmlns:c="' << XML_NS_C << '" xmlns:a="' << XML_NS_A << '" xmlns:r="' << XML_NS_R << '">'
str << '<c:date1904 val="' << Axlsx::Workbook.date1904.to_s << '"/>'
str << '<c:style val="' << style.to_s << '"/>'
str << '<c:chart>'
@title.to_xml_string str
# do these need the c: namespace as well???
str << '<c:autoTitleDeleted val="' << (@title == nil).to_s << '"/>'
@view_3D.to_xml_string(str) if @view_3D
str << '<c:floor><c:thickness val="0"/></c:floor>'
str << '<c:sideWall><c:thickness val="0"/></c:sideWall>'
str << '<c:backWall><c:thickness val="0"/></c:backWall>'
str << '<c:plotArea>'
str << '<c:layout/>'
yield str if block_given?
str << '</c:plotArea>'
if @show_legend
str << '<c:legend>'
str << '<c:legendPos val="r"/>'
str << '<c:layout/>'
str << '<c:overlay val="0"/>'
str << '</c:legend>'
end
str << '<c:plotVisOnly val="1"/>'
str << '<c:dispBlanksAs val="zero"/>'
str << '<c:showDLblsOverMax val="1"/>'
str << '</c:chart>'
str << '<c:printSettings>'
str << '<c:headerFooter/>'
str << '<c:pageMargins b="1.0" l="0.75" r="0.75" t="1.0" header="0.5" footer="0.5"/>'
str << '<c:pageSetup/>'
str << '</c:printSettings>'
str << '</c:chartSpace>'
end
# This is a short cut method to set the anchor start marker position
# If you need finer granularity in positioning use
#
# This helper method acceps a fairly wide range of inputs exampled
# below
#
# @example
#
# start_at 0, 5 # The anchor start marker is set to 6th row of
# the first column
#
# start_at [0, 5] # The anchor start marker is set to start on the 6th row
# of the first column
#
# start_at "C1" # The anchor start marker is set to start on the first row
# of the third column
#
# start_at sheet.rows.first.cells.last # The anchor start
# marker is set to the location of a specific cell.
#
# @param [Array|String|Cell] x the column, coordinates, string
# reference or cell to use in setting the start marker position.
# @param [Integer] y The row
# @return [Marker]
def start_at(x=0, y=0)
@graphic_frame.anchor.start_at(x, 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 - default 10
# @param [Integer] y The row - default 10
# @return [Marker]
# @see start_at
def end_at(x=10, y=10)
@graphic_frame.anchor.end_at(x, y)
end
# sets the view_3D object for the chart
def view_3D=(v) DataTypeValidator.validate "#{self.class}.view_3D", View3D, v; @view_3D = v; end
alias :view3D= :view_3D=
end
end
|
