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,1459 @@
|
|
|
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::Chart
|
|
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 (C)</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">Chart</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::Chart
|
|
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">Object</span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next">Axlsx::Chart</li>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
78
|
+
|
|
79
|
+
</dd>
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
<dt class="r2 last">Defined in:</dt>
|
|
90
|
+
<dd class="r2 last">lib/axlsx/drawing/chart.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
|
|
98
|
+
<div class="note notetag">
|
|
99
|
+
<strong>Note:</strong>
|
|
100
|
+
<div class='inline'><p>
|
|
101
|
+
Worksheet#add_chart is the recommended way to create charts for your
|
|
102
|
+
worksheets.
|
|
103
|
+
</p>
|
|
104
|
+
</div>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<p>
|
|
108
|
+
A Chart is the superclass for specific charts
|
|
109
|
+
</p>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
</div>
|
|
113
|
+
</div>
|
|
114
|
+
<div class="tags">
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</div><div id="subclasses">
|
|
118
|
+
<h2>Direct Known Subclasses</h2>
|
|
119
|
+
<p class="children"><span class='object_link'><a href="Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span>, <span class='object_link'><a href="Line3DChart.html" title="Axlsx::Line3DChart (class)">Line3DChart</a></span>, <span class='object_link'><a href="Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span></p>
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
124
|
+
<ul class="summary">
|
|
125
|
+
|
|
126
|
+
<li class="public ">
|
|
127
|
+
<span class="summary_signature">
|
|
128
|
+
|
|
129
|
+
<a href="#end_at-instance_method" title="#end_at (instance method)">- (Marker) <strong>end_at</strong> </a>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</span>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
146
|
+
The ending marker for this chart.
|
|
147
|
+
</p>
|
|
148
|
+
</div></span>
|
|
149
|
+
|
|
150
|
+
</li>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<li class="public ">
|
|
154
|
+
<span class="summary_signature">
|
|
155
|
+
|
|
156
|
+
<a href="#graphic_frame-instance_method" title="#graphic_frame (instance method)">- (GraphicFrame) <strong>graphic_frame</strong> </a>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
</span>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<span class="note title readonly">readonly</span>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
173
|
+
A reference to the graphic frame that owns this chart.
|
|
174
|
+
</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<li class="public ">
|
|
181
|
+
<span class="summary_signature">
|
|
182
|
+
|
|
183
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</span>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<span class="note title readonly">readonly</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
200
|
+
The index of this chart in the workbooks charts collection.
|
|
201
|
+
</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class="note title readonly">readonly</span>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
227
|
+
The part name for this chart.
|
|
228
|
+
</p>
|
|
229
|
+
</div></span>
|
|
230
|
+
|
|
231
|
+
</li>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<li class="public ">
|
|
235
|
+
<span class="summary_signature">
|
|
236
|
+
|
|
237
|
+
<a href="#series-instance_method" title="#series (instance method)">- (SimpleTypedList) <strong>series</strong> </a>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
</span>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<span class="note title readonly">readonly</span>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
254
|
+
A collection of series objects that are applied to the chart.
|
|
255
|
+
</p>
|
|
256
|
+
</div></span>
|
|
257
|
+
|
|
258
|
+
</li>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<li class="public ">
|
|
262
|
+
<span class="summary_signature">
|
|
263
|
+
|
|
264
|
+
<a href="#series_type-instance_method" title="#series_type (instance method)">- (Series) <strong>series_type</strong> </a>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
</span>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<span class="note title readonly">readonly</span>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
281
|
+
The type of series to use for this chart.
|
|
282
|
+
</p>
|
|
283
|
+
</div></span>
|
|
284
|
+
|
|
285
|
+
</li>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<li class="public ">
|
|
289
|
+
<span class="summary_signature">
|
|
290
|
+
|
|
291
|
+
<a href="#show_legend-instance_method" title="#show_legend (instance method)">- (Boolean) <strong>show_legend</strong> </a>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
</span>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
308
|
+
Show the legend in the chart.
|
|
309
|
+
</p>
|
|
310
|
+
</div></span>
|
|
311
|
+
|
|
312
|
+
</li>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
<li class="public ">
|
|
316
|
+
<span class="summary_signature">
|
|
317
|
+
|
|
318
|
+
<a href="#start_at-instance_method" title="#start_at (instance method)">- (Marker) <strong>start_at</strong> </a>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
</span>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
335
|
+
The starting marker for this chart.
|
|
336
|
+
</p>
|
|
337
|
+
</div></span>
|
|
338
|
+
|
|
339
|
+
</li>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<li class="public ">
|
|
343
|
+
<span class="summary_signature">
|
|
344
|
+
|
|
345
|
+
<a href="#style-instance_method" title="#style (instance method)">- (Integer) <strong>style</strong> </a>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
</span>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
362
|
+
The style for the chart.
|
|
363
|
+
</p>
|
|
364
|
+
</div></span>
|
|
365
|
+
|
|
366
|
+
</li>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
<li class="public ">
|
|
370
|
+
<span class="summary_signature">
|
|
371
|
+
|
|
372
|
+
<a href="#title-instance_method" title="#title (instance method)">- (Title) <strong>title</strong> </a>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
</span>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
389
|
+
The title object for the chart.
|
|
390
|
+
</p>
|
|
391
|
+
</div></span>
|
|
392
|
+
|
|
393
|
+
</li>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<li class="public ">
|
|
397
|
+
<span class="summary_signature">
|
|
398
|
+
|
|
399
|
+
<a href="#view3D-instance_method" title="#view3D (instance method)">- (Object) <strong>view3D</strong> </a>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
</span>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
416
|
+
The 3D view properties for the chart.
|
|
417
|
+
</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</ul>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<h2>
|
|
430
|
+
Instance Method Summary
|
|
431
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
432
|
+
</h2>
|
|
433
|
+
|
|
434
|
+
<ul class="summary">
|
|
435
|
+
|
|
436
|
+
<li class="public ">
|
|
437
|
+
<span class="summary_signature">
|
|
438
|
+
|
|
439
|
+
<a href="#add_series-instance_method" title="#add_series (instance method)">- (Series) <strong>add_series</strong>(options = {}) </a>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
</span>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
453
|
+
Adds a new series to the chart’s series collection.
|
|
454
|
+
</p>
|
|
455
|
+
</div></span>
|
|
456
|
+
|
|
457
|
+
</li>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<li class="public ">
|
|
461
|
+
<span class="summary_signature">
|
|
462
|
+
|
|
463
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Chart) <strong>initialize</strong>(frame, options = {}) {|_self| ... }</a>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
</span>
|
|
468
|
+
|
|
469
|
+
<span class="note title constructor">constructor</span>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
479
|
+
Creates a new chart object.
|
|
480
|
+
</p>
|
|
481
|
+
</div></span>
|
|
482
|
+
|
|
483
|
+
</li>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
<li class="public ">
|
|
487
|
+
<span class="summary_signature">
|
|
488
|
+
|
|
489
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (Object) <strong>to_xml</strong> </a>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</span>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
503
|
+
Chart Serialization serializes the chart.
|
|
504
|
+
</p>
|
|
505
|
+
</div></span>
|
|
506
|
+
|
|
507
|
+
</li>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</ul>
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
<div id="constructor_details" class="method_details_list">
|
|
514
|
+
<h2>Constructor Details</h2>
|
|
515
|
+
|
|
516
|
+
<div class="method_details first">
|
|
517
|
+
<p class="signature first" id="initialize-instance_method">
|
|
518
|
+
|
|
519
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) {|_self| ... }
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</p><div class="docstring">
|
|
524
|
+
<div class="discussion">
|
|
525
|
+
<p>
|
|
526
|
+
Creates a new chart object
|
|
527
|
+
</p>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
</div>
|
|
531
|
+
</div>
|
|
532
|
+
<div class="tags">
|
|
533
|
+
<h3>Parameters:</h3>
|
|
534
|
+
<ul class="param">
|
|
535
|
+
|
|
536
|
+
<li>
|
|
537
|
+
|
|
538
|
+
<span class='name'>frame</span>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<span class='type'>(<tt>GraphicalFrame</tt>)</span>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
—
|
|
546
|
+
<div class='inline'><p>
|
|
547
|
+
The frame that holds this chart.
|
|
548
|
+
</p>
|
|
549
|
+
</div>
|
|
550
|
+
|
|
551
|
+
</li>
|
|
552
|
+
|
|
553
|
+
<li>
|
|
554
|
+
|
|
555
|
+
<span class='name'>options</span>
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
—
|
|
565
|
+
<div class='inline'><p>
|
|
566
|
+
a customizable set of options
|
|
567
|
+
</p>
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
</li>
|
|
571
|
+
|
|
572
|
+
</ul>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
580
|
+
<ul class="option">
|
|
581
|
+
|
|
582
|
+
<li>
|
|
583
|
+
<span class="name">title</span>
|
|
584
|
+
<span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span>
|
|
585
|
+
<span class="default">
|
|
586
|
+
|
|
587
|
+
</span>
|
|
588
|
+
|
|
589
|
+
</li>
|
|
590
|
+
|
|
591
|
+
<li>
|
|
592
|
+
<span class="name">show_legend</span>
|
|
593
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
594
|
+
<span class="default">
|
|
595
|
+
|
|
596
|
+
</span>
|
|
597
|
+
|
|
598
|
+
</li>
|
|
599
|
+
|
|
600
|
+
</ul>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<h3>Yields:</h3>
|
|
604
|
+
<ul class="yield">
|
|
605
|
+
|
|
606
|
+
<li>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
<span class='type'>(<tt>_self</tt>)</span>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
</li>
|
|
614
|
+
|
|
615
|
+
</ul>
|
|
616
|
+
<h3>Yield Parameters:</h3>
|
|
617
|
+
<ul class="yieldparam">
|
|
618
|
+
|
|
619
|
+
<li>
|
|
620
|
+
|
|
621
|
+
<span class='name'>_self</span>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Chart (class)">Axlsx::Chart</a></span></tt>)</span>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
—
|
|
629
|
+
<div class='inline'><p>
|
|
630
|
+
the object that the method was called on
|
|
631
|
+
</p>
|
|
632
|
+
</div>
|
|
633
|
+
|
|
634
|
+
</li>
|
|
635
|
+
|
|
636
|
+
</ul>
|
|
637
|
+
|
|
638
|
+
</div><table class="source_code">
|
|
639
|
+
<tr>
|
|
640
|
+
<td>
|
|
641
|
+
<pre class="lines">
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
58
|
|
645
|
+
59
|
|
646
|
+
60
|
|
647
|
+
61
|
|
648
|
+
62
|
|
649
|
+
63
|
|
650
|
+
64
|
|
651
|
+
65
|
|
652
|
+
66
|
|
653
|
+
67
|
|
654
|
+
68
|
|
655
|
+
69</pre>
|
|
656
|
+
</td>
|
|
657
|
+
<td>
|
|
658
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 58</span>
|
|
659
|
+
|
|
660
|
+
<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</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>
|
|
661
|
+
<span class='@style ivar id'>@style</span> <span class='assign token'>=</span> <span class='integer val'>2</span>
|
|
662
|
+
<span class='@graphic_frame ivar id'>@graphic_frame</span><span class='assign token'>=</span><span class='frame identifier id'>frame</span>
|
|
663
|
+
<span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span>
|
|
664
|
+
<span class='@series ivar id'>@series</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Series constant id'>Series</span>
|
|
665
|
+
<span class='@show_legend ivar id'>@show_legend</span> <span class='assign token'>=</span> <span class='true true kw'>true</span>
|
|
666
|
+
<span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='Series constant id'>Series</span>
|
|
667
|
+
<span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span>
|
|
668
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span>
|
|
669
|
+
<span class='end end kw'>end</span>
|
|
670
|
+
<span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
|
|
671
|
+
<span class='end end kw'>end</span>
|
|
672
|
+
</pre>
|
|
673
|
+
</td>
|
|
674
|
+
</tr>
|
|
675
|
+
</table>
|
|
676
|
+
</div>
|
|
677
|
+
|
|
678
|
+
</div>
|
|
679
|
+
|
|
680
|
+
<div id="instance_attr_details" class="attr_details">
|
|
681
|
+
<h2>Instance Attribute Details</h2>
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
<span id="end_at=-instance_method"></span>
|
|
685
|
+
<span id="end_at-instance_method"></span>
|
|
686
|
+
<div class="method_details first">
|
|
687
|
+
<p class="signature first" id="end_at-instance_method">
|
|
688
|
+
|
|
689
|
+
- (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>end_at</strong>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
</p><div class="docstring">
|
|
694
|
+
<div class="discussion">
|
|
695
|
+
<p>
|
|
696
|
+
The ending marker for this chart
|
|
697
|
+
</p>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
</div>
|
|
701
|
+
</div>
|
|
702
|
+
<div class="tags">
|
|
703
|
+
|
|
704
|
+
<h3>Returns:</h3>
|
|
705
|
+
<ul class="return">
|
|
706
|
+
|
|
707
|
+
<li>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
<span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
</li>
|
|
715
|
+
|
|
716
|
+
</ul>
|
|
717
|
+
|
|
718
|
+
</div><table class="source_code">
|
|
719
|
+
<tr>
|
|
720
|
+
<td>
|
|
721
|
+
<pre class="lines">
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
48
|
|
725
|
+
49
|
|
726
|
+
50</pre>
|
|
727
|
+
</td>
|
|
728
|
+
<td>
|
|
729
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 48</span>
|
|
730
|
+
|
|
731
|
+
<span class='def def kw'>def</span> <span class='end_at identifier id'>end_at</span>
|
|
732
|
+
<span class='@end_at ivar id'>@end_at</span>
|
|
733
|
+
<span class='end end kw'>end</span>
|
|
734
|
+
</pre>
|
|
735
|
+
</td>
|
|
736
|
+
</tr>
|
|
737
|
+
</table>
|
|
738
|
+
</div>
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
<span id=""></span>
|
|
742
|
+
<span id="graphic_frame-instance_method"></span>
|
|
743
|
+
<div class="method_details ">
|
|
744
|
+
<p class="signature " id="graphic_frame-instance_method">
|
|
745
|
+
|
|
746
|
+
- (<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>graphic_frame</strong> <span class="extras">(readonly)</span>
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
</p><div class="docstring">
|
|
751
|
+
<div class="discussion">
|
|
752
|
+
<p>
|
|
753
|
+
A reference to the graphic frame that owns this chart
|
|
754
|
+
</p>
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
</div>
|
|
758
|
+
</div>
|
|
759
|
+
<div class="tags">
|
|
760
|
+
|
|
761
|
+
<h3>Returns:</h3>
|
|
762
|
+
<ul class="return">
|
|
763
|
+
|
|
764
|
+
<li>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
<span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span>
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
</li>
|
|
772
|
+
|
|
773
|
+
</ul>
|
|
774
|
+
|
|
775
|
+
</div><table class="source_code">
|
|
776
|
+
<tr>
|
|
777
|
+
<td>
|
|
778
|
+
<pre class="lines">
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
21
|
|
782
|
+
22
|
|
783
|
+
23</pre>
|
|
784
|
+
</td>
|
|
785
|
+
<td>
|
|
786
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 21</span>
|
|
787
|
+
|
|
788
|
+
<span class='def def kw'>def</span> <span class='graphic_frame identifier id'>graphic_frame</span>
|
|
789
|
+
<span class='@graphic_frame ivar id'>@graphic_frame</span>
|
|
790
|
+
<span class='end end kw'>end</span>
|
|
791
|
+
</pre>
|
|
792
|
+
</td>
|
|
793
|
+
</tr>
|
|
794
|
+
</table>
|
|
795
|
+
</div>
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
<span id=""></span>
|
|
799
|
+
<span id="index-instance_method"></span>
|
|
800
|
+
<div class="method_details ">
|
|
801
|
+
<p class="signature " id="index-instance_method">
|
|
802
|
+
|
|
803
|
+
- (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
</p><div class="docstring">
|
|
808
|
+
<div class="discussion">
|
|
809
|
+
<p>
|
|
810
|
+
The index of this chart in the workbooks charts collection
|
|
811
|
+
</p>
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
</div>
|
|
815
|
+
</div>
|
|
816
|
+
<div class="tags">
|
|
817
|
+
|
|
818
|
+
<h3>Returns:</h3>
|
|
819
|
+
<ul class="return">
|
|
820
|
+
|
|
821
|
+
<li>
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
</li>
|
|
829
|
+
|
|
830
|
+
</ul>
|
|
831
|
+
|
|
832
|
+
</div><table class="source_code">
|
|
833
|
+
<tr>
|
|
834
|
+
<td>
|
|
835
|
+
<pre class="lines">
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
33
|
|
839
|
+
34
|
|
840
|
+
35</pre>
|
|
841
|
+
</td>
|
|
842
|
+
<td>
|
|
843
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 33</span>
|
|
844
|
+
|
|
845
|
+
<span class='def def kw'>def</span> <span class='index identifier id'>index</span>
|
|
846
|
+
<span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span>
|
|
847
|
+
<span class='end end kw'>end</span>
|
|
848
|
+
</pre>
|
|
849
|
+
</td>
|
|
850
|
+
</tr>
|
|
851
|
+
</table>
|
|
852
|
+
</div>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
<span id=""></span>
|
|
856
|
+
<span id="pn-instance_method"></span>
|
|
857
|
+
<div class="method_details ">
|
|
858
|
+
<p class="signature " id="pn-instance_method">
|
|
859
|
+
|
|
860
|
+
- (<tt>String</tt>) <strong>pn</strong> <span class="extras">(readonly)</span>
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
</p><div class="docstring">
|
|
865
|
+
<div class="discussion">
|
|
866
|
+
<p>
|
|
867
|
+
The part name for this chart
|
|
868
|
+
</p>
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
</div>
|
|
872
|
+
</div>
|
|
873
|
+
<div class="tags">
|
|
874
|
+
|
|
875
|
+
<h3>Returns:</h3>
|
|
876
|
+
<ul class="return">
|
|
877
|
+
|
|
878
|
+
<li>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
</li>
|
|
886
|
+
|
|
887
|
+
</ul>
|
|
888
|
+
|
|
889
|
+
</div><table class="source_code">
|
|
890
|
+
<tr>
|
|
891
|
+
<td>
|
|
892
|
+
<pre class="lines">
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
37
|
|
896
|
+
38
|
|
897
|
+
39</pre>
|
|
898
|
+
</td>
|
|
899
|
+
<td>
|
|
900
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 37</span>
|
|
901
|
+
|
|
902
|
+
<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span>
|
|
903
|
+
<span class='dstring node'>"#{CHART_PN % (index+1)}"</span>
|
|
904
|
+
<span class='end end kw'>end</span>
|
|
905
|
+
</pre>
|
|
906
|
+
</td>
|
|
907
|
+
</tr>
|
|
908
|
+
</table>
|
|
909
|
+
</div>
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
<span id=""></span>
|
|
913
|
+
<span id="series-instance_method"></span>
|
|
914
|
+
<div class="method_details ">
|
|
915
|
+
<p class="signature " id="series-instance_method">
|
|
916
|
+
|
|
917
|
+
- (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>series</strong> <span class="extras">(readonly)</span>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
</p><div class="docstring">
|
|
922
|
+
<div class="discussion">
|
|
923
|
+
<p>
|
|
924
|
+
A collection of series objects that are applied to the chart
|
|
925
|
+
</p>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
</div>
|
|
929
|
+
</div>
|
|
930
|
+
<div class="tags">
|
|
931
|
+
|
|
932
|
+
<h3>Returns:</h3>
|
|
933
|
+
<ul class="return">
|
|
934
|
+
|
|
935
|
+
<li>
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
<span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
</li>
|
|
943
|
+
|
|
944
|
+
</ul>
|
|
945
|
+
|
|
946
|
+
</div><table class="source_code">
|
|
947
|
+
<tr>
|
|
948
|
+
<td>
|
|
949
|
+
<pre class="lines">
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
25
|
|
953
|
+
26
|
|
954
|
+
27</pre>
|
|
955
|
+
</td>
|
|
956
|
+
<td>
|
|
957
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 25</span>
|
|
958
|
+
|
|
959
|
+
<span class='def def kw'>def</span> <span class='series identifier id'>series</span>
|
|
960
|
+
<span class='@series ivar id'>@series</span>
|
|
961
|
+
<span class='end end kw'>end</span>
|
|
962
|
+
</pre>
|
|
963
|
+
</td>
|
|
964
|
+
</tr>
|
|
965
|
+
</table>
|
|
966
|
+
</div>
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
<span id=""></span>
|
|
970
|
+
<span id="series_type-instance_method"></span>
|
|
971
|
+
<div class="method_details ">
|
|
972
|
+
<p class="signature " id="series_type-instance_method">
|
|
973
|
+
|
|
974
|
+
- (<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>) <strong>series_type</strong> <span class="extras">(readonly)</span>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
</p><div class="docstring">
|
|
979
|
+
<div class="discussion">
|
|
980
|
+
<p>
|
|
981
|
+
The type of series to use for this chart
|
|
982
|
+
</p>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
</div>
|
|
986
|
+
</div>
|
|
987
|
+
<div class="tags">
|
|
988
|
+
|
|
989
|
+
<h3>Returns:</h3>
|
|
990
|
+
<ul class="return">
|
|
991
|
+
|
|
992
|
+
<li>
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
<span class='type'>(<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
</li>
|
|
1000
|
+
|
|
1001
|
+
</ul>
|
|
1002
|
+
|
|
1003
|
+
</div><table class="source_code">
|
|
1004
|
+
<tr>
|
|
1005
|
+
<td>
|
|
1006
|
+
<pre class="lines">
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
29
|
|
1010
|
+
30
|
|
1011
|
+
31</pre>
|
|
1012
|
+
</td>
|
|
1013
|
+
<td>
|
|
1014
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 29</span>
|
|
1015
|
+
|
|
1016
|
+
<span class='def def kw'>def</span> <span class='series_type identifier id'>series_type</span>
|
|
1017
|
+
<span class='@series_type ivar id'>@series_type</span>
|
|
1018
|
+
<span class='end end kw'>end</span>
|
|
1019
|
+
</pre>
|
|
1020
|
+
</td>
|
|
1021
|
+
</tr>
|
|
1022
|
+
</table>
|
|
1023
|
+
</div>
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
<span id="show_legend=-instance_method"></span>
|
|
1027
|
+
<span id="show_legend-instance_method"></span>
|
|
1028
|
+
<div class="method_details ">
|
|
1029
|
+
<p class="signature " id="show_legend-instance_method">
|
|
1030
|
+
|
|
1031
|
+
- (<tt>Boolean</tt>) <strong>show_legend</strong>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
</p><div class="docstring">
|
|
1036
|
+
<div class="discussion">
|
|
1037
|
+
<p>
|
|
1038
|
+
Show the legend in the chart
|
|
1039
|
+
</p>
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
</div>
|
|
1043
|
+
</div>
|
|
1044
|
+
<div class="tags">
|
|
1045
|
+
|
|
1046
|
+
<h3>Returns:</h3>
|
|
1047
|
+
<ul class="return">
|
|
1048
|
+
|
|
1049
|
+
<li>
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
</li>
|
|
1057
|
+
|
|
1058
|
+
</ul>
|
|
1059
|
+
|
|
1060
|
+
</div><table class="source_code">
|
|
1061
|
+
<tr>
|
|
1062
|
+
<td>
|
|
1063
|
+
<pre class="lines">
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
52
|
|
1067
|
+
53
|
|
1068
|
+
54</pre>
|
|
1069
|
+
</td>
|
|
1070
|
+
<td>
|
|
1071
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 52</span>
|
|
1072
|
+
|
|
1073
|
+
<span class='def def kw'>def</span> <span class='show_legend identifier id'>show_legend</span>
|
|
1074
|
+
<span class='@show_legend ivar id'>@show_legend</span>
|
|
1075
|
+
<span class='end end kw'>end</span>
|
|
1076
|
+
</pre>
|
|
1077
|
+
</td>
|
|
1078
|
+
</tr>
|
|
1079
|
+
</table>
|
|
1080
|
+
</div>
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
<span id="start_at=-instance_method"></span>
|
|
1084
|
+
<span id="start_at-instance_method"></span>
|
|
1085
|
+
<div class="method_details ">
|
|
1086
|
+
<p class="signature " id="start_at-instance_method">
|
|
1087
|
+
|
|
1088
|
+
- (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>start_at</strong>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
</p><div class="docstring">
|
|
1093
|
+
<div class="discussion">
|
|
1094
|
+
<p>
|
|
1095
|
+
The starting marker for this chart
|
|
1096
|
+
</p>
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
</div>
|
|
1100
|
+
</div>
|
|
1101
|
+
<div class="tags">
|
|
1102
|
+
|
|
1103
|
+
<h3>Returns:</h3>
|
|
1104
|
+
<ul class="return">
|
|
1105
|
+
|
|
1106
|
+
<li>
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
<span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span>
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
</li>
|
|
1114
|
+
|
|
1115
|
+
</ul>
|
|
1116
|
+
|
|
1117
|
+
</div><table class="source_code">
|
|
1118
|
+
<tr>
|
|
1119
|
+
<td>
|
|
1120
|
+
<pre class="lines">
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
44
|
|
1124
|
+
45
|
|
1125
|
+
46</pre>
|
|
1126
|
+
</td>
|
|
1127
|
+
<td>
|
|
1128
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 44</span>
|
|
1129
|
+
|
|
1130
|
+
<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span>
|
|
1131
|
+
<span class='@start_at ivar id'>@start_at</span>
|
|
1132
|
+
<span class='end end kw'>end</span>
|
|
1133
|
+
</pre>
|
|
1134
|
+
</td>
|
|
1135
|
+
</tr>
|
|
1136
|
+
</table>
|
|
1137
|
+
</div>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
<span id="style=-instance_method"></span>
|
|
1141
|
+
<span id="style-instance_method"></span>
|
|
1142
|
+
<div class="method_details ">
|
|
1143
|
+
<p class="signature " id="style-instance_method">
|
|
1144
|
+
|
|
1145
|
+
- (<tt>Integer</tt>) <strong>style</strong>
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
</p><div class="docstring">
|
|
1150
|
+
<div class="discussion">
|
|
1151
|
+
<p>
|
|
1152
|
+
The style for the chart. see ECMA Part 1 §21.2.2.196
|
|
1153
|
+
</p>
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
</div>
|
|
1157
|
+
</div>
|
|
1158
|
+
<div class="tags">
|
|
1159
|
+
|
|
1160
|
+
<h3>Returns:</h3>
|
|
1161
|
+
<ul class="return">
|
|
1162
|
+
|
|
1163
|
+
<li>
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
</li>
|
|
1171
|
+
|
|
1172
|
+
</ul>
|
|
1173
|
+
|
|
1174
|
+
</div><table class="source_code">
|
|
1175
|
+
<tr>
|
|
1176
|
+
<td>
|
|
1177
|
+
<pre class="lines">
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
14
|
|
1181
|
+
15
|
|
1182
|
+
16</pre>
|
|
1183
|
+
</td>
|
|
1184
|
+
<td>
|
|
1185
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 14</span>
|
|
1186
|
+
|
|
1187
|
+
<span class='def def kw'>def</span> <span class='style identifier id'>style</span>
|
|
1188
|
+
<span class='@style ivar id'>@style</span>
|
|
1189
|
+
<span class='end end kw'>end</span>
|
|
1190
|
+
</pre>
|
|
1191
|
+
</td>
|
|
1192
|
+
</tr>
|
|
1193
|
+
</table>
|
|
1194
|
+
</div>
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
<span id="title=-instance_method"></span>
|
|
1198
|
+
<span id="title-instance_method"></span>
|
|
1199
|
+
<div class="method_details ">
|
|
1200
|
+
<p class="signature " id="title-instance_method">
|
|
1201
|
+
|
|
1202
|
+
- (<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>) <strong>title</strong>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
</p><div class="docstring">
|
|
1207
|
+
<div class="discussion">
|
|
1208
|
+
<p>
|
|
1209
|
+
The title object for the chart.
|
|
1210
|
+
</p>
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
</div>
|
|
1214
|
+
</div>
|
|
1215
|
+
<div class="tags">
|
|
1216
|
+
|
|
1217
|
+
<h3>Returns:</h3>
|
|
1218
|
+
<ul class="return">
|
|
1219
|
+
|
|
1220
|
+
<li>
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
<span class='type'>(<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>)</span>
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
</li>
|
|
1228
|
+
|
|
1229
|
+
</ul>
|
|
1230
|
+
|
|
1231
|
+
</div><table class="source_code">
|
|
1232
|
+
<tr>
|
|
1233
|
+
<td>
|
|
1234
|
+
<pre class="lines">
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
9
|
|
1238
|
+
10
|
|
1239
|
+
11</pre>
|
|
1240
|
+
</td>
|
|
1241
|
+
<td>
|
|
1242
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 9</span>
|
|
1243
|
+
|
|
1244
|
+
<span class='def def kw'>def</span> <span class='title identifier id'>title</span>
|
|
1245
|
+
<span class='@title ivar id'>@title</span>
|
|
1246
|
+
<span class='end end kw'>end</span>
|
|
1247
|
+
</pre>
|
|
1248
|
+
</td>
|
|
1249
|
+
</tr>
|
|
1250
|
+
</table>
|
|
1251
|
+
</div>
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
<span id="view3D=-instance_method"></span>
|
|
1255
|
+
<span id="view3D-instance_method"></span>
|
|
1256
|
+
<div class="method_details ">
|
|
1257
|
+
<p class="signature " id="view3D-instance_method">
|
|
1258
|
+
|
|
1259
|
+
- (<tt>Object</tt>) <strong>view3D</strong>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
</p><div class="docstring">
|
|
1264
|
+
<div class="discussion">
|
|
1265
|
+
<p>
|
|
1266
|
+
The 3D view properties for the chart
|
|
1267
|
+
</p>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
</div>
|
|
1271
|
+
</div>
|
|
1272
|
+
<div class="tags">
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
</div><table class="source_code">
|
|
1276
|
+
<tr>
|
|
1277
|
+
<td>
|
|
1278
|
+
<pre class="lines">
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
17
|
|
1282
|
+
18
|
|
1283
|
+
19</pre>
|
|
1284
|
+
</td>
|
|
1285
|
+
<td>
|
|
1286
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 17</span>
|
|
1287
|
+
|
|
1288
|
+
<span class='def def kw'>def</span> <span class='view3D identifier id'>view3D</span>
|
|
1289
|
+
<span class='@view3D ivar id'>@view3D</span>
|
|
1290
|
+
<span class='end end kw'>end</span>
|
|
1291
|
+
</pre>
|
|
1292
|
+
</td>
|
|
1293
|
+
</tr>
|
|
1294
|
+
</table>
|
|
1295
|
+
</div>
|
|
1296
|
+
|
|
1297
|
+
</div>
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1301
|
+
<h2>Instance Method Details</h2>
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
<div class="method_details first">
|
|
1305
|
+
<p class="signature first" id="add_series-instance_method">
|
|
1306
|
+
|
|
1307
|
+
- (<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>) <strong>add_series</strong>(options = {})
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
</p><div class="docstring">
|
|
1312
|
+
<div class="discussion">
|
|
1313
|
+
<p>
|
|
1314
|
+
Adds a new series to the chart’s series collection.
|
|
1315
|
+
</p>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
</div>
|
|
1319
|
+
</div>
|
|
1320
|
+
<div class="tags">
|
|
1321
|
+
|
|
1322
|
+
<h3>Returns:</h3>
|
|
1323
|
+
<ul class="return">
|
|
1324
|
+
|
|
1325
|
+
<li>
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
<span class='type'>(<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span>
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
</li>
|
|
1333
|
+
|
|
1334
|
+
</ul>
|
|
1335
|
+
|
|
1336
|
+
<h3>See Also:</h3>
|
|
1337
|
+
<ul class="see">
|
|
1338
|
+
|
|
1339
|
+
<li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li>
|
|
1340
|
+
|
|
1341
|
+
</ul>
|
|
1342
|
+
|
|
1343
|
+
</div><table class="source_code">
|
|
1344
|
+
<tr>
|
|
1345
|
+
<td>
|
|
1346
|
+
<pre class="lines">
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
94
|
|
1350
|
+
95
|
|
1351
|
+
96
|
|
1352
|
+
97</pre>
|
|
1353
|
+
</td>
|
|
1354
|
+
<td>
|
|
1355
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 94</span>
|
|
1356
|
+
|
|
1357
|
+
<span class='def def kw'>def</span> <span class='add_series identifier id'>add_series</span><span class='lparen 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>
|
|
1358
|
+
<span class='@series_type ivar id'>@series_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
|
|
1359
|
+
<span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='last identifier id'>last</span>
|
|
1360
|
+
<span class='end end kw'>end</span>
|
|
1361
|
+
</pre>
|
|
1362
|
+
</td>
|
|
1363
|
+
</tr>
|
|
1364
|
+
</table>
|
|
1365
|
+
</div>
|
|
1366
|
+
|
|
1367
|
+
<div class="method_details ">
|
|
1368
|
+
<p class="signature " id="to_xml-instance_method">
|
|
1369
|
+
|
|
1370
|
+
- (<tt>Object</tt>) <strong>to_xml</strong>
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
</p><div class="docstring">
|
|
1375
|
+
<div class="discussion">
|
|
1376
|
+
<p>
|
|
1377
|
+
Chart Serialization serializes the chart
|
|
1378
|
+
</p>
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
</div>
|
|
1382
|
+
</div>
|
|
1383
|
+
<div class="tags">
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
</div><table class="source_code">
|
|
1387
|
+
<tr>
|
|
1388
|
+
<td>
|
|
1389
|
+
<pre class="lines">
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
101
|
|
1393
|
+
102
|
|
1394
|
+
103
|
|
1395
|
+
104
|
|
1396
|
+
105
|
|
1397
|
+
106
|
|
1398
|
+
107
|
|
1399
|
+
108
|
|
1400
|
+
109
|
|
1401
|
+
110
|
|
1402
|
+
111
|
|
1403
|
+
112
|
|
1404
|
+
113
|
|
1405
|
+
114
|
|
1406
|
+
115
|
|
1407
|
+
116
|
|
1408
|
+
117
|
|
1409
|
+
118
|
|
1410
|
+
119
|
|
1411
|
+
120
|
|
1412
|
+
121
|
|
1413
|
+
122
|
|
1414
|
+
123</pre>
|
|
1415
|
+
</td>
|
|
1416
|
+
<td>
|
|
1417
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 101</span>
|
|
1418
|
+
|
|
1419
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span>
|
|
1420
|
+
<span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</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>
|
|
1421
|
+
<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:chartSpace'</span><span class='comma token'>,</span><span class='symbol val'>:'xmlns:c'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
1422
|
+
<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:date1904'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='rparen token'>)</span>
|
|
1423
|
+
<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:style'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='style identifier id'>style</span><span class='rparen token'>)</span>
|
|
1424
|
+
<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:chart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
1425
|
+
<span class='@title ivar id'>@title</span><span class='dot token'>.</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> <span class='unless unless_mod kw'>unless</span> <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
|
1426
|
+
<span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</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> <span class='unless unless_mod kw'>unless</span> <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
|
1427
|
+
<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:plotArea'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
1428
|
+
<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:layout'</span><span class='rparen token'>)</span>
|
|
1429
|
+
<span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
|
|
1430
|
+
<span class='rbrace token'>}</span>
|
|
1431
|
+
<span class='if if kw'>if</span> <span class='@show_legend ivar id'>@show_legend</span>
|
|
1432
|
+
<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:legend'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
1433
|
+
<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:legendPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"r"</span><span class='rparen token'>)</span>
|
|
1434
|
+
<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:layout'</span><span class='rparen token'>)</span>
|
|
1435
|
+
<span class='rbrace token'>}</span>
|
|
1436
|
+
<span class='end end kw'>end</span>
|
|
1437
|
+
<span class='rbrace token'>}</span>
|
|
1438
|
+
<span class='rbrace token'>}</span>
|
|
1439
|
+
<span class='end end kw'>end</span>
|
|
1440
|
+
<span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
|
|
1441
|
+
<span class='end end kw'>end</span>
|
|
1442
|
+
</pre>
|
|
1443
|
+
</td>
|
|
1444
|
+
</tr>
|
|
1445
|
+
</table>
|
|
1446
|
+
</div>
|
|
1447
|
+
|
|
1448
|
+
</div>
|
|
1449
|
+
|
|
1450
|
+
</div>
|
|
1451
|
+
|
|
1452
|
+
<div id="footer">
|
|
1453
|
+
Generated on Tue Nov 22 00:27:45 2011 by
|
|
1454
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1455
|
+
0.7.3 (ruby-1.8.7).
|
|
1456
|
+
</div>
|
|
1457
|
+
|
|
1458
|
+
</body>
|
|
1459
|
+
</html>
|