axlsx 1.0.5 → 1.0.6
Sign up to get free protection for your applications and to get access to all the features.
- 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,921 @@
|
|
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::Line3DChart
|
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 (L)</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">Line3DChart</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::Line3DChart
|
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="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></span>
|
70
|
+
|
71
|
+
<ul class="fullTree">
|
72
|
+
<li>Object</li>
|
73
|
+
|
74
|
+
<li class="next"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li>
|
75
|
+
|
76
|
+
<li class="next">Axlsx::Line3DChart</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/line_3D_chart.rb</dd>
|
93
|
+
|
94
|
+
</dl>
|
95
|
+
<div class="clear"></div>
|
96
|
+
|
97
|
+
<h2>Overview</h2><div class="docstring">
|
98
|
+
<div class="discussion">
|
99
|
+
<p>
|
100
|
+
The Line3DChart is a three dimentional line chart (who would have guessed?)
|
101
|
+
that you can add to your worksheet.
|
102
|
+
</p>
|
103
|
+
|
104
|
+
|
105
|
+
</div>
|
106
|
+
</div>
|
107
|
+
<div class="tags">
|
108
|
+
|
109
|
+
<div class="examples">
|
110
|
+
<h3>Examples:</h3>
|
111
|
+
|
112
|
+
<h4><div class='inline'><p>
|
113
|
+
Creating a chart
|
114
|
+
</p>
|
115
|
+
</div></h4>
|
116
|
+
<pre class="example code"><span class='comment val'># This example creates a line in a single sheet.</span>
|
117
|
+
<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span>
|
118
|
+
<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span>
|
119
|
+
|
120
|
+
<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
121
|
+
<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span>
|
122
|
+
<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This is a chart with no data in the sheet"</span><span class='rbrack token'>]</span>
|
123
|
+
|
124
|
+
<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Line3DChart constant id'>Line3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>6</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"Most Popular Pets"</span><span class='rparen token'>)</span>
|
125
|
+
<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Slimy Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Fuzzy Bunnies"</span><span class='comma token'>,</span> <span class='string val'>"Rottweiler"</span><span class='rbrack token'>]</span>
|
126
|
+
</pre>
|
127
|
+
|
128
|
+
</div>
|
129
|
+
|
130
|
+
|
131
|
+
<h3>See Also:</h3>
|
132
|
+
<ul class="see">
|
133
|
+
|
134
|
+
<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>
|
135
|
+
|
136
|
+
<li><span class='object_link'><a href="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li>
|
137
|
+
|
138
|
+
<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>
|
139
|
+
|
140
|
+
<li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li>
|
141
|
+
|
142
|
+
<li><span class='object_link'><a href="Package.html#serialize-instance_method" title="Axlsx::Package#serialize (method)">Package#serialize</a></span></li>
|
143
|
+
|
144
|
+
</ul>
|
145
|
+
|
146
|
+
</div>
|
147
|
+
<h2>Constant Summary</h2>
|
148
|
+
|
149
|
+
<dl class="constants">
|
150
|
+
|
151
|
+
<dt id="GAP_AMOUNT_PERCENT-constant" class="">GAP_AMOUNT_PERCENT =
|
152
|
+
<div class="docstring">
|
153
|
+
<div class="discussion">
|
154
|
+
<p>
|
155
|
+
validation regex for gap amount percent
|
156
|
+
</p>
|
157
|
+
|
158
|
+
|
159
|
+
</div>
|
160
|
+
</div>
|
161
|
+
<div class="tags">
|
162
|
+
|
163
|
+
|
164
|
+
</div>
|
165
|
+
</dt>
|
166
|
+
<dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span>
|
167
|
+
</pre></dd>
|
168
|
+
|
169
|
+
</dl>
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
178
|
+
<ul class="summary">
|
179
|
+
|
180
|
+
<li class="public ">
|
181
|
+
<span class="summary_signature">
|
182
|
+
|
183
|
+
<a href="#catAxis-instance_method" title="#catAxis (instance method)">- (CatAxis) <strong>catAxis</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 category axis.
|
201
|
+
</p>
|
202
|
+
</div></span>
|
203
|
+
|
204
|
+
</li>
|
205
|
+
|
206
|
+
|
207
|
+
<li class="public ">
|
208
|
+
<span class="summary_signature">
|
209
|
+
|
210
|
+
<a href="#gapDepth-instance_method" title="#gapDepth (instance method)">- (String) <strong>gapDepth</strong> </a>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</span>
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
<span class="summary_desc"><div class='inline'><p>
|
227
|
+
space between bar or column clusters, as a percentage of the bar or column
|
228
|
+
width.
|
229
|
+
</p>
|
230
|
+
</div></span>
|
231
|
+
|
232
|
+
</li>
|
233
|
+
|
234
|
+
|
235
|
+
<li class="public ">
|
236
|
+
<span class="summary_signature">
|
237
|
+
|
238
|
+
<a href="#grouping-instance_method" title="#grouping (instance method)">- (Symbol) <strong>grouping</strong> </a>
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
</span>
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
<span class="summary_desc"><div class='inline'><p>
|
255
|
+
grouping for a column, line, or area chart.
|
256
|
+
</p>
|
257
|
+
</div></span>
|
258
|
+
|
259
|
+
</li>
|
260
|
+
|
261
|
+
|
262
|
+
<li class="public ">
|
263
|
+
<span class="summary_signature">
|
264
|
+
|
265
|
+
<a href="#serAxis-instance_method" title="#serAxis (instance method)">- (Axis) <strong>serAxis</strong> </a>
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
</span>
|
270
|
+
|
271
|
+
|
272
|
+
<span class="note title readonly">readonly</span>
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
<span class="summary_desc"><div class='inline'><p>
|
282
|
+
the category axis.
|
283
|
+
</p>
|
284
|
+
</div></span>
|
285
|
+
|
286
|
+
</li>
|
287
|
+
|
288
|
+
|
289
|
+
<li class="public ">
|
290
|
+
<span class="summary_signature">
|
291
|
+
|
292
|
+
<a href="#valAxis-instance_method" title="#valAxis (instance method)">- (ValAxis) <strong>valAxis</strong> </a>
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
</span>
|
297
|
+
|
298
|
+
|
299
|
+
<span class="note title readonly">readonly</span>
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
<span class="summary_desc"><div class='inline'><p>
|
309
|
+
the category axis.
|
310
|
+
</p>
|
311
|
+
</div></span>
|
312
|
+
|
313
|
+
</li>
|
314
|
+
|
315
|
+
|
316
|
+
</ul>
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3>
|
326
|
+
<p class="inherited"><span class='object_link'><a href="Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">end_at</a></span>, <span class='object_link'><a href="Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">graphic_frame</a></span>, <span class='object_link'><a href="Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">index</a></span>, <span class='object_link'><a href="Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">pn</a></span>, <span class='object_link'><a href="Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">series</a></span>, <span class='object_link'><a href="Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">series_type</a></span>, <span class='object_link'><a href="Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">show_legend</a></span>, <span class='object_link'><a href="Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">start_at</a></span>, <span class='object_link'><a href="Chart.html#style-instance_method" title="Axlsx::Chart#style (method)">style</a></span>, <span class='object_link'><a href="Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">title</a></span>, <span class='object_link'><a href="Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">view3D</a></span></p>
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
<h2>
|
331
|
+
Instance Method Summary
|
332
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
333
|
+
</h2>
|
334
|
+
|
335
|
+
<ul class="summary">
|
336
|
+
|
337
|
+
<li class="public ">
|
338
|
+
<span class="summary_signature">
|
339
|
+
|
340
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Line3DChart) <strong>initialize</strong>(frame, options = {}) </a>
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
</span>
|
345
|
+
|
346
|
+
<span class="note title constructor">constructor</span>
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
|
355
|
+
<span class="summary_desc"><div class='inline'><p>
|
356
|
+
Creates a new line chart object.
|
357
|
+
</p>
|
358
|
+
</div></span>
|
359
|
+
|
360
|
+
</li>
|
361
|
+
|
362
|
+
|
363
|
+
<li class="public ">
|
364
|
+
<span class="summary_signature">
|
365
|
+
|
366
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
</span>
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
<span class="summary_desc"><div class='inline'><p>
|
380
|
+
Serializes the bar chart.
|
381
|
+
</p>
|
382
|
+
</div></span>
|
383
|
+
|
384
|
+
</li>
|
385
|
+
|
386
|
+
|
387
|
+
</ul>
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3>
|
399
|
+
<p class="inherited"><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span></p>
|
400
|
+
<div id="constructor_details" class="method_details_list">
|
401
|
+
<h2>Constructor Details</h2>
|
402
|
+
|
403
|
+
<div class="method_details first">
|
404
|
+
<p class="signature first" id="initialize-instance_method">
|
405
|
+
|
406
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Line3DChart (class)">Line3DChart</a></span></tt>) <strong>initialize</strong>(frame, options = {})
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
</p><div class="docstring">
|
411
|
+
<div class="discussion">
|
412
|
+
<p>
|
413
|
+
Creates a new line chart object
|
414
|
+
</p>
|
415
|
+
|
416
|
+
|
417
|
+
</div>
|
418
|
+
</div>
|
419
|
+
<div class="tags">
|
420
|
+
<h3>Parameters:</h3>
|
421
|
+
<ul class="param">
|
422
|
+
|
423
|
+
<li>
|
424
|
+
|
425
|
+
<span class='name'>frame</span>
|
426
|
+
|
427
|
+
|
428
|
+
<span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span>
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
—
|
433
|
+
<div class='inline'><p>
|
434
|
+
The workbook that owns this chart.
|
435
|
+
</p>
|
436
|
+
</div>
|
437
|
+
|
438
|
+
</li>
|
439
|
+
|
440
|
+
<li>
|
441
|
+
|
442
|
+
<span class='name'>options</span>
|
443
|
+
|
444
|
+
|
445
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
446
|
+
|
447
|
+
|
448
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
449
|
+
|
450
|
+
|
451
|
+
—
|
452
|
+
<div class='inline'><p>
|
453
|
+
a customizable set of options
|
454
|
+
</p>
|
455
|
+
</div>
|
456
|
+
|
457
|
+
</li>
|
458
|
+
|
459
|
+
</ul>
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
467
|
+
<ul class="option">
|
468
|
+
|
469
|
+
<li>
|
470
|
+
<span class="name">grouping</span>
|
471
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
472
|
+
<span class="default">
|
473
|
+
|
474
|
+
</span>
|
475
|
+
|
476
|
+
</li>
|
477
|
+
|
478
|
+
<li>
|
479
|
+
<span class="name">gapDepth</span>
|
480
|
+
<span class="type">(<tt>String</tt>)</span>
|
481
|
+
<span class="default">
|
482
|
+
|
483
|
+
</span>
|
484
|
+
|
485
|
+
</li>
|
486
|
+
|
487
|
+
</ul>
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
</div><table class="source_code">
|
492
|
+
<tr>
|
493
|
+
<td>
|
494
|
+
<pre class="lines">
|
495
|
+
|
496
|
+
|
497
|
+
51
|
498
|
+
52
|
499
|
+
53
|
500
|
+
54
|
501
|
+
55
|
502
|
+
56
|
503
|
+
57
|
504
|
+
58
|
505
|
+
59
|
506
|
+
60
|
507
|
+
61
|
508
|
+
62</pre>
|
509
|
+
</td>
|
510
|
+
<td>
|
511
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 51</span>
|
512
|
+
|
513
|
+
<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>
|
514
|
+
<span class='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:standard</span>
|
515
|
+
<span class='@catAxId ivar id'>@catAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span>
|
516
|
+
<span class='@valAxId ivar id'>@valAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span>
|
517
|
+
<span class='@serAxId ivar id'>@serAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span>
|
518
|
+
<span class='@catAxis ivar id'>@catAxis</span> <span class='assign token'>=</span> <span class='CatAxis constant id'>CatAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@catAxId ivar id'>@catAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span>
|
519
|
+
<span class='@valAxis ivar id'>@valAxis</span> <span class='assign token'>=</span> <span class='ValAxis constant id'>ValAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@valAxId ivar id'>@valAxId</span><span class='comma token'>,</span> <span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span>
|
520
|
+
<span class='@serAxis ivar id'>@serAxis</span> <span class='assign token'>=</span> <span class='SerAxis constant id'>SerAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@serAxId ivar id'>@serAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span>
|
521
|
+
<span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:perspective=</span><span class='gt op'>></span><span class='integer val'>30</span><span class='rparen token'>)</span>
|
522
|
+
<span class='super super kw'>super</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='rparen token'>)</span>
|
523
|
+
<span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='LineSeries constant id'>LineSeries</span>
|
524
|
+
<span class='end end kw'>end</span>
|
525
|
+
</pre>
|
526
|
+
</td>
|
527
|
+
</tr>
|
528
|
+
</table>
|
529
|
+
</div>
|
530
|
+
|
531
|
+
</div>
|
532
|
+
|
533
|
+
<div id="instance_attr_details" class="attr_details">
|
534
|
+
<h2>Instance Attribute Details</h2>
|
535
|
+
|
536
|
+
|
537
|
+
<span id=""></span>
|
538
|
+
<span id="catAxis-instance_method"></span>
|
539
|
+
<div class="method_details first">
|
540
|
+
<p class="signature first" id="catAxis-instance_method">
|
541
|
+
|
542
|
+
- (<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>) <strong>catAxis</strong> <span class="extras">(readonly)</span>
|
543
|
+
|
544
|
+
|
545
|
+
|
546
|
+
</p><div class="docstring">
|
547
|
+
<div class="discussion">
|
548
|
+
<p>
|
549
|
+
the category axis
|
550
|
+
</p>
|
551
|
+
|
552
|
+
|
553
|
+
</div>
|
554
|
+
</div>
|
555
|
+
<div class="tags">
|
556
|
+
|
557
|
+
<h3>Returns:</h3>
|
558
|
+
<ul class="return">
|
559
|
+
|
560
|
+
<li>
|
561
|
+
|
562
|
+
|
563
|
+
<span class='type'>(<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>)</span>
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
</li>
|
568
|
+
|
569
|
+
</ul>
|
570
|
+
|
571
|
+
</div><table class="source_code">
|
572
|
+
<tr>
|
573
|
+
<td>
|
574
|
+
<pre class="lines">
|
575
|
+
|
576
|
+
|
577
|
+
25
|
578
|
+
26
|
579
|
+
27</pre>
|
580
|
+
</td>
|
581
|
+
<td>
|
582
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 25</span>
|
583
|
+
|
584
|
+
<span class='def def kw'>def</span> <span class='catAxis identifier id'>catAxis</span>
|
585
|
+
<span class='@catAxis ivar id'>@catAxis</span>
|
586
|
+
<span class='end end kw'>end</span>
|
587
|
+
</pre>
|
588
|
+
</td>
|
589
|
+
</tr>
|
590
|
+
</table>
|
591
|
+
</div>
|
592
|
+
|
593
|
+
|
594
|
+
<span id="gapDepth=-instance_method"></span>
|
595
|
+
<span id="gapDepth-instance_method"></span>
|
596
|
+
<div class="method_details ">
|
597
|
+
<p class="signature " id="gapDepth-instance_method">
|
598
|
+
|
599
|
+
- (<tt>String</tt>) <strong>gapDepth</strong>
|
600
|
+
|
601
|
+
|
602
|
+
|
603
|
+
</p><div class="docstring">
|
604
|
+
<div class="discussion">
|
605
|
+
<p>
|
606
|
+
space between bar or column clusters, as a percentage of the bar or column
|
607
|
+
width.
|
608
|
+
</p>
|
609
|
+
|
610
|
+
|
611
|
+
</div>
|
612
|
+
</div>
|
613
|
+
<div class="tags">
|
614
|
+
|
615
|
+
<h3>Returns:</h3>
|
616
|
+
<ul class="return">
|
617
|
+
|
618
|
+
<li>
|
619
|
+
|
620
|
+
|
621
|
+
<span class='type'>(<tt>String</tt>)</span>
|
622
|
+
|
623
|
+
|
624
|
+
|
625
|
+
</li>
|
626
|
+
|
627
|
+
</ul>
|
628
|
+
|
629
|
+
</div><table class="source_code">
|
630
|
+
<tr>
|
631
|
+
<td>
|
632
|
+
<pre class="lines">
|
633
|
+
|
634
|
+
|
635
|
+
37
|
636
|
+
38
|
637
|
+
39</pre>
|
638
|
+
</td>
|
639
|
+
<td>
|
640
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 37</span>
|
641
|
+
|
642
|
+
<span class='def def kw'>def</span> <span class='gapDepth identifier id'>gapDepth</span>
|
643
|
+
<span class='@gapDepth ivar id'>@gapDepth</span>
|
644
|
+
<span class='end end kw'>end</span>
|
645
|
+
</pre>
|
646
|
+
</td>
|
647
|
+
</tr>
|
648
|
+
</table>
|
649
|
+
</div>
|
650
|
+
|
651
|
+
|
652
|
+
<span id="grouping=-instance_method"></span>
|
653
|
+
<span id="grouping-instance_method"></span>
|
654
|
+
<div class="method_details ">
|
655
|
+
<p class="signature " id="grouping-instance_method">
|
656
|
+
|
657
|
+
- (<tt>Symbol</tt>) <strong>grouping</strong>
|
658
|
+
|
659
|
+
|
660
|
+
|
661
|
+
</p><div class="docstring">
|
662
|
+
<div class="discussion">
|
663
|
+
<p>
|
664
|
+
grouping for a column, line, or area chart. must be one of
|
665
|
+
[:percentStacked, :clustered, :standard, :stacked]
|
666
|
+
</p>
|
667
|
+
|
668
|
+
|
669
|
+
</div>
|
670
|
+
</div>
|
671
|
+
<div class="tags">
|
672
|
+
|
673
|
+
<h3>Returns:</h3>
|
674
|
+
<ul class="return">
|
675
|
+
|
676
|
+
<li>
|
677
|
+
|
678
|
+
|
679
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
680
|
+
|
681
|
+
|
682
|
+
|
683
|
+
</li>
|
684
|
+
|
685
|
+
</ul>
|
686
|
+
|
687
|
+
</div><table class="source_code">
|
688
|
+
<tr>
|
689
|
+
<td>
|
690
|
+
<pre class="lines">
|
691
|
+
|
692
|
+
|
693
|
+
42
|
694
|
+
43
|
695
|
+
44</pre>
|
696
|
+
</td>
|
697
|
+
<td>
|
698
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 42</span>
|
699
|
+
|
700
|
+
<span class='def def kw'>def</span> <span class='grouping identifier id'>grouping</span>
|
701
|
+
<span class='@grouping ivar id'>@grouping</span>
|
702
|
+
<span class='end end kw'>end</span>
|
703
|
+
</pre>
|
704
|
+
</td>
|
705
|
+
</tr>
|
706
|
+
</table>
|
707
|
+
</div>
|
708
|
+
|
709
|
+
|
710
|
+
<span id=""></span>
|
711
|
+
<span id="serAxis-instance_method"></span>
|
712
|
+
<div class="method_details ">
|
713
|
+
<p class="signature " id="serAxis-instance_method">
|
714
|
+
|
715
|
+
- (<tt><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></tt>) <strong>serAxis</strong> <span class="extras">(readonly)</span>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
</p><div class="docstring">
|
720
|
+
<div class="discussion">
|
721
|
+
<p>
|
722
|
+
the category axis
|
723
|
+
</p>
|
724
|
+
|
725
|
+
|
726
|
+
</div>
|
727
|
+
</div>
|
728
|
+
<div class="tags">
|
729
|
+
|
730
|
+
<h3>Returns:</h3>
|
731
|
+
<ul class="return">
|
732
|
+
|
733
|
+
<li>
|
734
|
+
|
735
|
+
|
736
|
+
<span class='type'>(<tt><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></tt>)</span>
|
737
|
+
|
738
|
+
|
739
|
+
|
740
|
+
</li>
|
741
|
+
|
742
|
+
</ul>
|
743
|
+
|
744
|
+
</div><table class="source_code">
|
745
|
+
<tr>
|
746
|
+
<td>
|
747
|
+
<pre class="lines">
|
748
|
+
|
749
|
+
|
750
|
+
33
|
751
|
+
34
|
752
|
+
35</pre>
|
753
|
+
</td>
|
754
|
+
<td>
|
755
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 33</span>
|
756
|
+
|
757
|
+
<span class='def def kw'>def</span> <span class='serAxis identifier id'>serAxis</span>
|
758
|
+
<span class='@serAxis ivar id'>@serAxis</span>
|
759
|
+
<span class='end end kw'>end</span>
|
760
|
+
</pre>
|
761
|
+
</td>
|
762
|
+
</tr>
|
763
|
+
</table>
|
764
|
+
</div>
|
765
|
+
|
766
|
+
|
767
|
+
<span id=""></span>
|
768
|
+
<span id="valAxis-instance_method"></span>
|
769
|
+
<div class="method_details ">
|
770
|
+
<p class="signature " id="valAxis-instance_method">
|
771
|
+
|
772
|
+
- (<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>) <strong>valAxis</strong> <span class="extras">(readonly)</span>
|
773
|
+
|
774
|
+
|
775
|
+
|
776
|
+
</p><div class="docstring">
|
777
|
+
<div class="discussion">
|
778
|
+
<p>
|
779
|
+
the category axis
|
780
|
+
</p>
|
781
|
+
|
782
|
+
|
783
|
+
</div>
|
784
|
+
</div>
|
785
|
+
<div class="tags">
|
786
|
+
|
787
|
+
<h3>Returns:</h3>
|
788
|
+
<ul class="return">
|
789
|
+
|
790
|
+
<li>
|
791
|
+
|
792
|
+
|
793
|
+
<span class='type'>(<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>)</span>
|
794
|
+
|
795
|
+
|
796
|
+
|
797
|
+
</li>
|
798
|
+
|
799
|
+
</ul>
|
800
|
+
|
801
|
+
</div><table class="source_code">
|
802
|
+
<tr>
|
803
|
+
<td>
|
804
|
+
<pre class="lines">
|
805
|
+
|
806
|
+
|
807
|
+
29
|
808
|
+
30
|
809
|
+
31</pre>
|
810
|
+
</td>
|
811
|
+
<td>
|
812
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 29</span>
|
813
|
+
|
814
|
+
<span class='def def kw'>def</span> <span class='valAxis identifier id'>valAxis</span>
|
815
|
+
<span class='@valAxis ivar id'>@valAxis</span>
|
816
|
+
<span class='end end kw'>end</span>
|
817
|
+
</pre>
|
818
|
+
</td>
|
819
|
+
</tr>
|
820
|
+
</table>
|
821
|
+
</div>
|
822
|
+
|
823
|
+
</div>
|
824
|
+
|
825
|
+
|
826
|
+
<div id="instance_method_details" class="method_details_list">
|
827
|
+
<h2>Instance Method Details</h2>
|
828
|
+
|
829
|
+
|
830
|
+
<div class="method_details first">
|
831
|
+
<p class="signature first" id="to_xml-instance_method">
|
832
|
+
|
833
|
+
- (<tt>String</tt>) <strong>to_xml</strong>
|
834
|
+
|
835
|
+
|
836
|
+
|
837
|
+
</p><div class="docstring">
|
838
|
+
<div class="discussion">
|
839
|
+
<p>
|
840
|
+
Serializes the bar chart
|
841
|
+
</p>
|
842
|
+
|
843
|
+
|
844
|
+
</div>
|
845
|
+
</div>
|
846
|
+
<div class="tags">
|
847
|
+
|
848
|
+
<h3>Returns:</h3>
|
849
|
+
<ul class="return">
|
850
|
+
|
851
|
+
<li>
|
852
|
+
|
853
|
+
|
854
|
+
<span class='type'>(<tt>String</tt>)</span>
|
855
|
+
|
856
|
+
|
857
|
+
|
858
|
+
</li>
|
859
|
+
|
860
|
+
</ul>
|
861
|
+
|
862
|
+
</div><table class="source_code">
|
863
|
+
<tr>
|
864
|
+
<td>
|
865
|
+
<pre class="lines">
|
866
|
+
|
867
|
+
|
868
|
+
76
|
869
|
+
77
|
870
|
+
78
|
871
|
+
79
|
872
|
+
80
|
873
|
+
81
|
874
|
+
82
|
875
|
+
83
|
876
|
+
84
|
877
|
+
85
|
878
|
+
86
|
879
|
+
87
|
880
|
+
88
|
881
|
+
89
|
882
|
+
90
|
883
|
+
91</pre>
|
884
|
+
</td>
|
885
|
+
<td>
|
886
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 76</span>
|
887
|
+
|
888
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span>
|
889
|
+
<span class='super super kw'>super</span><span class='lparen token'>(</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>
|
890
|
+
<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:line3DChart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
891
|
+
<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:grouping'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='grouping identifier id'>grouping</span><span class='rparen token'>)</span>
|
892
|
+
<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:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span>
|
893
|
+
<span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</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='rbrace token'>}</span>
|
894
|
+
<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:gapDepth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapDepth ivar id'>@gapDepth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
895
|
+
<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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span>
|
896
|
+
<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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span>
|
897
|
+
<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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@serAxId ivar id'>@serAxId</span><span class='rparen token'>)</span>
|
898
|
+
<span class='rbrace token'>}</span>
|
899
|
+
<span class='@catAxis ivar id'>@catAxis</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>
|
900
|
+
<span class='@valAxis ivar id'>@valAxis</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>
|
901
|
+
<span class='@serAxis ivar id'>@serAxis</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>
|
902
|
+
<span class='end end kw'>end</span>
|
903
|
+
<span class='end end kw'>end</span>
|
904
|
+
</pre>
|
905
|
+
</td>
|
906
|
+
</tr>
|
907
|
+
</table>
|
908
|
+
</div>
|
909
|
+
|
910
|
+
</div>
|
911
|
+
|
912
|
+
</div>
|
913
|
+
|
914
|
+
<div id="footer">
|
915
|
+
Generated on Tue Nov 22 00:27:46 2011 by
|
916
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
917
|
+
0.7.3 (ruby-1.8.7).
|
918
|
+
</div>
|
919
|
+
|
920
|
+
</body>
|
921
|
+
</html>
|