axlsx 1.0.11 → 1.0.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (145) hide show
  1. data/.yardopts +4 -0
  2. data/README.md +7 -4
  3. data/examples/example.rb +6 -4
  4. data/examples/example.rb~ +112 -0
  5. data/lib/schema/dc.xsd~ +118 -0
  6. data/lib/schema/dcterms.xsd~ +331 -0
  7. data/lib/schema/opc-coreProperties.xsd~ +50 -0
  8. metadata +43 -193
  9. data/Gemfile +0 -3
  10. data/Gemfile.lock +0 -29
  11. data/axlsx.gemspec +0 -42
  12. data/doc/Axlsx.html +0 -2718
  13. data/doc/Axlsx/App.html +0 -2640
  14. data/doc/Axlsx/Axis.html +0 -1075
  15. data/doc/Axlsx/Bar3DChart.html +0 -1182
  16. data/doc/Axlsx/BarSeries.html +0 -711
  17. data/doc/Axlsx/Border.html +0 -779
  18. data/doc/Axlsx/BorderPr.html +0 -709
  19. data/doc/Axlsx/CatAxis.html +0 -769
  20. data/doc/Axlsx/CatAxisData.html +0 -397
  21. data/doc/Axlsx/Cell.html +0 -3187
  22. data/doc/Axlsx/CellAlignment.html +0 -1247
  23. data/doc/Axlsx/CellProtection.html +0 -565
  24. data/doc/Axlsx/CellStyle.html +0 -949
  25. data/doc/Axlsx/Chart.html +0 -1692
  26. data/doc/Axlsx/Color.html +0 -670
  27. data/doc/Axlsx/ContentType.html +0 -335
  28. data/doc/Axlsx/Core.html +0 -465
  29. data/doc/Axlsx/DataTypeValidator.html +0 -324
  30. data/doc/Axlsx/Default.html +0 -565
  31. data/doc/Axlsx/Drawing.html +0 -1264
  32. data/doc/Axlsx/Fill.html +0 -460
  33. data/doc/Axlsx/Font.html +0 -1554
  34. data/doc/Axlsx/GradientFill.html +0 -1026
  35. data/doc/Axlsx/GradientStop.html +0 -526
  36. data/doc/Axlsx/GraphicFrame.html +0 -642
  37. data/doc/Axlsx/Line3DChart.html +0 -1004
  38. data/doc/Axlsx/LineSeries.html +0 -605
  39. data/doc/Axlsx/Marker.html +0 -857
  40. data/doc/Axlsx/NumFmt.html +0 -562
  41. data/doc/Axlsx/OneCellAnchor.html +0 -982
  42. data/doc/Axlsx/Override.html +0 -552
  43. data/doc/Axlsx/Package.html +0 -825
  44. data/doc/Axlsx/Parser.html +0 -549
  45. data/doc/Axlsx/PatternFill.html +0 -681
  46. data/doc/Axlsx/Pic.html +0 -1701
  47. data/doc/Axlsx/PictureLocking.html +0 -1159
  48. data/doc/Axlsx/Pie3DChart.html +0 -489
  49. data/doc/Axlsx/PieSeries.html +0 -710
  50. data/doc/Axlsx/RegexValidator.html +0 -268
  51. data/doc/Axlsx/Relationship.html +0 -554
  52. data/doc/Axlsx/Relationships.html +0 -338
  53. data/doc/Axlsx/RestrictionValidator.html +0 -300
  54. data/doc/Axlsx/Row.html +0 -916
  55. data/doc/Axlsx/Scaling.html +0 -742
  56. data/doc/Axlsx/SerAxis.html +0 -641
  57. data/doc/Axlsx/Series.html +0 -813
  58. data/doc/Axlsx/SeriesTitle.html +0 -290
  59. data/doc/Axlsx/Styles.html +0 -1754
  60. data/doc/Axlsx/TableStyle.html +0 -705
  61. data/doc/Axlsx/TableStyleElement.html +0 -677
  62. data/doc/Axlsx/TableStyles.html +0 -594
  63. data/doc/Axlsx/Title.html +0 -543
  64. data/doc/Axlsx/TwoCellAnchor.html +0 -973
  65. data/doc/Axlsx/ValAxis.html +0 -538
  66. data/doc/Axlsx/ValAxisData.html +0 -321
  67. data/doc/Axlsx/View3D.html +0 -973
  68. data/doc/Axlsx/Workbook.html +0 -1630
  69. data/doc/Axlsx/Worksheet.html +0 -2682
  70. data/doc/Axlsx/Xf.html +0 -1780
  71. data/doc/_index.html +0 -649
  72. data/doc/class_list.html +0 -47
  73. data/doc/css/common.css +0 -1
  74. data/doc/css/full_list.css +0 -55
  75. data/doc/css/style.css +0 -322
  76. data/doc/file.LICENSE.html +0 -91
  77. data/doc/file.README.html +0 -338
  78. data/doc/file_list.html +0 -52
  79. data/doc/frames.html +0 -13
  80. data/doc/index.html +0 -338
  81. data/doc/js/app.js +0 -205
  82. data/doc/js/full_list.js +0 -167
  83. data/doc/js/jquery.js +0 -16
  84. data/doc/method_list.html +0 -3502
  85. data/doc/top-level-namespace.html +0 -103
  86. data/lib/axlsx.rb +0 -54
  87. data/lib/axlsx/content_type/content_type.rb +0 -23
  88. data/lib/axlsx/content_type/default.rb +0 -37
  89. data/lib/axlsx/content_type/override.rb +0 -37
  90. data/lib/axlsx/doc_props/app.rb +0 -178
  91. data/lib/axlsx/doc_props/core.rb +0 -34
  92. data/lib/axlsx/drawing/axis.rb +0 -90
  93. data/lib/axlsx/drawing/bar_3D_chart.rb +0 -128
  94. data/lib/axlsx/drawing/bar_series.rb +0 -64
  95. data/lib/axlsx/drawing/cat_axis.rb +0 -63
  96. data/lib/axlsx/drawing/cat_axis_data.rb +0 -35
  97. data/lib/axlsx/drawing/chart.rb +0 -179
  98. data/lib/axlsx/drawing/drawing.rb +0 -137
  99. data/lib/axlsx/drawing/graphic_frame.rb +0 -52
  100. data/lib/axlsx/drawing/line_3D_chart.rb +0 -106
  101. data/lib/axlsx/drawing/line_series.rb +0 -46
  102. data/lib/axlsx/drawing/marker.rb +0 -61
  103. data/lib/axlsx/drawing/one_cell_anchor.rb +0 -89
  104. data/lib/axlsx/drawing/pic.rb +0 -153
  105. data/lib/axlsx/drawing/picture_locking.rb +0 -72
  106. data/lib/axlsx/drawing/pie_3D_chart.rb +0 -41
  107. data/lib/axlsx/drawing/pie_series.rb +0 -56
  108. data/lib/axlsx/drawing/scaling.rb +0 -59
  109. data/lib/axlsx/drawing/ser_axis.rb +0 -45
  110. data/lib/axlsx/drawing/series.rb +0 -71
  111. data/lib/axlsx/drawing/series_title.rb +0 -22
  112. data/lib/axlsx/drawing/title.rb +0 -61
  113. data/lib/axlsx/drawing/two_cell_anchor.rb +0 -76
  114. data/lib/axlsx/drawing/val_axis.rb +0 -34
  115. data/lib/axlsx/drawing/val_axis_data.rb +0 -28
  116. data/lib/axlsx/drawing/view_3D.rb +0 -85
  117. data/lib/axlsx/package.rb +0 -214
  118. data/lib/axlsx/rels/relationship.rb +0 -44
  119. data/lib/axlsx/rels/relationships.rb +0 -25
  120. data/lib/axlsx/stylesheet/border.rb +0 -57
  121. data/lib/axlsx/stylesheet/border_pr.rb +0 -68
  122. data/lib/axlsx/stylesheet/cell_alignment.rb +0 -105
  123. data/lib/axlsx/stylesheet/cell_protection.rb +0 -36
  124. data/lib/axlsx/stylesheet/cell_style.rb +0 -65
  125. data/lib/axlsx/stylesheet/color.rb +0 -69
  126. data/lib/axlsx/stylesheet/fill.rb +0 -32
  127. data/lib/axlsx/stylesheet/font.rb +0 -139
  128. data/lib/axlsx/stylesheet/gradient_fill.rb +0 -76
  129. data/lib/axlsx/stylesheet/gradient_stop.rb +0 -33
  130. data/lib/axlsx/stylesheet/num_fmt.rb +0 -63
  131. data/lib/axlsx/stylesheet/pattern_fill.rb +0 -66
  132. data/lib/axlsx/stylesheet/styles.rb +0 -298
  133. data/lib/axlsx/stylesheet/table_style.rb +0 -47
  134. data/lib/axlsx/stylesheet/table_style_element.rb +0 -71
  135. data/lib/axlsx/stylesheet/table_styles.rb +0 -39
  136. data/lib/axlsx/stylesheet/xf.rb +0 -138
  137. data/lib/axlsx/util/constants.rb +0 -216
  138. data/lib/axlsx/util/parser.rb +0 -43
  139. data/lib/axlsx/util/simple_typed_list.rb +0 -160
  140. data/lib/axlsx/util/validators.rb +0 -132
  141. data/lib/axlsx/version.rb +0 -4
  142. data/lib/axlsx/workbook/workbook.rb +0 -160
  143. data/lib/axlsx/workbook/worksheet/cell.rb +0 -340
  144. data/lib/axlsx/workbook/worksheet/row.rb +0 -107
  145. data/lib/axlsx/workbook/worksheet/worksheet.rb +0 -278
