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.
Files changed (71) hide show
  1. data/README.md +10 -9
  2. data/doc/Axlsx.html +2443 -0
  3. data/doc/Axlsx/App.html +2640 -0
  4. data/doc/Axlsx/Axis.html +1047 -0
  5. data/doc/Axlsx/Bar3DChart.html +1153 -0
  6. data/doc/Axlsx/BarSeries.html +764 -0
  7. data/doc/Axlsx/Border.html +775 -0
  8. data/doc/Axlsx/BorderPr.html +709 -0
  9. data/doc/Axlsx/CatAxis.html +766 -0
  10. data/doc/Axlsx/Cell.html +1623 -0
  11. data/doc/Axlsx/CellAlignment.html +1247 -0
  12. data/doc/Axlsx/CellProtection.html +565 -0
  13. data/doc/Axlsx/CellStyle.html +949 -0
  14. data/doc/Axlsx/Chart.html +1459 -0
  15. data/doc/Axlsx/Color.html +665 -0
  16. data/doc/Axlsx/ContentType.html +340 -0
  17. data/doc/Axlsx/Core.html +465 -0
  18. data/doc/Axlsx/DataTypeValidator.html +324 -0
  19. data/doc/Axlsx/Default.html +575 -0
  20. data/doc/Axlsx/Drawing.html +1154 -0
  21. data/doc/Axlsx/Fill.html +460 -0
  22. data/doc/Axlsx/Font.html +1554 -0
  23. data/doc/Axlsx/GradientFill.html +1026 -0
  24. data/doc/Axlsx/GradientStop.html +526 -0
  25. data/doc/Axlsx/GraphicFrame.html +646 -0
  26. data/doc/Axlsx/Line3DChart.html +921 -0
  27. data/doc/Axlsx/LineSeries.html +656 -0
  28. data/doc/Axlsx/Marker.html +857 -0
  29. data/doc/Axlsx/NumFmt.html +562 -0
  30. data/doc/Axlsx/Override.html +568 -0
  31. data/doc/Axlsx/Package.html +1293 -0
  32. data/doc/Axlsx/PatternFill.html +681 -0
  33. data/doc/Axlsx/Pie3DChart.html +439 -0
  34. data/doc/Axlsx/PieSeries.html +762 -0
  35. data/doc/Axlsx/RegexValidator.html +268 -0
  36. data/doc/Axlsx/Relationship.html +554 -0
  37. data/doc/Axlsx/Relationships.html +343 -0
  38. data/doc/Axlsx/RestrictionValidator.html +300 -0
  39. data/doc/Axlsx/Row.html +771 -0
  40. data/doc/Axlsx/Scaling.html +740 -0
  41. data/doc/Axlsx/SerAxis.html +624 -0
  42. data/doc/Axlsx/Series.html +746 -0
  43. data/doc/Axlsx/SeriesTitle.html +289 -0
  44. data/doc/Axlsx/SimpleTypedList.html +1617 -0
  45. data/doc/Axlsx/Styles.html +1754 -0
  46. data/doc/Axlsx/TableStyle.html +710 -0
  47. data/doc/Axlsx/TableStyleElement.html +677 -0
  48. data/doc/Axlsx/TableStyles.html +599 -0
  49. data/doc/Axlsx/Title.html +625 -0
  50. data/doc/Axlsx/TwoCellAnchor.html +1115 -0
  51. data/doc/Axlsx/ValAxis.html +539 -0
  52. data/doc/Axlsx/View3D.html +971 -0
  53. data/doc/Axlsx/Workbook.html +1347 -0
  54. data/doc/Axlsx/Worksheet.html +1864 -0
  55. data/doc/Axlsx/Xf.html +1681 -0
  56. data/doc/_index.html +611 -0
  57. data/doc/class_list.html +47 -0
  58. data/doc/css/common.css +1 -0
  59. data/doc/css/full_list.css +55 -0
  60. data/doc/css/style.css +322 -0
  61. data/doc/file.README.html +262 -0
  62. data/doc/file_list.html +49 -0
  63. data/doc/frames.html +13 -0
  64. data/doc/index.html +262 -0
  65. data/doc/js/app.js +205 -0
  66. data/doc/js/full_list.js +167 -0
  67. data/doc/js/jquery.js +16 -0
  68. data/doc/method_list.html +3038 -0
  69. data/doc/top-level-namespace.html +103 -0
  70. data/lib/axlsx/util/constants.rb +1 -1
  71. metadata +71 -3
