axlsx 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +10 -9
- data/doc/Axlsx.html +2443 -0
- data/doc/Axlsx/App.html +2640 -0
- data/doc/Axlsx/Axis.html +1047 -0
- data/doc/Axlsx/Bar3DChart.html +1153 -0
- data/doc/Axlsx/BarSeries.html +764 -0
- data/doc/Axlsx/Border.html +775 -0
- data/doc/Axlsx/BorderPr.html +709 -0
- data/doc/Axlsx/CatAxis.html +766 -0
- data/doc/Axlsx/Cell.html +1623 -0
- data/doc/Axlsx/CellAlignment.html +1247 -0
- data/doc/Axlsx/CellProtection.html +565 -0
- data/doc/Axlsx/CellStyle.html +949 -0
- data/doc/Axlsx/Chart.html +1459 -0
- data/doc/Axlsx/Color.html +665 -0
- data/doc/Axlsx/ContentType.html +340 -0
- data/doc/Axlsx/Core.html +465 -0
- data/doc/Axlsx/DataTypeValidator.html +324 -0
- data/doc/Axlsx/Default.html +575 -0
- data/doc/Axlsx/Drawing.html +1154 -0
- data/doc/Axlsx/Fill.html +460 -0
- data/doc/Axlsx/Font.html +1554 -0
- data/doc/Axlsx/GradientFill.html +1026 -0
- data/doc/Axlsx/GradientStop.html +526 -0
- data/doc/Axlsx/GraphicFrame.html +646 -0
- data/doc/Axlsx/Line3DChart.html +921 -0
- data/doc/Axlsx/LineSeries.html +656 -0
- data/doc/Axlsx/Marker.html +857 -0
- data/doc/Axlsx/NumFmt.html +562 -0
- data/doc/Axlsx/Override.html +568 -0
- data/doc/Axlsx/Package.html +1293 -0
- data/doc/Axlsx/PatternFill.html +681 -0
- data/doc/Axlsx/Pie3DChart.html +439 -0
- data/doc/Axlsx/PieSeries.html +762 -0
- data/doc/Axlsx/RegexValidator.html +268 -0
- data/doc/Axlsx/Relationship.html +554 -0
- data/doc/Axlsx/Relationships.html +343 -0
- data/doc/Axlsx/RestrictionValidator.html +300 -0
- data/doc/Axlsx/Row.html +771 -0
- data/doc/Axlsx/Scaling.html +740 -0
- data/doc/Axlsx/SerAxis.html +624 -0
- data/doc/Axlsx/Series.html +746 -0
- data/doc/Axlsx/SeriesTitle.html +289 -0
- data/doc/Axlsx/SimpleTypedList.html +1617 -0
- data/doc/Axlsx/Styles.html +1754 -0
- data/doc/Axlsx/TableStyle.html +710 -0
- data/doc/Axlsx/TableStyleElement.html +677 -0
- data/doc/Axlsx/TableStyles.html +599 -0
- data/doc/Axlsx/Title.html +625 -0
- data/doc/Axlsx/TwoCellAnchor.html +1115 -0
- data/doc/Axlsx/ValAxis.html +539 -0
- data/doc/Axlsx/View3D.html +971 -0
- data/doc/Axlsx/Workbook.html +1347 -0
- data/doc/Axlsx/Worksheet.html +1864 -0
- data/doc/Axlsx/Xf.html +1681 -0
- data/doc/_index.html +611 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +262 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +262 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +3038 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/axlsx/util/constants.rb +1 -1
- metadata +71 -3
|
@@ -0,0 +1,764 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Axlsx::BarSeries
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.7.3
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
relpath = '..';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
35
|
+
|
|
36
|
+
<a href="../_index.html">Index (B)</a> »
|
|
37
|
+
<span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
|
|
38
|
+
»
|
|
39
|
+
<span class="title">BarSeries</span>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<div id="search">
|
|
46
|
+
|
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
48
|
+
|
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
50
|
+
|
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
<div class="clear"></div>
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<iframe id="search_frame"></iframe>
|
|
58
|
+
|
|
59
|
+
<div id="content"><h1>Class: Axlsx::BarSeries
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</h1>
|
|
64
|
+
|
|
65
|
+
<dl class="box">
|
|
66
|
+
|
|
67
|
+
<dt class="r1">Inherits:</dt>
|
|
68
|
+
<dd class="r1">
|
|
69
|
+
<span class="inheritName"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li>
|
|
75
|
+
|
|
76
|
+
<li class="next">Axlsx::BarSeries</li>
|
|
77
|
+
|
|
78
|
+
</ul>
|
|
79
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
80
|
+
|
|
81
|
+
</dd>
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
<dt class="r2 last">Defined in:</dt>
|
|
92
|
+
<dd class="r2 last">lib/axlsx/drawing/bar_series.rb</dd>
|
|
93
|
+
|
|
94
|
+
</dl>
|
|
95
|
+
<div class="clear"></div>
|
|
96
|
+
|
|
97
|
+
<h2>Overview</h2><div class="docstring">
|
|
98
|
+
<div class="discussion">
|
|
99
|
+
|
|
100
|
+
<div class="note notetag">
|
|
101
|
+
<strong>Note:</strong>
|
|
102
|
+
<div class='inline'><p>
|
|
103
|
+
The recommended way to manage series is to use Chart#add_series
|
|
104
|
+
</p>
|
|
105
|
+
</div>
|
|
106
|
+
</div>
|
|
107
|
+
|
|
108
|
+
<p>
|
|
109
|
+
A BarSeries defines the title, data and labels for bar charts
|
|
110
|
+
</p>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
</div>
|
|
115
|
+
<div class="tags">
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<h3>See Also:</h3>
|
|
119
|
+
<ul class="see">
|
|
120
|
+
|
|
121
|
+
<li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li>
|
|
122
|
+
|
|
123
|
+
<li><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</a></span></li>
|
|
124
|
+
|
|
125
|
+
</ul>
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
134
|
+
<ul class="summary">
|
|
135
|
+
|
|
136
|
+
<li class="public ">
|
|
137
|
+
<span class="summary_signature">
|
|
138
|
+
|
|
139
|
+
<a href="#data-instance_method" title="#data (instance method)">- (Array, SimpleTypedList) <strong>data</strong> </a>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
</span>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
156
|
+
The data for this series.
|
|
157
|
+
</p>
|
|
158
|
+
</div></span>
|
|
159
|
+
|
|
160
|
+
</li>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<li class="public ">
|
|
164
|
+
<span class="summary_signature">
|
|
165
|
+
|
|
166
|
+
<a href="#labels-instance_method" title="#labels (instance method)">- (Array, SimpleTypedList) <strong>labels</strong> </a>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</span>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
183
|
+
The labels for this series.
|
|
184
|
+
</p>
|
|
185
|
+
</div></span>
|
|
186
|
+
|
|
187
|
+
</li>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<li class="public ">
|
|
191
|
+
<span class="summary_signature">
|
|
192
|
+
|
|
193
|
+
<a href="#shape-instance_method" title="#shape (instance method)">- (Symbol) <strong>shape</strong> </a>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
</span>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
210
|
+
The shabe of the bars or columns must be one of [:percentStacked,
|
|
211
|
+
:clustered, :standard, :stacked].
|
|
212
|
+
</p>
|
|
213
|
+
</div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</ul>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3>
|
|
228
|
+
<p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">order</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
<h2>
|
|
233
|
+
Instance Method Summary
|
|
234
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
235
|
+
</h2>
|
|
236
|
+
|
|
237
|
+
<ul class="summary">
|
|
238
|
+
|
|
239
|
+
<li class="public ">
|
|
240
|
+
<span class="summary_signature">
|
|
241
|
+
|
|
242
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (BarSeries) <strong>initialize</strong>(chart, options = {}) </a>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</span>
|
|
247
|
+
|
|
248
|
+
<span class="note title constructor">constructor</span>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
258
|
+
Creates a new series.
|
|
259
|
+
</p>
|
|
260
|
+
</div></span>
|
|
261
|
+
|
|
262
|
+
</li>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<li class="public ">
|
|
266
|
+
<span class="summary_signature">
|
|
267
|
+
|
|
268
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</span>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
282
|
+
Serializes the series.
|
|
283
|
+
</p>
|
|
284
|
+
</div></span>
|
|
285
|
+
|
|
286
|
+
</li>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
</ul>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<div id="constructor_details" class="method_details_list">
|
|
298
|
+
<h2>Constructor Details</h2>
|
|
299
|
+
|
|
300
|
+
<div class="method_details first">
|
|
301
|
+
<p class="signature first" id="initialize-instance_method">
|
|
302
|
+
|
|
303
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::BarSeries (class)">BarSeries</a></span></tt>) <strong>initialize</strong>(chart, options = {})
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
</p><div class="docstring">
|
|
308
|
+
<div class="discussion">
|
|
309
|
+
<p>
|
|
310
|
+
Creates a new series
|
|
311
|
+
</p>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
</div>
|
|
315
|
+
</div>
|
|
316
|
+
<div class="tags">
|
|
317
|
+
<h3>Parameters:</h3>
|
|
318
|
+
<ul class="param">
|
|
319
|
+
|
|
320
|
+
<li>
|
|
321
|
+
|
|
322
|
+
<span class='name'>chart</span>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
</li>
|
|
330
|
+
|
|
331
|
+
<li>
|
|
332
|
+
|
|
333
|
+
<span class='name'>options</span>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
—
|
|
343
|
+
<div class='inline'><p>
|
|
344
|
+
a customizable set of options
|
|
345
|
+
</p>
|
|
346
|
+
</div>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
</ul>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
358
|
+
<ul class="option">
|
|
359
|
+
|
|
360
|
+
<li>
|
|
361
|
+
<span class="name">data</span>
|
|
362
|
+
<span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
363
|
+
<span class="default">
|
|
364
|
+
|
|
365
|
+
</span>
|
|
366
|
+
|
|
367
|
+
</li>
|
|
368
|
+
|
|
369
|
+
<li>
|
|
370
|
+
<span class="name">labels</span>
|
|
371
|
+
<span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
372
|
+
<span class="default">
|
|
373
|
+
|
|
374
|
+
</span>
|
|
375
|
+
|
|
376
|
+
</li>
|
|
377
|
+
|
|
378
|
+
<li>
|
|
379
|
+
<span class="name">title</span>
|
|
380
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
381
|
+
<span class="default">
|
|
382
|
+
|
|
383
|
+
</span>
|
|
384
|
+
|
|
385
|
+
</li>
|
|
386
|
+
|
|
387
|
+
<li>
|
|
388
|
+
<span class="name">shape</span>
|
|
389
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
390
|
+
<span class="default">
|
|
391
|
+
|
|
392
|
+
</span>
|
|
393
|
+
|
|
394
|
+
</li>
|
|
395
|
+
|
|
396
|
+
</ul>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
</div><table class="source_code">
|
|
401
|
+
<tr>
|
|
402
|
+
<td>
|
|
403
|
+
<pre class="lines">
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
28
|
|
407
|
+
29
|
|
408
|
+
30
|
|
409
|
+
31
|
|
410
|
+
32
|
|
411
|
+
33</pre>
|
|
412
|
+
</td>
|
|
413
|
+
<td>
|
|
414
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 28</span>
|
|
415
|
+
|
|
416
|
+
<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
417
|
+
<span class='@shape ivar id'>@shape</span> <span class='assign token'>=</span> <span class='symbol val'>:box</span>
|
|
418
|
+
<span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
|
|
419
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
|
|
420
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier id'>labels</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
|
|
421
|
+
<span class='end end kw'>end</span>
|
|
422
|
+
</pre>
|
|
423
|
+
</td>
|
|
424
|
+
</tr>
|
|
425
|
+
</table>
|
|
426
|
+
</div>
|
|
427
|
+
|
|
428
|
+
</div>
|
|
429
|
+
|
|
430
|
+
<div id="instance_attr_details" class="attr_details">
|
|
431
|
+
<h2>Instance Attribute Details</h2>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
<span id="data=-instance_method"></span>
|
|
435
|
+
<span id="data-instance_method"></span>
|
|
436
|
+
<div class="method_details first">
|
|
437
|
+
<p class="signature first" id="data-instance_method">
|
|
438
|
+
|
|
439
|
+
- (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>data</strong>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
</p><div class="docstring">
|
|
444
|
+
<div class="discussion">
|
|
445
|
+
<p>
|
|
446
|
+
The data for this series.
|
|
447
|
+
</p>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</div>
|
|
451
|
+
</div>
|
|
452
|
+
<div class="tags">
|
|
453
|
+
|
|
454
|
+
<h3>Returns:</h3>
|
|
455
|
+
<ul class="return">
|
|
456
|
+
|
|
457
|
+
<li>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</li>
|
|
465
|
+
|
|
466
|
+
</ul>
|
|
467
|
+
|
|
468
|
+
</div><table class="source_code">
|
|
469
|
+
<tr>
|
|
470
|
+
<td>
|
|
471
|
+
<pre class="lines">
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
11
|
|
475
|
+
12
|
|
476
|
+
13</pre>
|
|
477
|
+
</td>
|
|
478
|
+
<td>
|
|
479
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 11</span>
|
|
480
|
+
|
|
481
|
+
<span class='def def kw'>def</span> <span class='data identifier id'>data</span>
|
|
482
|
+
<span class='@data ivar id'>@data</span>
|
|
483
|
+
<span class='end end kw'>end</span>
|
|
484
|
+
</pre>
|
|
485
|
+
</td>
|
|
486
|
+
</tr>
|
|
487
|
+
</table>
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<span id="labels=-instance_method"></span>
|
|
492
|
+
<span id="labels-instance_method"></span>
|
|
493
|
+
<div class="method_details ">
|
|
494
|
+
<p class="signature " id="labels-instance_method">
|
|
495
|
+
|
|
496
|
+
- (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>labels</strong>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
</p><div class="docstring">
|
|
501
|
+
<div class="discussion">
|
|
502
|
+
<p>
|
|
503
|
+
The labels for this series.
|
|
504
|
+
</p>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
</div>
|
|
508
|
+
</div>
|
|
509
|
+
<div class="tags">
|
|
510
|
+
|
|
511
|
+
<h3>Returns:</h3>
|
|
512
|
+
<ul class="return">
|
|
513
|
+
|
|
514
|
+
<li>
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
<span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</li>
|
|
522
|
+
|
|
523
|
+
</ul>
|
|
524
|
+
|
|
525
|
+
</div><table class="source_code">
|
|
526
|
+
<tr>
|
|
527
|
+
<td>
|
|
528
|
+
<pre class="lines">
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
15
|
|
532
|
+
16
|
|
533
|
+
17</pre>
|
|
534
|
+
</td>
|
|
535
|
+
<td>
|
|
536
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 15</span>
|
|
537
|
+
|
|
538
|
+
<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span>
|
|
539
|
+
<span class='@labels ivar id'>@labels</span>
|
|
540
|
+
<span class='end end kw'>end</span>
|
|
541
|
+
</pre>
|
|
542
|
+
</td>
|
|
543
|
+
</tr>
|
|
544
|
+
</table>
|
|
545
|
+
</div>
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
<span id="shape=-instance_method"></span>
|
|
549
|
+
<span id="shape-instance_method"></span>
|
|
550
|
+
<div class="method_details ">
|
|
551
|
+
<p class="signature " id="shape-instance_method">
|
|
552
|
+
|
|
553
|
+
- (<tt>Symbol</tt>) <strong>shape</strong>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
</p><div class="docstring">
|
|
558
|
+
<div class="discussion">
|
|
559
|
+
<p>
|
|
560
|
+
The shabe of the bars or columns must be one of [:percentStacked,
|
|
561
|
+
:clustered, :standard, :stacked]
|
|
562
|
+
</p>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</div>
|
|
566
|
+
</div>
|
|
567
|
+
<div class="tags">
|
|
568
|
+
|
|
569
|
+
<h3>Returns:</h3>
|
|
570
|
+
<ul class="return">
|
|
571
|
+
|
|
572
|
+
<li>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
</li>
|
|
580
|
+
|
|
581
|
+
</ul>
|
|
582
|
+
|
|
583
|
+
</div><table class="source_code">
|
|
584
|
+
<tr>
|
|
585
|
+
<td>
|
|
586
|
+
<pre class="lines">
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
20
|
|
590
|
+
21
|
|
591
|
+
22</pre>
|
|
592
|
+
</td>
|
|
593
|
+
<td>
|
|
594
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 20</span>
|
|
595
|
+
|
|
596
|
+
<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span>
|
|
597
|
+
<span class='@shape ivar id'>@shape</span>
|
|
598
|
+
<span class='end end kw'>end</span>
|
|
599
|
+
</pre>
|
|
600
|
+
</td>
|
|
601
|
+
</tr>
|
|
602
|
+
</table>
|
|
603
|
+
</div>
|
|
604
|
+
|
|
605
|
+
</div>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
<div id="instance_method_details" class="method_details_list">
|
|
609
|
+
<h2>Instance Method Details</h2>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<div class="method_details first">
|
|
613
|
+
<p class="signature first" id="to_xml-instance_method">
|
|
614
|
+
|
|
615
|
+
- (<tt>String</tt>) <strong>to_xml</strong>(xml)
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
</p><div class="docstring">
|
|
620
|
+
<div class="discussion">
|
|
621
|
+
<p>
|
|
622
|
+
Serializes the series
|
|
623
|
+
</p>
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
</div>
|
|
627
|
+
</div>
|
|
628
|
+
<div class="tags">
|
|
629
|
+
<h3>Parameters:</h3>
|
|
630
|
+
<ul class="param">
|
|
631
|
+
|
|
632
|
+
<li>
|
|
633
|
+
|
|
634
|
+
<span class='name'>xml</span>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
—
|
|
642
|
+
<div class='inline'><p>
|
|
643
|
+
The document builder instance this objects xml will be added to.
|
|
644
|
+
</p>
|
|
645
|
+
</div>
|
|
646
|
+
|
|
647
|
+
</li>
|
|
648
|
+
|
|
649
|
+
</ul>
|
|
650
|
+
|
|
651
|
+
<h3>Returns:</h3>
|
|
652
|
+
<ul class="return">
|
|
653
|
+
|
|
654
|
+
<li>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
</li>
|
|
662
|
+
|
|
663
|
+
</ul>
|
|
664
|
+
|
|
665
|
+
</div><table class="source_code">
|
|
666
|
+
<tr>
|
|
667
|
+
<td>
|
|
668
|
+
<pre class="lines">
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
43
|
|
672
|
+
44
|
|
673
|
+
45
|
|
674
|
+
46
|
|
675
|
+
47
|
|
676
|
+
48
|
|
677
|
+
49
|
|
678
|
+
50
|
|
679
|
+
51
|
|
680
|
+
52
|
|
681
|
+
53
|
|
682
|
+
54
|
|
683
|
+
55
|
|
684
|
+
56
|
|
685
|
+
57
|
|
686
|
+
58
|
|
687
|
+
59
|
|
688
|
+
60
|
|
689
|
+
61
|
|
690
|
+
62
|
|
691
|
+
63
|
|
692
|
+
64
|
|
693
|
+
65
|
|
694
|
+
66
|
|
695
|
+
67
|
|
696
|
+
68
|
|
697
|
+
69
|
|
698
|
+
70
|
|
699
|
+
71
|
|
700
|
+
72
|
|
701
|
+
73
|
|
702
|
+
74
|
|
703
|
+
75
|
|
704
|
+
76
|
|
705
|
+
77
|
|
706
|
+
78</pre>
|
|
707
|
+
</td>
|
|
708
|
+
<td>
|
|
709
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 43</span>
|
|
710
|
+
|
|
711
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
|
|
712
|
+
<span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
|
|
713
|
+
<span class='if if kw'>if</span> <span class='notop op'>!</span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span>
|
|
714
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:cat'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
715
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
716
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='labels identifier id'>labels</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
|
717
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
718
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span>
|
|
719
|
+
<span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span>
|
|
720
|
+
<span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</span>
|
|
721
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
722
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span>
|
|
723
|
+
<span class='rbrace token'>}</span>
|
|
724
|
+
<span class='end end kw'>end</span>
|
|
725
|
+
<span class='rbrace token'>}</span>
|
|
726
|
+
<span class='rbrace token'>}</span>
|
|
727
|
+
<span class='rbrace token'>}</span>
|
|
728
|
+
<span class='end end kw'>end</span>
|
|
729
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:val'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
730
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
731
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='data identifier id'>data</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
|
732
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
733
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:formatCode'</span><span class='comma token'>,</span> <span class='string val'>'General'</span><span class='rparen token'>)</span>
|
|
734
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='data identifier id'>data</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span>
|
|
735
|
+
<span class='data identifier id'>data</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span>
|
|
736
|
+
<span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</span>
|
|
737
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
738
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span>
|
|
739
|
+
<span class='rbrace token'>}</span>
|
|
740
|
+
<span class='end end kw'>end</span>
|
|
741
|
+
<span class='rbrace token'>}</span>
|
|
742
|
+
<span class='rbrace token'>}</span>
|
|
743
|
+
<span class='rbrace token'>}</span>
|
|
744
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</span>
|
|
745
|
+
<span class='end end kw'>end</span>
|
|
746
|
+
<span class='end end kw'>end</span>
|
|
747
|
+
</pre>
|
|
748
|
+
</td>
|
|
749
|
+
</tr>
|
|
750
|
+
</table>
|
|
751
|
+
</div>
|
|
752
|
+
|
|
753
|
+
</div>
|
|
754
|
+
|
|
755
|
+
</div>
|
|
756
|
+
|
|
757
|
+
<div id="footer">
|
|
758
|
+
Generated on Tue Nov 22 00:27:53 2011 by
|
|
759
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
760
|
+
0.7.3 (ruby-1.8.7).
|
|
761
|
+
</div>
|
|
762
|
+
|
|
763
|
+
</body>
|
|
764
|
+
</html>
|