data/doc/Axlsx/Workbook.html DELETED
@@ -1,1630 +0,0 @@
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::Workbook
8
-
9
- &mdash; AXLSX
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 (W)</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">Workbook</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::Workbook
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::Workbook</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/workbook/workbook.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
- The Workbook class is an xlsx workbook that manages worksheets, charts,
99
- drawings and styles. The following parts of the Office Open XML spreadsheet
100
- specification are not implimented in this version.
101
- </p>
102
- <pre class="code">
103
- <span class='bookViews identifier id'>bookViews</span>
104
- <span class='calcPr identifier id'>calcPr</span>
105
- <span class='customWorkbookViews identifier id'>customWorkbookViews</span>
106
- <span class='definedNames identifier id'>definedNames</span>
107
- <span class='externalReferences identifier id'>externalReferences</span>
108
- <span class='extLst identifier id'>extLst</span>
109
- <span class='fileRecoveryPr identifier id'>fileRecoveryPr</span>
110
- <span class='fileSharing identifier id'>fileSharing</span>
111
- <span class='fileVersion identifier id'>fileVersion</span>
112
- <span class='functionGroups identifier id'>functionGroups</span>
113
- <span class='oleSize identifier id'>oleSize</span>
114
- <span class='pivotCaches identifier id'>pivotCaches</span>
115
- <span class='smartTagPr identifier id'>smartTagPr</span>
116
- <span class='smartTagTypes identifier id'>smartTagTypes</span>
117
- <span class='webPublishing identifier id'>webPublishing</span>
118
- <span class='webPublishObjects identifier id'>webPublishObjects</span>
119
- <span class='workbookProtection identifier id'>workbookProtection</span>
120
- <span class='workbookPr identifier id'>workbookPr</span><span class='mult op'>*</span>
121
-
122
- <span class='mult op'>*</span><span class='workbookPr identifier id'>workbookPr</span> <span class='is identifier id'>is</span> <span class='only identifier id'>only</span> <span class='supported identifier id'>supported</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='extend identifier id'>extend</span> <span class='of identifier id'>of</span> <span class='date1904 identifier id'>date1904</span>
123
- </pre>
124
-
125
-
126
- </div>
127
- </div>
128
- <div class="tags">
129
-
130
-
131
- </div>
132
- <h2>Constant Summary</h2>
133
-
134
- <dl class="constants">
135
-
136
- <dt id="date1904-classvariable" class="">@@date1904 =
137
- <div class="docstring">
138
- <div class="discussion">
139
- <p>
140
- Indicates if the epoc date for serialization should be 1904. If false, 1900
141
- is used.
142
- </p>
143
-
144
-
145
- </div>
146
- </div>
147
- <div class="tags">
148
-
149
-
150
- </div>
151
- </dt>
152
- <dd><pre class="code"><span class='false false kw'>false</span>
153
- </pre></dd>
154
-
155
- </dl>
156
-
157
-
158
-
159
- <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
160
- <ul class="summary">
161
-
162
- <li class="public ">
163
- <span class="summary_signature">
164
-
165
- <a href="#charts-instance_method" title="#charts (instance method)">- (SimpleTypedList) <strong>charts</strong> </a>
166
-
167
-
168
-
169
- </span>
170
-
171
-
172
- <span class="note title readonly">readonly</span>
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
- <span class="summary_desc"><div class='inline'><p>
182
- A colllection of charts associated with this workbook.
183
- </p>
184
- </div></span>
185
-
186
- </li>
187
-
188
-
189
- <li class="public ">
190
- <span class="summary_signature">
191
-
192
- <a href="#drawings-instance_method" title="#drawings (instance method)">- (SimpleTypedList) <strong>drawings</strong> </a>
193
-
194
-
195
-
196
- </span>
197
-
198
-
199
- <span class="note title readonly">readonly</span>
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
- <span class="summary_desc"><div class='inline'><p>
209
- A colllection of drawings associated with this workbook.
210
- </p>
211
- </div></span>
212
-
213
- </li>
214
-
215
-
216
- <li class="public ">
217
- <span class="summary_signature">
218
-
219
- <a href="#images-instance_method" title="#images (instance method)">- (SimpleTypedList) <strong>images</strong> </a>
220
-
221
-
222
-
223
- </span>
224
-
225
-
226
- <span class="note title readonly">readonly</span>
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
- <span class="summary_desc"><div class='inline'><p>
236
- A colllection of images associated with this workbook.
237
- </p>
238
- </div></span>
239
-
240
- </li>
241
-
242
-
243
- <li class="public ">
244
- <span class="summary_signature">
245
-
246
- <a href="#worksheets-instance_method" title="#worksheets (instance method)">- (SimpleTypedList) <strong>worksheets</strong> </a>
247
-
248
-
249
-
250
- </span>
251
-
252
-
253
- <span class="note title readonly">readonly</span>
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
- <span class="summary_desc"><div class='inline'><p>
263
- A collection of worksheets associated with this workbook.
264
- </p>
265
- </div></span>
266
-
267
- </li>
268
-
269
-
270
- </ul>
271
-
272
-
273
-
274
-
275
-
276
- <h2>
277
- Class Method Summary
278
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
279
- </h2>
280
-
281
- <ul class="summary">
282
-
283
- <li class="public ">
284
- <span class="summary_signature">
285
-
286
- <a href="#date1904-class_method" title="date1904 (class method)">+ (Boolean) <strong>date1904</strong> </a>
287
-
288
-
289
-
290
- </span>
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
- <span class="summary_desc"><div class='inline'><p>
300
- retrieves the date1904 attribute.
301
- </p>
302
- </div></span>
303
-
304
- </li>
305
-
306
-
307
- <li class="public ">
308
- <span class="summary_signature">
309
-
310
- <a href="#date1904%3D-class_method" title="date1904= (class method)">+ (Boolean) <strong>date1904=</strong>(v) </a>
311
-
312
-
313
-
314
- </span>
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
- <span class="summary_desc"><div class='inline'><p>
324
- Sets the date1904 attribute to the provided boolean.
325
- </p>
326
- </div></span>
327
-
328
- </li>
329
-
330
-
331
- </ul>
332
-
333
- <h2>
334
- Instance Method Summary
335
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
336
- </h2>
337
-
338
- <ul class="summary">
339
-
340
- <li class="public ">
341
- <span class="summary_signature">
342
-
343
- <a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Cell, Array) <strong>[]</strong>(cell_def) </a>
344
-
345
-
346
-
347
- </span>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
- <span class="summary_desc"><div class='inline'><p>
357
- returns a range of cells in a worksheet retrieve the cells from.
358
- </p>
359
- </div></span>
360
-
361
- </li>
362
-
363
-
364
- <li class="public ">
365
- <span class="summary_signature">
366
-
367
- <a href="#add_worksheet-instance_method" title="#add_worksheet (instance method)">- (Worksheet) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... }</a>
368
-
369
-
370
-
371
- </span>
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
- <span class="summary_desc"><div class='inline'><p>
381
- Adds a worksheet to this workbook.
382
- </p>
383
- </div></span>
384
-
385
- </li>
386
-
387
-
388
- <li class="public ">
389
- <span class="summary_signature">
390
-
391
- <a href="#date1904-instance_method" title="#date1904 (instance method)">- (Boolean) <strong>date1904</strong> </a>
392
-
393
-
394
-
395
- </span>
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
- <span class="summary_desc"><div class='inline'><p>
405
- Instance level access to the class variable 1904.
406
- </p>
407
- </div></span>
408
-
409
- </li>
410
-
411
-
412
- <li class="public ">
413
- <span class="summary_signature">
414
-
415
- <a href="#date1904%3D-instance_method" title="#date1904= (instance method)">- (Object) <strong>date1904=</strong>(v) </a>
416
-
417
-
418
-
419
- </span>
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
- <span class="summary_desc"><div class='inline'><p>
429
- see @date1904.
430
- </p>
431
- </div></span>
432
-
433
- </li>
434
-
435
-
436
- <li class="public ">
437
- <span class="summary_signature">
438
-
439
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Workbook) <strong>initialize</strong>(options = {}) {|_self| ... }</a>
440
-
441
-
442
-
443
- </span>
444
-
445
- <span class="note title constructor">constructor</span>
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
- <span class="summary_desc"><div class='inline'><p>
455
- Creates a new Workbook.
456
- </p>
457
- </div></span>
458
-
459
- </li>
460
-
461
-
462
- <li class="public ">
463
- <span class="summary_signature">
464
-
465
- <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a>
466
-
467
-
468
-
469
- </span>
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
- <span class="summary_desc"><div class='inline'><p>
479
- The workbook relationships.
480
- </p>
481
- </div></span>
482
-
483
- </li>
484
-
485
-
486
- <li class="public ">
487
- <span class="summary_signature">
488
-
489
- <a href="#styles-instance_method" title="#styles (instance method)">- (Styles) <strong>styles</strong> {|@styles| ... }</a>
490
-
491
-
492
-
493
- </span>
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
- <span class="summary_desc"><div class='inline'><p>
503
- The styles associated with this workbook.
504
- </p>
505
- </div></span>
506
-
507
- </li>
508
-
509
-
510
- <li class="public ">
511
- <span class="summary_signature">
512
-
513
- <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
514
-
515
-
516
-
517
- </span>
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
- <span class="summary_desc"><div class='inline'><p>
527
- Serializes the workbook document.
528
- </p>
529
- </div></span>
530
-
531
- </li>
532
-
533
-
534
- </ul>
535
-
536
-
537
- <div id="constructor_details" class="method_details_list">
538
- <h2>Constructor Details</h2>
539
-
540
- <div class="method_details first">
541
- <p class="signature first" id="initialize-instance_method">
542
-
543
- - (<tt><span class='object_link'><a href="" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... }
544
-
545
-
546
-
547
- </p><div class="docstring">
548
- <div class="discussion">
549
- <p>
550
- Creates a new Workbook
551
- </p>
552
-
553
-
554
- </div>
555
- </div>
556
- <div class="tags">
557
- <h3>Parameters:</h3>
558
- <ul class="param">
559
-
560
- <li>
561
-
562
- <span class='name'>options</span>
563
-
564
-
565
- <span class='type'>(<tt>Hash</tt>)</span>
566
-
567
-
568
- <em class="default">(defaults to: <tt>{}</tt>)</em>
569
-
570
-
571
- &mdash;
572
- <div class='inline'><p>
573
- a customizable set of options
574
- </p>
575
- </div>
576
-
577
- </li>
578
-
579
- </ul>
580
-
581
-
582
-
583
-
584
- <h3>Options Hash (<tt>options</tt>):</h3>
585
- <ul class="option">
586
-
587
- <li>
588
- <span class="name">date1904</span>
589
- <span class="type">(<tt>Boolean</tt>)</span>
590
- <span class="default">
591
-
592
- </span>
593
-
594
- </li>
595
-
596
- </ul>
597
-
598
-
599
- <h3>Yields:</h3>
600
- <ul class="yield">
601
-
602
- <li>
603
-
604
-
605
- <span class='type'>(<tt>_self</tt>)</span>
606
-
607
-
608
-
609
- </li>
610
-
611
- </ul>
612
- <h3>Yield Parameters:</h3>
613
- <ul class="yieldparam">
614
-
615
- <li>
616
-
617
- <span class='name'>_self</span>
618
-
619
-
620
- <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Workbook (class)">Axlsx::Workbook</a></span></tt>)</span>
621
-
622
-
623
-
624
- &mdash;
625
- <div class='inline'><p>
626
- the object that the method was called on
627
- </p>
628
- </div>
629
-
630
- </li>
631
-
632
- </ul>
633
-
634
- </div><table class="source_code">
635
- <tr>
636
- <td>
637
- <pre class="lines">
638
-
639
-
640
- 86
641
- 87
642
- 88
643
- 89
644
- 90
645
- 91
646
- 92
647
- 93
648
- 94</pre>
649
- </td>
650
- <td>
651
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 86</span>
652
-
653
- <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>
654
- <span class='@styles ivar id'>@styles</span> <span class='assign token'>=</span> <span class='Styles constant id'>Styles</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
655
- <span class='@worksheets ivar id'>@worksheets</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='Worksheet constant id'>Worksheet</span>
656
- <span class='@drawings ivar id'>@drawings</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='Drawing constant id'>Drawing</span>
657
- <span class='@charts ivar id'>@charts</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='Chart constant id'>Chart</span>
658
- <span class='@images ivar id'>@images</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='Pic constant id'>Pic</span>
659
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack token'>]</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'>:date1904</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
660
- <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>
661
- <span class='end end kw'>end</span>
662
- </pre>
663
- </td>
664
- </tr>
665
- </table>
666
- </div>
667
-
668
- </div>
669
-
670
- <div id="instance_attr_details" class="attr_details">
671
- <h2>Instance Attribute Details</h2>
672
-
673
-
674
- <span id=""></span>
675
- <span id="charts-instance_method"></span>
676
- <div class="method_details first">
677
- <p class="signature first" id="charts-instance_method">
678
-
679
- - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>charts</strong> <span class="extras">(readonly)</span>
680
-
681
-
682
-
683
- </p><div class="docstring">
684
- <div class="discussion">
685
-
686
- <div class="note notetag">
687
- <strong>Note:</strong>
688
- <div class='inline'><p>
689
- The recommended way to manage charts is Worksheet#add_chart
690
- </p>
691
- </div>
692
- </div>
693
-
694
- <p>
695
- A colllection of charts associated with this workbook
696
- </p>
697
-
698
-
699
- </div>
700
- </div>
701
- <div class="tags">
702
-
703
- <h3>Returns:</h3>
704
- <ul class="return">
705
-
706
- <li>
707
-
708
-
709
- <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
710
-
711
-
712
-
713
- </li>
714
-
715
- </ul>
716
-
717
- <h3>See Also:</h3>
718
- <ul class="see">
719
-
720
- <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Axlsx::Worksheet#add_chart</a></span></li>
721
-
722
- <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li>
723
-
724
- </ul>
725
-
726
- </div><table class="source_code">
727
- <tr>
728
- <td>
729
- <pre class="lines">
730
-
731
-
732
- 45
733
- 46
734
- 47</pre>
735
- </td>
736
- <td>
737
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 45</span>
738
-
739
- <span class='def def kw'>def</span> <span class='charts identifier id'>charts</span>
740
- <span class='@charts ivar id'>@charts</span>
741
- <span class='end end kw'>end</span>
742
- </pre>
743
- </td>
744
- </tr>
745
- </table>
746
- </div>
747
-
748
-
749
- <span id=""></span>
750
- <span id="drawings-instance_method"></span>
751
- <div class="method_details ">
752
- <p class="signature " id="drawings-instance_method">
753
-
754
- - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>drawings</strong> <span class="extras">(readonly)</span>
755
-
756
-
757
-
758
- </p><div class="docstring">
759
- <div class="discussion">
760
-
761
- <div class="note notetag">
762
- <strong>Note:</strong>
763
- <div class='inline'><p>
764
- The recommended way to manage drawings is Worksheet#add_chart
765
- </p>
766
- </div>
767
- </div>
768
-
769
- <p>
770
- A colllection of drawings associated with this workbook
771
- </p>
772
-
773
-
774
- </div>
775
- </div>
776
- <div class="tags">
777
-
778
- <h3>Returns:</h3>
779
- <ul class="return">
780
-
781
- <li>
782
-
783
-
784
- <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
785
-
786
-
787
-
788
- </li>
789
-
790
- </ul>
791
-
792
- <h3>See Also:</h3>
793
- <ul class="see">
794
-
795
- <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Axlsx::Worksheet#add_chart</a></span></li>
796
-
797
- <li><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></li>
798
-
799
- </ul>
800
-
801
- </div><table class="source_code">
802
- <tr>
803
- <td>
804
- <pre class="lines">
805
-
806
-
807
- 59
808
- 60
809
- 61</pre>
810
- </td>
811
- <td>
812
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 59</span>
813
-
814
- <span class='def def kw'>def</span> <span class='drawings identifier id'>drawings</span>
815
- <span class='@drawings ivar id'>@drawings</span>
816
- <span class='end end kw'>end</span>
817
- </pre>
818
- </td>
819
- </tr>
820
- </table>
821
- </div>
822
-
823
-
824
- <span id=""></span>
825
- <span id="images-instance_method"></span>
826
- <div class="method_details ">
827
- <p class="signature " id="images-instance_method">
828
-
829
- - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>images</strong> <span class="extras">(readonly)</span>
830
-
831
-
832
-
833
- </p><div class="docstring">
834
- <div class="discussion">
835
-
836
- <div class="note notetag">
837
- <strong>Note:</strong>
838
- <div class='inline'><p>
839
- The recommended way to manage images is Worksheet#add_image
840
- </p>
841
- </div>
842
- </div>
843
-
844
- <p>
845
- A colllection of images associated with this workbook
846
- </p>
847
-
848
-
849
- </div>
850
- </div>
851
- <div class="tags">
852
-
853
- <h3>Returns:</h3>
854
- <ul class="return">
855
-
856
- <li>
857
-
858
-
859
- <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
860
-
861
-
862
-
863
- </li>
864
-
865
- </ul>
866
-
867
- <h3>See Also:</h3>
868
- <ul class="see">
869
-
870
- <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Axlsx::Worksheet#add_image</a></span></li>
871
-
872
- <li><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></li>
873
-
874
- </ul>
875
-
876
- </div><table class="source_code">
877
- <tr>
878
- <td>
879
- <pre class="lines">
880
-
881
-
882
- 52
883
- 53
884
- 54</pre>
885
- </td>
886
- <td>
887
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 52</span>
888
-
889
- <span class='def def kw'>def</span> <span class='images identifier id'>images</span>
890
- <span class='@images ivar id'>@images</span>
891
- <span class='end end kw'>end</span>
892
- </pre>
893
- </td>
894
- </tr>
895
- </table>
896
- </div>
897
-
898
-
899
- <span id=""></span>
900
- <span id="worksheets-instance_method"></span>
901
- <div class="method_details ">
902
- <p class="signature " id="worksheets-instance_method">
903
-
904
- - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>worksheets</strong> <span class="extras">(readonly)</span>
905
-
906
-
907
-
908
- </p><div class="docstring">
909
- <div class="discussion">
910
-
911
- <div class="note notetag">
912
- <strong>Note:</strong>
913
- <div class='inline'><p>
914
- The recommended way to manage worksheets is add_worksheet
915
- </p>
916
- </div>
917
- </div>
918
-
919
- <p>
920
- A collection of worksheets associated with this workbook.
921
- </p>
922
-
923
-
924
- </div>
925
- </div>
926
- <div class="tags">
927
-
928
- <h3>Returns:</h3>
929
- <ul class="return">
930
-
931
- <li>
932
-
933
-
934
- <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
935
-
936
-
937
-
938
- </li>
939
-
940
- </ul>
941
-
942
- <h3>See Also:</h3>
943
- <ul class="see">
944
-
945
- <li><span class='object_link'><a href="#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">#add_worksheet</a></span></li>
946
-
947
- <li><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Axlsx::Worksheet</a></span></li>
948
-
949
- </ul>
950
-
951
- </div><table class="source_code">
952
- <tr>
953
- <td>
954
- <pre class="lines">
955
-
956
-
957
- 38
958
- 39
959
- 40</pre>
960
- </td>
961
- <td>
962
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 38</span>
963
-
964
- <span class='def def kw'>def</span> <span class='worksheets identifier id'>worksheets</span>
965
- <span class='@worksheets ivar id'>@worksheets</span>
966
- <span class='end end kw'>end</span>
967
- </pre>
968
- </td>
969
- </tr>
970
- </table>
971
- </div>
972
-
973
- </div>
974
-
975
-
976
- <div id="class_method_details" class="method_details_list">
977
- <h2>Class Method Details</h2>
978
-
979
-
980
- <div class="method_details first">
981
- <p class="signature first" id="date1904-class_method">
982
-
983
- + (<tt>Boolean</tt>) <strong>date1904</strong>
984
-
985
-
986
-
987
- </p><div class="docstring">
988
- <div class="discussion">
989
- <p>
990
- retrieves the date1904 attribute
991
- </p>
992
-
993
-
994
- </div>
995
- </div>
996
- <div class="tags">
997
-
998
- <h3>Returns:</h3>
999
- <ul class="return">
1000
-
1001
- <li>
1002
-
1003
-
1004
- <span class='type'>(<tt>Boolean</tt>)</span>
1005
-
1006
-
1007
-
1008
- </li>
1009
-
1010
- </ul>
1011
-
1012
- </div><table class="source_code">
1013
- <tr>
1014
- <td>
1015
- <pre class="lines">
1016
-
1017
-
1018
- 109</pre>
1019
- </td>
1020
- <td>
1021
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 109</span>
1022
-
1023
- <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span>
1024
- </pre>
1025
- </td>
1026
- </tr>
1027
- </table>
1028
- </div>
1029
-
1030
- <div class="method_details ">
1031
- <p class="signature " id="date1904=-class_method">
1032
-
1033
- + (<tt>Boolean</tt>) <strong>date1904=</strong>(v)
1034
-
1035
-
1036
-
1037
- </p><div class="docstring">
1038
- <div class="discussion">
1039
- <p>
1040
- Sets the date1904 attribute to the provided boolean
1041
- </p>
1042
-
1043
-
1044
- </div>
1045
- </div>
1046
- <div class="tags">
1047
-
1048
- <h3>Returns:</h3>
1049
- <ul class="return">
1050
-
1051
- <li>
1052
-
1053
-
1054
- <span class='type'>(<tt>Boolean</tt>)</span>
1055
-
1056
-
1057
-
1058
- </li>
1059
-
1060
- </ul>
1061
-
1062
- </div><table class="source_code">
1063
- <tr>
1064
- <td>
1065
- <pre class="lines">
1066
-
1067
-
1068
- 105</pre>
1069
- </td>
1070
- <td>
1071
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 105</span>
1072
-
1073
- <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_boolean identifier id'>validate_boolean</span> <span class='v identifier id'>v</span><span class='semicolon token'>;</span> <span class='@@date1904 ivar id'>@@date1904</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span>
1074
- </pre>
1075
- </td>
1076
- </tr>
1077
- </table>
1078
- </div>
1079
-
1080
- </div>
1081
-
1082
- <div id="instance_method_details" class="method_details_list">
1083
- <h2>Instance Method Details</h2>
1084
-
1085
-
1086
- <div class="method_details first">
1087
- <p class="signature first" id="[]-instance_method">
1088
-
1089
- - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>Array</tt>) <strong>[]</strong>(cell_def)
1090
-
1091
-
1092
-
1093
- </p><div class="docstring">
1094
- <div class="discussion">
1095
- <p>
1096
- returns a range of cells in a worksheet retrieve the cells from. e.g.
1097
- range(&#8216;Sheet1!A1:B2&#8217;) will return an array of four cells [A1,
1098
- A2, B1, B2] while range(&#8216;Sheet1!A1&#8217;) will return a single Cell.
1099
- </p>
1100
-
1101
-
1102
- </div>
1103
- </div>
1104
- <div class="tags">
1105
- <h3>Parameters:</h3>
1106
- <ul class="param">
1107
-
1108
- <li>
1109
-
1110
- <span class='name'>cell_def</span>
1111
-
1112
-
1113
- <span class='type'>(<tt>String</tt>)</span>
1114
-
1115
-
1116
-
1117
- &mdash;
1118
- <div class='inline'><p>
1119
- The excel style reference defining the worksheet and cells. The range must
1120
- specify the sheet to
1121
- </p>
1122
- </div>
1123
-
1124
- </li>
1125
-
1126
- </ul>
1127
-
1128
- <h3>Returns:</h3>
1129
- <ul class="return">
1130
-
1131
- <li>
1132
-
1133
-
1134
- <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>Array</tt>)</span>
1135
-
1136
-
1137
-
1138
- </li>
1139
-
1140
- </ul>
1141
- <h3>Raises:</h3>
1142
- <ul class="raise">
1143
-
1144
- <li>
1145
-
1146
-
1147
- <span class='type'>(<tt>ArgumentError</tt>)</span>
1148
-
1149
-
1150
-
1151
- </li>
1152
-
1153
- </ul>
1154
-
1155
- </div><table class="source_code">
1156
- <tr>
1157
- <td>
1158
- <pre class="lines">
1159
-
1160
-
1161
- 136
1162
- 137
1163
- 138
1164
- 139
1165
- 140
1166
- 141</pre>
1167
- </td>
1168
- <td>
1169
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 136</span>
1170
-
1171
- <span class='def def kw'>def</span> <span class='aref op'>[]</span><span class='lparen token'>(</span><span class='cell_def identifier id'>cell_def</span><span class='rparen token'>)</span>
1172
- <span class='sheet_name identifier id'>sheet_name</span> <span class='assign token'>=</span> <span class='cell_def identifier id'>cell_def</span><span class='dot token'>.</span><span class='split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>'!'</span><span class='rparen token'>)</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> <span class='if if_mod kw'>if</span> <span class='cell_def identifier id'>cell_def</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='string val'>'!'</span><span class='rparen token'>)</span>
1173
- <span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='s identifier id'>s</span><span class='bitor op'>|</span> <span class='s identifier id'>s</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='eq op'>==</span> <span class='sheet_name identifier id'>sheet_name</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
1174
- <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>'Unknown Sheet'</span> <span class='unless unless_mod kw'>unless</span> <span class='sheet_name identifier id'>sheet_name</span> <span class='andop op'>&amp;&amp;</span> <span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Worksheet constant id'>Worksheet</span><span class='rparen token'>)</span>
1175
- <span class='worksheet identifier id'>worksheet</span><span class='lbrack token'>[</span><span class='cell_def identifier id'>cell_def</span><span class='dot token'>.</span><span class='gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='regexp val'>/.+!/</span><span class='comma token'>,</span><span class='string val'>&quot;&quot;</span><span class='rparen token'>)</span><span class='rbrack token'>]</span>
1176
- <span class='end end kw'>end</span>
1177
- </pre>
1178
- </td>
1179
- </tr>
1180
- </table>
1181
- </div>
1182
-
1183
- <div class="method_details ">
1184
- <p class="signature " id="add_worksheet-instance_method">
1185
-
1186
- - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... }
1187
-
1188
-
1189
-
1190
- </p><div class="docstring">
1191
- <div class="discussion">
1192
- <p>
1193
- Adds a worksheet to this workbook
1194
- </p>
1195
-
1196
-
1197
- </div>
1198
- </div>
1199
- <div class="tags">
1200
- <h3>Parameters:</h3>
1201
- <ul class="param">
1202
-
1203
- <li>
1204
-
1205
- <span class='name'>options</span>
1206
-
1207
-
1208
- <span class='type'>(<tt>Hash</tt>)</span>
1209
-
1210
-
1211
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1212
-
1213
-
1214
- &mdash;
1215
- <div class='inline'><p>
1216
- a customizable set of options
1217
- </p>
1218
- </div>
1219
-
1220
- </li>
1221
-
1222
- </ul>
1223
-
1224
-
1225
-
1226
-
1227
- <h3>Options Hash (<tt>options</tt>):</h3>
1228
- <ul class="option">
1229
-
1230
- <li>
1231
- <span class="name">name</span>
1232
- <span class="type">(<tt>String</tt>)</span>
1233
- <span class="default">
1234
-
1235
- </span>
1236
- &mdash; <div class='inline'><p>
1237
- The name of the worksheet.
1238
- </p>
1239
- </div>
1240
- </li>
1241
-
1242
- </ul>
1243
-
1244
-
1245
- <h3>Yields:</h3>
1246
- <ul class="yield">
1247
-
1248
- <li>
1249
-
1250
-
1251
- <span class='type'>(<tt>worksheet</tt>)</span>
1252
-
1253
-
1254
-
1255
- </li>
1256
-
1257
- </ul>
1258
- <h3>Returns:</h3>
1259
- <ul class="return">
1260
-
1261
- <li>
1262
-
1263
-
1264
- <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
1265
-
1266
-
1267
-
1268
- </li>
1269
-
1270
- </ul>
1271
-
1272
- <h3>See Also:</h3>
1273
- <ul class="see">
1274
-
1275
- <li><span class='object_link'><a href="Worksheet.html#initialize-instance_method" title="Axlsx::Worksheet#initialize (method)">Axlsx::Worksheet#initialize</a></span></li>
1276
-
1277
- </ul>
1278
-
1279
- </div><table class="source_code">
1280
- <tr>
1281
- <td>
1282
- <pre class="lines">
1283
-
1284
-
1285
- 115
1286
- 116
1287
- 117
1288
- 118
1289
- 119</pre>
1290
- </td>
1291
- <td>
1292
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 115</span>
1293
-
1294
- <span class='def def kw'>def</span> <span class='add_worksheet identifier id'>add_worksheet</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>
1295
- <span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='Worksheet constant id'>Worksheet</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>
1296
- <span class='yield yield kw'>yield</span> <span class='worksheet identifier id'>worksheet</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
1297
- <span class='worksheet identifier id'>worksheet</span>
1298
- <span class='end end kw'>end</span>
1299
- </pre>
1300
- </td>
1301
- </tr>
1302
- </table>
1303
- </div>
1304
-
1305
- <div class="method_details ">
1306
- <p class="signature " id="date1904-instance_method">
1307
-
1308
- - (<tt>Boolean</tt>) <strong>date1904</strong>
1309
-
1310
-
1311
-
1312
- </p><div class="docstring">
1313
- <div class="discussion">
1314
- <p>
1315
- Instance level access to the class variable 1904
1316
- </p>
1317
-
1318
-
1319
- </div>
1320
- </div>
1321
- <div class="tags">
1322
-
1323
- <h3>Returns:</h3>
1324
- <ul class="return">
1325
-
1326
- <li>
1327
-
1328
-
1329
- <span class='type'>(<tt>Boolean</tt>)</span>
1330
-
1331
-
1332
-
1333
- </li>
1334
-
1335
- </ul>
1336
-
1337
- </div><table class="source_code">
1338
- <tr>
1339
- <td>
1340
- <pre class="lines">
1341
-
1342
-
1343
- 98</pre>
1344
- </td>
1345
- <td>
1346
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 98</span>
1347
-
1348
- <span class='def def kw'>def</span> <span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span>
1349
- </pre>
1350
- </td>
1351
- </tr>
1352
- </table>
1353
- </div>
1354
-
1355
- <div class="method_details ">
1356
- <p class="signature " id="date1904=-instance_method">
1357
-
1358
- - (<tt>Object</tt>) <strong>date1904=</strong>(v)
1359
-
1360
-
1361
-
1362
- </p><div class="docstring">
1363
- <div class="discussion">
1364
- <p>
1365
- see @date1904
1366
- </p>
1367
-
1368
-
1369
- </div>
1370
- </div>
1371
- <div class="tags">
1372
-
1373
-
1374
- </div><table class="source_code">
1375
- <tr>
1376
- <td>
1377
- <pre class="lines">
1378
-
1379
-
1380
- 101</pre>
1381
- </td>
1382
- <td>
1383
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 101</span>
1384
-
1385
- <span class='def def kw'>def</span> <span class='date1904= identifier id'>date1904=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_boolean identifier id'>validate_boolean</span> <span class='v identifier id'>v</span><span class='semicolon token'>;</span> <span class='@@date1904 ivar id'>@@date1904</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span>
1386
- </pre>
1387
- </td>
1388
- </tr>
1389
- </table>
1390
- </div>
1391
-
1392
- <div class="method_details ">
1393
- <p class="signature " id="relationships-instance_method">
1394
-
1395
- - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong>
1396
-
1397
-
1398
-
1399
- </p><div class="docstring">
1400
- <div class="discussion">
1401
- <p>
1402
- The workbook relationships. This is managed automatically by the workbook
1403
- </p>
1404
-
1405
-
1406
- </div>
1407
- </div>
1408
- <div class="tags">
1409
-
1410
- <h3>Returns:</h3>
1411
- <ul class="return">
1412
-
1413
- <li>
1414
-
1415
-
1416
- <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span>
1417
-
1418
-
1419
-
1420
- </li>
1421
-
1422
- </ul>
1423
-
1424
- </div><table class="source_code">
1425
- <tr>
1426
- <td>
1427
- <pre class="lines">
1428
-
1429
-
1430
- 123
1431
- 124
1432
- 125
1433
- 126
1434
- 127
1435
- 128
1436
- 129
1437
- 130</pre>
1438
- </td>
1439
- <td>
1440
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 123</span>
1441
-
1442
- <span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span>
1443
- <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
1444
- <span class='@worksheets ivar id'>@worksheets</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='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
1445
- <span class='r identifier id'>r</span> <span class='lshft op'>&lt;&lt;</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='WORKSHEET_R constant id'>WORKSHEET_R</span><span class='comma token'>,</span> <span class='WORKSHEET_PN constant id'>WORKSHEET_PN</span> <span class='mod op'>%</span> <span class='lparen token'>(</span><span class='r identifier id'>r</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
1446
- <span class='end end kw'>end</span>
1447
- <span class='r identifier id'>r</span> <span class='lshft op'>&lt;&lt;</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='STYLES_R constant id'>STYLES_R</span><span class='comma token'>,</span> <span class='STYLES_PN constant id'>STYLES_PN</span><span class='rparen token'>)</span>
1448
- <span class='r identifier id'>r</span>
1449
- <span class='end end kw'>end</span>
1450
- </pre>
1451
- </td>
1452
- </tr>
1453
- </table>
1454
- </div>
1455
-
1456
- <div class="method_details ">
1457
- <p class="signature " id="styles-instance_method">
1458
-
1459
- - (<tt><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>) <strong>styles</strong> {|@styles| ... }
1460
-
1461
-
1462
-
1463
- </p><div class="docstring">
1464
- <div class="discussion">
1465
-
1466
- <div class="note notetag">
1467
- <strong>Note:</strong>
1468
- <div class='inline'><p>
1469
- The recommended way to manage styles is Styles#add_style
1470
- </p>
1471
- </div>
1472
- </div>
1473
-
1474
- <p>
1475
- The styles associated with this workbook
1476
- </p>
1477
-
1478
-
1479
- </div>
1480
- </div>
1481
- <div class="tags">
1482
-
1483
- <h3>Yields:</h3>
1484
- <ul class="yield">
1485
-
1486
- <li>
1487
-
1488
-
1489
- <span class='type'>(<tt>@styles</tt>)</span>
1490
-
1491
-
1492
-
1493
- </li>
1494
-
1495
- </ul>
1496
- <h3>Returns:</h3>
1497
- <ul class="return">
1498
-
1499
- <li>
1500
-
1501
-
1502
- <span class='type'>(<tt><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>)</span>
1503
-
1504
-
1505
-
1506
- </li>
1507
-
1508
- </ul>
1509
-
1510
- <h3>See Also:</h3>
1511
- <ul class="see">
1512
-
1513
- <li>Style#add_style</li>
1514
-
1515
- <li>Style</li>
1516
-
1517
- </ul>
1518
-
1519
- </div><table class="source_code">
1520
- <tr>
1521
- <td>
1522
- <pre class="lines">
1523
-
1524
-
1525
- 66
1526
- 67
1527
- 68
1528
- 69</pre>
1529
- </td>
1530
- <td>
1531
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 66</span>
1532
-
1533
- <span class='def def kw'>def</span> <span class='styles identifier id'>styles</span>
1534
- <span class='yield yield kw'>yield</span> <span class='@styles ivar id'>@styles</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
1535
- <span class='@styles ivar id'>@styles</span>
1536
- <span class='end end kw'>end</span>
1537
- </pre>
1538
- </td>
1539
- </tr>
1540
- </table>
1541
- </div>
1542
-
1543
- <div class="method_details ">
1544
- <p class="signature " id="to_xml-instance_method">
1545
-
1546
- - (<tt>String</tt>) <strong>to_xml</strong>
1547
-
1548
-
1549
-
1550
- </p><div class="docstring">
1551
- <div class="discussion">
1552
- <p>
1553
- Serializes the workbook document
1554
- </p>
1555
-
1556
-
1557
- </div>
1558
- </div>
1559
- <div class="tags">
1560
-
1561
- <h3>Returns:</h3>
1562
- <ul class="return">
1563
-
1564
- <li>
1565
-
1566
-
1567
- <span class='type'>(<tt>String</tt>)</span>
1568
-
1569
-
1570
-
1571
- </li>
1572
-
1573
- </ul>
1574
-
1575
- </div><table class="source_code">
1576
- <tr>
1577
- <td>
1578
- <pre class="lines">
1579
-
1580
-
1581
- 145
1582
- 146
1583
- 147
1584
- 148
1585
- 149
1586
- 150
1587
- 151
1588
- 152
1589
- 153
1590
- 154
1591
- 155
1592
- 156
1593
- 157
1594
- 158</pre>
1595
- </td>
1596
- <td>
1597
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 145</span>
1598
-
1599
- <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
1600
- <span class='add_worksheet identifier id'>add_worksheet</span> <span class='unless unless_mod kw'>unless</span> <span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span>
1601
- <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'>&gt;</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>
1602
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
1603
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbookPr identifier id'>workbookPr</span><span class='lparen token'>(</span><span class='symbol val'>:date1904=</span><span class='gt op'>&gt;</span><span class='@@date1904 ivar id'>@@date1904</span><span class='rparen token'>)</span>
1604
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheets identifier id'>sheets</span> <span class='lbrace token'>{</span>
1605
- <span class='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span>
1606
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheet identifier id'>sheet</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>&gt;</span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:sheetId=</span><span class='gt op'>&gt;</span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:&quot;r:id&quot;</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span>
1607
- <span class='end end kw'>end</span>
1608
- <span class='rbrace token'>}</span>
1609
- <span class='rbrace token'>}</span>
1610
- <span class='end end kw'>end</span>
1611
- <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='symbol val'>:indent=</span><span class='gt op'>&gt;</span><span class='integer val'>0</span><span class='rparen token'>)</span>
1612
- <span class='end end kw'>end</span>
1613
- </pre>
1614
- </td>
1615
- </tr>
1616
- </table>
1617
- </div>
1618
-
1619
- </div>
1620
-
1621
- </div>
1622
-
1623
- <div id="footer">
1624
- Generated on Mon Dec 5 14:21:11 2011 by
1625
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1626
- 0.7.3 (ruby-1.8.7).
1627
- </div>
1628
-
1629
- </body>
1630
- </html>