data/doc/Axlsx/ValAxis.html ADDED
@@ -0,0 +1,539 @@
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::ValAxis
8
+
9
+ &mdash; 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 (V)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
38
+ &raquo;
39
+ <span class="title">ValAxis</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::ValAxis
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="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></li>
75
+
76
+ <li class="next">Axlsx::ValAxis</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/val_axis.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 ValAxis class defines a chart value axis.
101
+ </p>
102
+
103
+
104
+ </div>
105
+ </div>
106
+ <div class="tags">
107
+
108
+
109
+ </div>
110
+
111
+
112
+
113
+
114
+
115
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
116
+ <ul class="summary">
117
+
118
+ <li class="public ">
119
+ <span class="summary_signature">
120
+
121
+ <a href="#crossBetween-instance_method" title="#crossBetween (instance method)">- (Symbol) <strong>crossBetween</strong> </a>
122
+
123
+
124
+
125
+ </span>
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+ <span class="summary_desc"><div class='inline'><p>
138
+ This element specifies whether the value axis crosses the category axis
139
+ between categories.
140
+ </p>
141
+ </div></span>
142
+
143
+ </li>
144
+
145
+
146
+ </ul>
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></h3>
156
+ <p class="inherited"><span class='object_link'><a href="Axis.html#axId-instance_method" title="Axlsx::Axis#axId (method)">axId</a></span>, <span class='object_link'><a href="Axis.html#axPos-instance_method" title="Axlsx::Axis#axPos (method)">axPos</a></span>, <span class='object_link'><a href="Axis.html#crossAx-instance_method" title="Axlsx::Axis#crossAx (method)">crossAx</a></span>, <span class='object_link'><a href="Axis.html#crosses-instance_method" title="Axlsx::Axis#crosses (method)">crosses</a></span>, <span class='object_link'><a href="Axis.html#format_code-instance_method" title="Axlsx::Axis#format_code (method)">format_code</a></span>, <span class='object_link'><a href="Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">scaling</a></span>, <span class='object_link'><a href="Axis.html#tickLblPos-instance_method" title="Axlsx::Axis#tickLblPos (method)">tickLblPos</a></span></p>
157
+
158
+
159
+
160
+ <h2>
161
+ Instance Method Summary
162
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
163
+ </h2>
164
+
165
+ <ul class="summary">
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (ValAxis) <strong>initialize</strong>(axId, crossAx, options = {}) </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+ <span class="note title constructor">constructor</span>
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'><p>
186
+ Creates a new ValAxis object.
187
+ </p>
188
+ </div></span>
189
+
190
+ </li>
191
+
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+ <span class="summary_desc"><div class='inline'><p>
210
+ Serializes the value axis.
211
+ </p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ </ul>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+ <div id="constructor_details" class="method_details_list">
226
+ <h2>Constructor Details</h2>
227
+
228
+ <div class="method_details first">
229
+ <p class="signature first" id="initialize-instance_method">
230
+
231
+ - (<tt><span class='object_link'><a href="" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {})
232
+
233
+
234
+
235
+ </p><div class="docstring">
236
+ <div class="discussion">
237
+ <p>
238
+ Creates a new ValAxis object
239
+ </p>
240
+
241
+
242
+ </div>
243
+ </div>
244
+ <div class="tags">
245
+ <h3>Parameters:</h3>
246
+ <ul class="param">
247
+
248
+ <li>
249
+
250
+ <span class='name'>axId</span>
251
+
252
+
253
+ <span class='type'>(<tt>Integer</tt>)</span>
254
+
255
+
256
+
257
+ &mdash;
258
+ <div class='inline'><p>
259
+ the id of this axis
260
+ </p>
261
+ </div>
262
+
263
+ </li>
264
+
265
+ <li>
266
+
267
+ <span class='name'>crossAx</span>
268
+
269
+
270
+ <span class='type'>(<tt>Integer</tt>)</span>
271
+
272
+
273
+
274
+ &mdash;
275
+ <div class='inline'><p>
276
+ the id of the perpendicular axis
277
+ </p>
278
+ </div>
279
+
280
+ </li>
281
+
282
+ <li>
283
+
284
+ <span class='name'>options</span>
285
+
286
+
287
+ <span class='type'>(<tt>Hash</tt>)</span>
288
+
289
+
290
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
291
+
292
+
293
+ &mdash;
294
+ <div class='inline'><p>
295
+ a customizable set of options
296
+ </p>
297
+ </div>
298
+
299
+ </li>
300
+
301
+ </ul>
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+ <h3>Options Hash (<tt>options</tt>):</h3>
311
+ <ul class="option">
312
+
313
+ <li>
314
+ <span class="name">axPos</span>
315
+ <span class="type">(<tt>Symbol</tt>)</span>
316
+ <span class="default">
317
+
318
+ </span>
319
+
320
+ </li>
321
+
322
+ <li>
323
+ <span class="name">crosses</span>
324
+ <span class="type">(<tt>Symbol</tt>)</span>
325
+ <span class="default">
326
+
327
+ </span>
328
+
329
+ </li>
330
+
331
+ <li>
332
+ <span class="name">tickLblPos</span>
333
+ <span class="type">(<tt>Symbol</tt>)</span>
334
+ <span class="default">
335
+
336
+ </span>
337
+
338
+ </li>
339
+
340
+ <li>
341
+ <span class="name">crossesBetween</span>
342
+ <span class="type">(<tt>Symbol</tt>)</span>
343
+ <span class="default">
344
+
345
+ </span>
346
+
347
+ </li>
348
+
349
+ </ul>
350
+
351
+
352
+
353
+ </div><table class="source_code">
354
+ <tr>
355
+ <td>
356
+ <pre class="lines">
357
+
358
+
359
+ 17
360
+ 18
361
+ 19
362
+ 20</pre>
363
+ </td>
364
+ <td>
365
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 17</span>
366
+
367
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</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>
368
+ <span class='@crossBetween ivar id'>@crossBetween</span> <span class='assign token'>=</span> <span class='symbol val'>:between</span>
369
+ <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
370
+ <span class='end end kw'>end</span>
371
+ </pre>
372
+ </td>
373
+ </tr>
374
+ </table>
375
+ </div>
376
+
377
+ </div>
378
+
379
+ <div id="instance_attr_details" class="attr_details">
380
+ <h2>Instance Attribute Details</h2>
381
+
382
+
383
+ <span id="crossBetween=-instance_method"></span>
384
+ <span id="crossBetween-instance_method"></span>
385
+ <div class="method_details first">
386
+ <p class="signature first" id="crossBetween-instance_method">
387
+
388
+ - (<tt>Symbol</tt>) <strong>crossBetween</strong>
389
+
390
+
391
+
392
+ </p><div class="docstring">
393
+ <div class="discussion">
394
+ <p>
395
+ This element specifies whether the value axis crosses the category axis
396
+ between categories. must be one of [:between, :midCat]
397
+ </p>
398
+
399
+
400
+ </div>
401
+ </div>
402
+ <div class="tags">
403
+
404
+ <h3>Returns:</h3>
405
+ <ul class="return">
406
+
407
+ <li>
408
+
409
+
410
+ <span class='type'>(<tt>Symbol</tt>)</span>
411
+
412
+
413
+
414
+ </li>
415
+
416
+ </ul>
417
+
418
+ </div><table class="source_code">
419
+ <tr>
420
+ <td>
421
+ <pre class="lines">
422
+
423
+
424
+ 8
425
+ 9
426
+ 10</pre>
427
+ </td>
428
+ <td>
429
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 8</span>
430
+
431
+ <span class='def def kw'>def</span> <span class='crossBetween identifier id'>crossBetween</span>
432
+ <span class='@crossBetween ivar id'>@crossBetween</span>
433
+ <span class='end end kw'>end</span>
434
+ </pre>
435
+ </td>
436
+ </tr>
437
+ </table>
438
+ </div>
439
+
440
+ </div>
441
+
442
+
443
+ <div id="instance_method_details" class="method_details_list">
444
+ <h2>Instance Method Details</h2>
445
+
446
+
447
+ <div class="method_details first">
448
+ <p class="signature first" id="to_xml-instance_method">
449
+
450
+ - (<tt>String</tt>) <strong>to_xml</strong>(xml)
451
+
452
+
453
+
454
+ </p><div class="docstring">
455
+ <div class="discussion">
456
+ <p>
457
+ Serializes the value axis
458
+ </p>
459
+
460
+
461
+ </div>
462
+ </div>
463
+ <div class="tags">
464
+ <h3>Parameters:</h3>
465
+ <ul class="param">
466
+
467
+ <li>
468
+
469
+ <span class='name'>xml</span>
470
+
471
+
472
+ <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
473
+
474
+
475
+
476
+ &mdash;
477
+ <div class='inline'><p>
478
+ The document builder instance this objects xml will be added to.
479
+ </p>
480
+ </div>
481
+
482
+ </li>
483
+
484
+ </ul>
485
+
486
+ <h3>Returns:</h3>
487
+ <ul class="return">
488
+
489
+ <li>
490
+
491
+
492
+ <span class='type'>(<tt>String</tt>)</span>
493
+
494
+
495
+
496
+ </li>
497
+
498
+ </ul>
499
+
500
+ </div><table class="source_code">
501
+ <tr>
502
+ <td>
503
+ <pre class="lines">
504
+
505
+
506
+ 27
507
+ 28
508
+ 29
509
+ 30
510
+ 31
511
+ 32</pre>
512
+ </td>
513
+ <td>
514
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 27</span>
515
+
516
+ <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>
517
+ <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:valAx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
518
+ <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
519
+ <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:crossBetween'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>&gt;</span><span class='@crossBetween ivar id'>@crossBetween</span><span class='rparen token'>)</span>
520
+ <span class='rbrace token'>}</span>
521
+ <span class='end end kw'>end</span>
522
+ </pre>
523
+ </td>
524
+ </tr>
525
+ </table>
526
+ </div>
527
+
528
+ </div>
529
+
530
+ </div>
531
+
532
+ <div id="footer">
533
+ Generated on Tue Nov 22 00:27:37 2011 by
534
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
535
+ 0.7.3 (ruby-1.8.7).
536
+ </div>
537
+
538
+ </body>
539
+ </html>