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
@@ -0,0 +1,568 @@
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::Override
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 (O)</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">Override</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::Override
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::Override</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/content_type/override.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>
98
+ An override content part. These parts are automatically created by for you
99
+ based on the content of your package.
100
+ </p>
101
+
102
+
103
+ </div>
104
+ </div>
105
+ <div class="tags">
106
+
107
+
108
+ </div>
109
+
110
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
111
+ <ul class="summary">
112
+
113
+ <li class="public ">
114
+ <span class="summary_signature">
115
+
116
+ <a href="#ContentType-instance_method" title="#ContentType (instance method)">- (String) <strong>ContentType</strong> </a>
117
+
118
+
119
+
120
+ </span>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+ <span class="summary_desc"><div class='inline'><p>
133
+ ContentType The type of content.
134
+ </p>
135
+ </div></span>
136
+
137
+ </li>
138
+
139
+
140
+ <li class="public ">
141
+ <span class="summary_signature">
142
+
143
+ <a href="#PartName-instance_method" title="#PartName (instance method)">- (String) <strong>PartName</strong> </a>
144
+
145
+
146
+
147
+ </span>
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'><p>
160
+ PartName The name and location of the part.
161
+ </p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ </ul>
168
+
169
+
170
+
171
+
172
+
173
+ <h2>
174
+ Instance Method Summary
175
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
176
+ </h2>
177
+
178
+ <ul class="summary">
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Override) <strong>initialize</strong>(options = {}) </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+ <span class="note title constructor">constructor</span>
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'><p>
199
+ Creates a new Override object.
200
+ </p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (Object) <strong>to_xml</strong>(xml) </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+ <span class="summary_desc"><div class='inline'><p>
223
+ Serializes the Override object to xml.
224
+ </p>
225
+ </div></span>
226
+
227
+ </li>
228
+
229
+
230
+ </ul>
231
+
232
+
233
+ <div id="constructor_details" class="method_details_list">
234
+ <h2>Constructor Details</h2>
235
+
236
+ <div class="method_details first">
237
+ <p class="signature first" id="initialize-instance_method">
238
+
239
+ - (<tt><span class='object_link'><a href="" title="Axlsx::Override (class)">Override</a></span></tt>) <strong>initialize</strong>(options = {})
240
+
241
+
242
+
243
+ </p><div class="docstring">
244
+ <div class="discussion">
245
+ <p>
246
+ Creates a new Override object
247
+ </p>
248
+
249
+
250
+ </div>
251
+ </div>
252
+ <div class="tags">
253
+ <h3>Parameters:</h3>
254
+ <ul class="param">
255
+
256
+ <li>
257
+
258
+ <span class='name'>options</span>
259
+
260
+
261
+ <span class='type'>(<tt>Hash</tt>)</span>
262
+
263
+
264
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
265
+
266
+
267
+ &mdash;
268
+ <div class='inline'><p>
269
+ a customizable set of options
270
+ </p>
271
+ </div>
272
+
273
+ </li>
274
+
275
+ </ul>
276
+
277
+
278
+
279
+
280
+ <h3>Options Hash (<tt>options</tt>):</h3>
281
+ <ul class="option">
282
+
283
+ <li>
284
+ <span class="name">PartName</span>
285
+ <span class="type">(<tt>String</tt>)</span>
286
+ <span class="default">
287
+
288
+ </span>
289
+
290
+ </li>
291
+
292
+ <li>
293
+ <span class="name">ContentType</span>
294
+ <span class="type">(<tt>String</tt>)</span>
295
+ <span class="default">
296
+
297
+ </span>
298
+
299
+ </li>
300
+
301
+ </ul>
302
+
303
+
304
+ <h3>Raises:</h3>
305
+ <ul class="raise">
306
+
307
+ <li>
308
+
309
+
310
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
311
+
312
+
313
+
314
+ &mdash;
315
+ <div class='inline'><p>
316
+ An argument error is raised if both PartName and ContentType are not
317
+ specified.
318
+ </p>
319
+ </div>
320
+
321
+ </li>
322
+
323
+ </ul>
324
+
325
+ </div><table class="source_code">
326
+ <tr>
327
+ <td>
328
+ <pre class="lines">
329
+
330
+
331
+ 15
332
+ 16
333
+ 17
334
+ 18
335
+ 19
336
+ 20</pre>
337
+ </td>
338
+ <td>
339
+ <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 15</span>
340
+
341
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</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>
342
+ <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>&quot;PartName and ContentType are required&quot;</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:PartName</span><span class='rbrack token'>]</span> <span class='andop op'>&amp;&amp;</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack token'>]</span>
343
+ <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>
344
+ <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'>&quot;#{o[0]}=&quot;</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'>&quot;#{o[0]}=&quot;</span>
345
+ <span class='end end kw'>end</span>
346
+ <span class='end end kw'>end</span>
347
+ </pre>
348
+ </td>
349
+ </tr>
350
+ </table>
351
+ </div>
352
+
353
+ </div>
354
+
355
+ <div id="instance_attr_details" class="attr_details">
356
+ <h2>Instance Attribute Details</h2>
357
+
358
+
359
+ <span id="ContentType=-instance_method"></span>
360
+ <span id="ContentType-instance_method"></span>
361
+ <div class="method_details first">
362
+ <p class="signature first" id="ContentType-instance_method">
363
+
364
+ - (<tt>String</tt>) <strong>ContentType</strong>
365
+
366
+
367
+
368
+ </p><div class="docstring">
369
+ <div class="discussion">
370
+ <p>
371
+ ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT,
372
+ STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT,
373
+ DRAWING_CT are allowed
374
+ </p>
375
+
376
+
377
+ </div>
378
+ </div>
379
+ <div class="tags">
380
+
381
+ <h3>Returns:</h3>
382
+ <ul class="return">
383
+
384
+ <li>
385
+
386
+
387
+ <span class='type'>(<tt>String</tt>)</span>
388
+
389
+
390
+
391
+ &mdash;
392
+ <div class='inline'><p>
393
+ ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT,
394
+ STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT,
395
+ DRAWING_CT are allowed
396
+ </p>
397
+ </div>
398
+
399
+ </li>
400
+
401
+ </ul>
402
+
403
+ </div><table class="source_code">
404
+ <tr>
405
+ <td>
406
+ <pre class="lines">
407
+
408
+
409
+ 6
410
+ 7
411
+ 8</pre>
412
+ </td>
413
+ <td>
414
+ <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 6</span>
415
+
416
+ <span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span>
417
+ <span class='@ContentType ivar id'>@ContentType</span>
418
+ <span class='end end kw'>end</span>
419
+ </pre>
420
+ </td>
421
+ </tr>
422
+ </table>
423
+ </div>
424
+
425
+
426
+ <span id="PartName=-instance_method"></span>
427
+ <span id="PartName-instance_method"></span>
428
+ <div class="method_details ">
429
+ <p class="signature " id="PartName-instance_method">
430
+
431
+ - (<tt>String</tt>) <strong>PartName</strong>
432
+
433
+
434
+
435
+ </p><div class="docstring">
436
+ <div class="discussion">
437
+ <p>
438
+ PartName The name and location of the part.
439
+ </p>
440
+
441
+
442
+ </div>
443
+ </div>
444
+ <div class="tags">
445
+
446
+ <h3>Returns:</h3>
447
+ <ul class="return">
448
+
449
+ <li>
450
+
451
+
452
+ <span class='type'>(<tt>String</tt>)</span>
453
+
454
+
455
+
456
+ &mdash;
457
+ <div class='inline'><p>
458
+ PartName The name and location of the part.
459
+ </p>
460
+ </div>
461
+
462
+ </li>
463
+
464
+ </ul>
465
+
466
+ </div><table class="source_code">
467
+ <tr>
468
+ <td>
469
+ <pre class="lines">
470
+
471
+
472
+ 9
473
+ 10
474
+ 11</pre>
475
+ </td>
476
+ <td>
477
+ <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 9</span>
478
+
479
+ <span class='def def kw'>def</span> <span class='PartName constant id'>PartName</span>
480
+ <span class='@PartName ivar id'>@PartName</span>
481
+ <span class='end end kw'>end</span>
482
+ </pre>
483
+ </td>
484
+ </tr>
485
+ </table>
486
+ </div>
487
+
488
+ </div>
489
+
490
+
491
+ <div id="instance_method_details" class="method_details_list">
492
+ <h2>Instance Method Details</h2>
493
+
494
+
495
+ <div class="method_details first">
496
+ <p class="signature first" id="to_xml-instance_method">
497
+
498
+ - (<tt>Object</tt>) <strong>to_xml</strong>(xml)
499
+
500
+
501
+
502
+ </p><div class="docstring">
503
+ <div class="discussion">
504
+ <p>
505
+ Serializes the Override object to xml
506
+ </p>
507
+
508
+
509
+ </div>
510
+ </div>
511
+ <div class="tags">
512
+ <h3>Parameters:</h3>
513
+ <ul class="param">
514
+
515
+ <li>
516
+
517
+ <span class='name'>xml</span>
518
+
519
+
520
+ <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
521
+
522
+
523
+
524
+ &mdash;
525
+ <div class='inline'><p>
526
+ The document builder instance this objects xml will be added to.
527
+ </p>
528
+ </div>
529
+
530
+ </li>
531
+
532
+ </ul>
533
+
534
+
535
+ </div><table class="source_code">
536
+ <tr>
537
+ <td>
538
+ <pre class="lines">
539
+
540
+
541
+ 26
542
+ 27
543
+ 28</pre>
544
+ </td>
545
+ <td>
546
+ <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 26</span>
547
+
548
+ <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>
549
+ <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Override constant id'>Override</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span>
550
+ <span class='end end kw'>end</span>
551
+ </pre>
552
+ </td>
553
+ </tr>
554
+ </table>
555
+ </div>
556
+
557
+ </div>
558
+
559
+ </div>
560
+
561
+ <div id="footer">
562
+ Generated on Tue Nov 22 00:27:56 2011 by
563
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
564
+ 0.7.3 (ruby-1.8.7).
565
+ </div>
566
+
567
+ </body>
568
+ </html>