axlsx 1.0.9 → 1.0.10a

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. data/Gemfile +3 -0
  2. data/Gemfile.lock +24 -0
  3. data/README.md +86 -1
  4. data/axlsx.gemspec +6 -10
  5. data/doc/Axlsx.html +557 -360
  6. data/doc/Axlsx/App.html +347 -244
  7. data/doc/Axlsx/Ar.html +200 -0
  8. data/doc/Axlsx/Ar/ClassMethods.html +192 -0
  9. data/doc/Axlsx/Ar/InstanceMethods.html +109 -0
  10. data/doc/Axlsx/Ar/SingletonMethods.html +304 -0
  11. data/doc/Axlsx/Axis.html +131 -98
  12. data/doc/Axlsx/Bar3DChart.html +138 -106
  13. data/doc/Axlsx/BarSeries.html +73 -54
  14. data/doc/Axlsx/Border.html +114 -87
  15. data/doc/Axlsx/BorderPr.html +107 -82
  16. data/doc/Axlsx/CatAxis.html +93 -68
  17. data/doc/Axlsx/CatAxisData.html +47 -38
  18. data/doc/Axlsx/Cell.html +642 -148
  19. data/doc/Axlsx/CellAlignment.html +152 -111
  20. data/doc/Axlsx/CellProtection.html +63 -45
  21. data/doc/Axlsx/CellStyle.html +101 -73
  22. data/doc/Axlsx/Chart.html +238 -179
  23. data/doc/Axlsx/Color.html +75 -53
  24. data/doc/Axlsx/ContentType.html +34 -26
  25. data/doc/Axlsx/Core.html +54 -42
  26. data/doc/Axlsx/DataTypeValidator.html +39 -30
  27. data/doc/Axlsx/Default.html +59 -43
  28. data/doc/Axlsx/Drawing.html +176 -128
  29. data/doc/Axlsx/Fill.html +46 -33
  30. data/doc/Axlsx/Font.html +197 -147
  31. data/doc/Axlsx/GradientFill.html +114 -82
  32. data/doc/Axlsx/GradientStop.html +47 -33
  33. data/doc/Axlsx/GraphicFrame.html +78 -60
  34. data/doc/Axlsx/Line3DChart.html +125 -97
  35. data/doc/Axlsx/LineSeries.html +60 -44
  36. data/doc/Axlsx/Marker.html +98 -71
  37. data/doc/Axlsx/NumFmt.html +99 -80
  38. data/doc/Axlsx/OneCellAnchor.html +126 -94
  39. data/doc/Axlsx/Override.html +59 -43
  40. data/doc/Axlsx/Package.html +269 -134
  41. data/doc/Axlsx/PatternFill.html +93 -72
  42. data/doc/Axlsx/Pic.html +202 -152
  43. data/doc/Axlsx/Pie3DChart.html +39 -30
  44. data/doc/Axlsx/PieSeries.html +72 -53
  45. data/doc/Axlsx/RegexValidator.html +19 -14
  46. data/doc/Axlsx/Relationship.html +60 -43
  47. data/doc/Axlsx/Relationships.html +34 -26
  48. data/doc/Axlsx/RestrictionValidator.html +31 -22
  49. data/doc/Axlsx/Row.html +241 -67
  50. data/doc/Axlsx/Scaling.html +80 -59
  51. data/doc/Axlsx/SerAxis.html +71 -51
  52. data/doc/Axlsx/Series.html +179 -51
  53. data/doc/Axlsx/SeriesTitle.html +29 -24
  54. data/doc/Axlsx/Styles.html +354 -285
  55. data/doc/Axlsx/TableStyle.html +74 -54
  56. data/doc/Axlsx/TableStyleElement.html +99 -79
  57. data/doc/Axlsx/TableStyles.html +65 -47
  58. data/doc/Axlsx/Title.html +66 -51
  59. data/doc/Axlsx/TwoCellAnchor.html +129 -96
  60. data/doc/Axlsx/ValAxis.html +52 -38
  61. data/doc/Axlsx/ValAxisData.html +32 -27
  62. data/doc/Axlsx/View3D.html +111 -80
  63. data/doc/Axlsx/Workbook.html +333 -272
  64. data/doc/Axlsx/Worksheet.html +1018 -266
  65. data/doc/Axlsx/Xf.html +188 -134
  66. data/doc/_index.html +44 -8
  67. data/doc/class_list.html +1 -1
  68. data/doc/file.LICENSE.html +28 -23
  69. data/doc/file.README.html +180 -91
  70. data/doc/index.html +180 -91
  71. data/doc/method_list.html +541 -421
  72. data/doc/top-level-namespace.html +2 -2
  73. data/examples/example.rb +70 -13
  74. data/lib/axlsx.rb +1 -0
  75. data/lib/axlsx/ar.rb +72 -0
  76. data/lib/axlsx/package.rb +8 -1
  77. data/lib/axlsx/util/simple_typed_list.rb +5 -0
  78. data/lib/axlsx/version.rb +1 -1
  79. data/lib/axlsx/workbook/workbook.rb +4 -2
  80. data/lib/axlsx/workbook/worksheet/row.rb +15 -0
  81. data/lib/axlsx/workbook/worksheet/worksheet.rb +44 -1
  82. data/test/workbook/worksheet/tc_row.rb +6 -0
  83. data/test/workbook/worksheet/tc_worksheet.rb +36 -0
  84. metadata +103 -59
@@ -94,9 +94,10 @@
94
94
 
95
95
  <h2>Overview</h2><div class="docstring">
96
96
  <div class="discussion">
97
-
98
- <p>An override content part. These parts are automatically created by for you
99
- based on the content of your package.</p>
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>
100
101
 
101
102
 
102
103
  </div>
@@ -128,8 +129,9 @@ based on the content of your package.</p>
128
129
 
129
130
 
130
131
 
131
- <span class="summary_desc"><div class='inline'>
132
- <p>The type of content.</p>
132
+ <span class="summary_desc"><div class='inline'><p>
133
+ The type of content.
134
+ </p>
133
135
  </div></span>
134
136
 
135
137
  </li>
@@ -154,8 +156,9 @@ based on the content of your package.</p>
154
156
 
155
157
 
156
158
 
157
- <span class="summary_desc"><div class='inline'>
158
- <p>The name and location of the part.</p>
159
+ <span class="summary_desc"><div class='inline'><p>
160
+ The name and location of the part.
161
+ </p>
159
162
  </div></span>
160
163
 
161
164
  </li>
@@ -192,8 +195,9 @@ based on the content of your package.</p>
192
195
 
193
196
 
194
197
 
195
- <span class="summary_desc"><div class='inline'>
196
- <p>Creates a new Override object.</p>
198
+ <span class="summary_desc"><div class='inline'><p>
199
+ Creates a new Override object.
200
+ </p>
197
201
  </div></span>
198
202
 
199
203
  </li>
@@ -215,8 +219,9 @@ based on the content of your package.</p>
215
219
 
216
220
 
217
221
 
218
- <span class="summary_desc"><div class='inline'>
219
- <p>Serializes the Override object to xml.</p>
222
+ <span class="summary_desc"><div class='inline'><p>
223
+ Serializes the Override object to xml.
224
+ </p>
220
225
  </div></span>
221
226
 
222
227
  </li>
@@ -237,8 +242,9 @@ based on the content of your package.</p>
237
242
 
238
243
  </p><div class="docstring">
239
244
  <div class="discussion">
240
-
241
- <p>Creates a new Override object</p>
245
+ <p>
246
+ Creates a new Override object
247
+ </p>
242
248
 
243
249
 
244
250
  </div>
@@ -259,8 +265,9 @@ based on the content of your package.</p>
259
265
 
260
266
 
261
267
  &mdash;
262
- <div class='inline'>
263
- <p>a customizable set of options</p>
268
+ <div class='inline'><p>
269
+ a customizable set of options
270
+ </p>
264
271
  </div>
265
272
 
266
273
  </li>
@@ -305,9 +312,10 @@ based on the content of your package.</p>
305
312
 
306
313
 
307
314
  &mdash;
308
- <div class='inline'>
309
- <p>An argument error is raised if both PartName and ContentType are not
310
- specified.</p>
315
+ <div class='inline'><p>
316
+ An argument error is raised if both PartName and ContentType are not
317
+ specified.
318
+ </p>
311
319
  </div>
312
320
 
313
321
  </li>
@@ -330,12 +338,13 @@ specified.</p>
330
338
  <td>
331
339
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 17</span>
332
340
 
333
- <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
334
- <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PartName and ContentType are required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:PartName</span><span class='rbracket'>]</span> <span class='op'>&amp;&amp;</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ContentType</span><span class='rbracket'>]</span>
335
- <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span>
336
- <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span>
337
- <span class='kw'>end</span>
338
- <span class='kw'>end</span></pre>
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>
339
348
  </td>
340
349
  </tr>
341
350
  </table>
@@ -358,8 +367,9 @@ specified.</p>
358
367
 
359
368
  </p><div class="docstring">
360
369
  <div class="discussion">
361
-
362
- <p>The type of content.</p>
370
+ <p>
371
+ The type of content.
372
+ </p>
363
373
 
364
374
 
365
375
  </div>
@@ -393,9 +403,10 @@ specified.</p>
393
403
  <td>
394
404
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 7</span>
395
405
 
396
- <span class='kw'>def</span> <span class='const'>ContentType</span>
397
- <span class='ivar'>@ContentType</span>
398
- <span class='kw'>end</span></pre>
406
+ <span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span>
407
+ <span class='@ContentType ivar id'>@ContentType</span>
408
+ <span class='end end kw'>end</span>
409
+ </pre>
399
410
  </td>
400
411
  </tr>
401
412
  </table>
@@ -413,8 +424,9 @@ specified.</p>
413
424
 
414
425
  </p><div class="docstring">
415
426
  <div class="discussion">
416
-
417
- <p>The name and location of the part.</p>
427
+ <p>
428
+ The name and location of the part.
429
+ </p>
418
430
 
419
431
 
420
432
  </div>
@@ -448,9 +460,10 @@ specified.</p>
448
460
  <td>
449
461
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 11</span>
450
462
 
451
- <span class='kw'>def</span> <span class='const'>PartName</span>
452
- <span class='ivar'>@PartName</span>
453
- <span class='kw'>end</span></pre>
463
+ <span class='def def kw'>def</span> <span class='PartName constant id'>PartName</span>
464
+ <span class='@PartName ivar id'>@PartName</span>
465
+ <span class='end end kw'>end</span>
466
+ </pre>
454
467
  </td>
455
468
  </tr>
456
469
  </table>
@@ -472,8 +485,9 @@ specified.</p>
472
485
 
473
486
  </p><div class="docstring">
474
487
  <div class="discussion">
475
-
476
- <p>Serializes the Override object to xml</p>
488
+ <p>
489
+ Serializes the Override object to xml
490
+ </p>
477
491
 
478
492
 
479
493
  </div>
@@ -492,8 +506,9 @@ specified.</p>
492
506
 
493
507
 
494
508
  &mdash;
495
- <div class='inline'>
496
- <p>The document builder instance this objects xml will be added to.</p>
509
+ <div class='inline'><p>
510
+ The document builder instance this objects xml will be added to.
511
+ </p>
497
512
  </div>
498
513
 
499
514
  </li>
@@ -514,9 +529,10 @@ specified.</p>
514
529
  <td>
515
530
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 33</span>
516
531
 
517
- <span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span>
518
- <span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Override</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span>
519
- <span class='kw'>end</span></pre>
532
+ <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>
533
+ <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>
534
+ <span class='end end kw'>end</span>
535
+ </pre>
520
536
  </td>
521
537
  </tr>
522
538
  </table>
@@ -527,9 +543,9 @@ specified.</p>
527
543
  </div>
528
544
 
529
545
  <div id="footer">
530
- Generated on Sat Nov 26 13:16:39 2011 by
546
+ Generated on Sun Nov 27 21:54:24 2011 by
531
547
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
532
- 0.7.3 (ruby-1.9.3).
548
+ 0.7.3 (ruby-1.8.7).
533
549
  </div>
534
550
 
535
551
  </body>
@@ -94,10 +94,11 @@
94
94
 
95
95
  <h2>Overview</h2><div class="docstring">
96
96
  <div class="discussion">
97
-
98
- <p>Package is responsible for managing all the bits and peices that Open
97
+ <p>
98
+ Package is responsible for managing all the bits and peices that Open
99
99
  Office XML requires to make a valid xlsx document including valdation and
100
- serialization.</p>
100
+ serialization.
101
+ </p>
101
102
 
102
103
 
103
104
  </div>
@@ -136,8 +137,33 @@ serialization.</p>
136
137
 
137
138
 
138
139
 
139
- <span class="summary_desc"><div class='inline'>
140
- <p>Initializes your package.</p>
140
+ <span class="summary_desc"><div class='inline'><p>
141
+ Initializes your package.
142
+ </p>
143
+ </div></span>
144
+
145
+ </li>
146
+
147
+
148
+ <li class="public ">
149
+ <span class="summary_signature">
150
+
151
+ <a href="#ruport_table-instance_method" title="#ruport_table (instance method)">- (Object) <strong>ruport_table</strong>(table) </a>
152
+
153
+
154
+
155
+ </span>
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ <span class="summary_desc"><div class='inline'><p>
165
+ Accepts a ruport table for serialization to xlsx.
166
+ </p>
141
167
  </div></span>
142
168
 
143
169
  </li>
@@ -159,8 +185,9 @@ serialization.</p>
159
185
 
160
186
 
161
187
 
162
- <span class="summary_desc"><div class='inline'>
163
- <p>Serialize your workbook to disk as an xlsx document.</p>
188
+ <span class="summary_desc"><div class='inline'><p>
189
+ Serialize your workbook to disk as an xlsx document.
190
+ </p>
164
191
  </div></span>
165
192
 
166
193
  </li>
@@ -182,8 +209,9 @@ serialization.</p>
182
209
 
183
210
 
184
211
 
185
- <span class="summary_desc"><div class='inline'>
186
- <p>Validate all parts of the package against xsd schema.</p>
212
+ <span class="summary_desc"><div class='inline'><p>
213
+ Validate all parts of the package against xsd schema.
214
+ </p>
187
215
  </div></span>
188
216
 
189
217
  </li>
@@ -192,7 +220,7 @@ serialization.</p>
192
220
  <li class="public ">
193
221
  <span class="summary_signature">
194
222
 
195
- <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a>
223
+ <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> {|@workbook| ... }</a>
196
224
 
197
225
 
198
226
 
@@ -205,8 +233,9 @@ serialization.</p>
205
233
 
206
234
 
207
235
 
208
- <span class="summary_desc"><div class='inline'>
209
- <p>The workbook this package will serialize or validate.</p>
236
+ <span class="summary_desc"><div class='inline'><p>
237
+ The workbook this package will serialize or validate.
238
+ </p>
210
239
  </div></span>
211
240
 
212
241
  </li>
@@ -248,8 +277,9 @@ serialization.</p>
248
277
 
249
278
  </p><div class="docstring">
250
279
  <div class="discussion">
251
-
252
- <p>Initializes your package</p>
280
+ <p>
281
+ Initializes your package
282
+ </p>
253
283
 
254
284
 
255
285
  </div>
@@ -259,10 +289,12 @@ serialization.</p>
259
289
  <div class="examples">
260
290
  <h3>Examples:</h3>
261
291
 
262
- <h4><div class='inline'>
263
- <p>Package.new :author =&gt; you!’, :workbook =&gt; Workbook.new</p>
292
+ <h4><div class='inline'><p>
293
+ Package.new :author =&gt; &#8216;you!&#8217;, :workbook =&gt; Workbook.new
294
+ </p>
264
295
  </div></h4>
265
- <pre class="example code"></pre>
296
+ <pre class="example code">
297
+ </pre>
266
298
 
267
299
  </div>
268
300
  <h3>Parameters:</h3>
@@ -280,9 +312,10 @@ serialization.</p>
280
312
 
281
313
 
282
314
  &mdash;
283
- <div class='inline'>
284
- <p>A hash that you can use to specify the author and workbook for this
285
- package.</p>
315
+ <div class='inline'><p>
316
+ A hash that you can use to specify the author and workbook for this
317
+ package.
318
+ </p>
286
319
  </div>
287
320
 
288
321
  </li>
@@ -301,8 +334,9 @@ package.</p>
301
334
  <span class="default">
302
335
 
303
336
  </span>
304
- &mdash; <div class='inline'>
305
- <p>The author of the document</p>
337
+ &mdash; <div class='inline'><p>
338
+ The author of the document
339
+ </p>
306
340
  </div>
307
341
  </li>
308
342
 
@@ -335,8 +369,9 @@ package.</p>
335
369
 
336
370
 
337
371
  &mdash;
338
- <div class='inline'>
339
- <p>the object that the method was called on</p>
372
+ <div class='inline'><p>
373
+ the object that the method was called on
374
+ </p>
340
375
  </div>
341
376
 
342
377
  </li>
@@ -359,12 +394,13 @@ package.</p>
359
394
  <td>
360
395
  <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 12</span>
361
396
 
362
- <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
363
- <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='kw'>nil</span>
364
- <span class='ivar'>@core</span><span class='comma'>,</span> <span class='ivar'>@app</span> <span class='op'>=</span> <span class='const'>Core</span><span class='period'>.</span><span class='id new'>new</span><span class='comma'>,</span> <span class='const'>App</span><span class='period'>.</span><span class='id new'>new</span>
365
- <span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:author</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span>
366
- <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
367
- <span class='kw'>end</span></pre>
397
+ <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>
398
+ <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span>
399
+ <span class='@core ivar id'>@core</span><span class='comma token'>,</span> <span class='@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='Core constant id'>Core</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='App constant id'>App</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
400
+ <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:author</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span>
401
+ <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>
402
+ <span class='end end kw'>end</span>
403
+ </pre>
368
404
  </td>
369
405
  </tr>
370
406
  </table>
@@ -378,7 +414,69 @@ package.</p>
378
414
 
379
415
 
380
416
  <div class="method_details first">
381
- <p class="signature first" id="serialize-instance_method">
417
+ <p class="signature first" id="ruport_table-instance_method">
418
+
419
+ - (<tt>Object</tt>) <strong>ruport_table</strong>(table)
420
+
421
+
422
+
423
+ </p><div class="docstring">
424
+ <div class="discussion">
425
+ <p>
426
+ Accepts a ruport table for serialization to xlsx
427
+ </p>
428
+
429
+
430
+ </div>
431
+ </div>
432
+ <div class="tags">
433
+ <h3>Parameters:</h3>
434
+ <ul class="param">
435
+
436
+ <li>
437
+
438
+ <span class='name'>table</span>
439
+
440
+
441
+ <span class='type'>(<tt>Table</tt>)</span>
442
+
443
+
444
+
445
+ &mdash;
446
+ <div class='inline'><p>
447
+ a ruport Table object
448
+ </p>
449
+ </div>
450
+
451
+ </li>
452
+
453
+ </ul>
454
+
455
+
456
+ </div><table class="source_code">
457
+ <tr>
458
+ <td>
459
+ <pre class="lines">
460
+
461
+
462
+ 21
463
+ 22
464
+ 23</pre>
465
+ </td>
466
+ <td>
467
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span>
468
+
469
+ <span class='def def kw'>def</span> <span class='ruport_table identifier id'>ruport_table</span><span class='lparen token'>(</span><span class='table identifier id'>table</span><span class='rparen token'>)</span>
470
+ <span class='puts identifier id'>puts</span> <span class='table identifier id'>table</span>
471
+ <span class='end end kw'>end</span>
472
+ </pre>
473
+ </td>
474
+ </tr>
475
+ </table>
476
+ </div>
477
+
478
+ <div class="method_details ">
479
+ <p class="signature " id="serialize-instance_method">
382
480
 
383
481
  - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false)
384
482
 
@@ -389,15 +487,17 @@ package.</p>
389
487
 
390
488
  <div class="note notetag">
391
489
  <strong>Note:</strong>
392
- <div class='inline'>
393
- <p>A tremendous amount of effort has gone into ensuring that you cannot create
490
+ <div class='inline'><p>
491
+ A tremendous amount of effort has gone into ensuring that you cannot create
394
492
  invalid xlsx documents. confirm_valid should be used in the rare case that
395
- you cannot open the serialized file.</p>
493
+ you cannot open the serialized file.
494
+ </p>
396
495
  </div>
397
496
  </div>
398
497
 
399
-
400
- <p>Serialize your workbook to disk as an xlsx document.</p>
498
+ <p>
499
+ Serialize your workbook to disk as an xlsx document.
500
+ </p>
401
501
 
402
502
 
403
503
  </div>
@@ -408,12 +508,13 @@ you cannot open the serialized file.</p>
408
508
  <h3>Examples:</h3>
409
509
 
410
510
  <h4><div class='inline'></div></h4>
411
- <pre class="example code"><span class='comment'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
412
- </span><span class='comment'># Take a look at the README for an example of how to do it!
413
- </span><span class='id f'>f</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>test.xlsx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>w</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
414
- <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id f'>f</span><span class='rparen'>)</span>
511
+ <pre class="example code"><span class='comment val'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.</span>
512
+ <span class='comment val'># Take a look at the README for an example of how to do it!</span>
513
+ <span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'test.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span>
514
+ <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span>
415
515
 
416
- <span class='comment'># You will find a file called test.xlsx</span></pre>
516
+ <span class='comment val'># You will find a file called test.xlsx</span>
517
+ </pre>
417
518
 
418
519
  </div>
419
520
  <h3>Parameters:</h3>
@@ -429,8 +530,9 @@ you cannot open the serialized file.</p>
429
530
 
430
531
 
431
532
  &mdash;
432
- <div class='inline'>
433
- <p>The file you want to serialize your package to</p>
533
+ <div class='inline'><p>
534
+ The file you want to serialize your package to
535
+ </p>
434
536
  </div>
435
537
 
436
538
  </li>
@@ -447,8 +549,9 @@ you cannot open the serialized file.</p>
447
549
 
448
550
 
449
551
  &mdash;
450
- <div class='inline'>
451
- <p>Validate the package prior to serialization.</p>
552
+ <div class='inline'><p>
553
+ Validate the package prior to serialization.
554
+ </p>
452
555
  </div>
453
556
 
454
557
  </li>
@@ -466,9 +569,10 @@ you cannot open the serialized file.</p>
466
569
 
467
570
 
468
571
  &mdash;
469
- <div class='inline'>
470
- <p>False if confirm_valid and validation errors exist. True if the package was
471
- serialized</p>
572
+ <div class='inline'><p>
573
+ False if confirm_valid and validation errors exist. True if the package was
574
+ serialized
575
+ </p>
472
576
  </div>
473
577
 
474
578
  </li>
@@ -488,13 +592,6 @@ serialized</p>
488
592
  <pre class="lines">
489
593
 
490
594
 
491
- 54
492
- 55
493
- 56
494
- 57
495
- 58
496
- 59
497
- 60
498
595
  61
499
596
  62
500
597
  63
@@ -505,29 +602,37 @@ serialized</p>
505
602
  68
506
603
  69
507
604
  70
508
- 71</pre>
605
+ 71
606
+ 72
607
+ 73
608
+ 74
609
+ 75
610
+ 76
611
+ 77
612
+ 78</pre>
509
613
  </td>
510
614
  <td>
511
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 54</span>
512
-
513
- <span class='kw'>def</span> <span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id output'>output</span><span class='comma'>,</span> <span class='id confirm_valid'>confirm_valid</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
514
- <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id confirm_valid'>confirm_valid</span> <span class='op'>||</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id empty?'>empty?</span>
515
- <span class='id p'>p</span> <span class='op'>=</span> <span class='id parts'>parts</span>
516
- <span class='const'>Zip</span><span class='op'>::</span><span class='const'>ZipOutputStream</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='id output'>output</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id zip'>zip</span><span class='op'>|</span>
517
- <span class='id p'>p</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span>
518
- <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
519
- <span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span>
520
- <span class='id zip'>zip</span><span class='period'>.</span><span class='id puts'>puts</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span>
521
- <span class='kw'>end</span>
522
- <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
523
- <span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span>
524
- <span class='comment'># binread for 1.9.3
525
- </span> <span class='id zip'>zip</span><span class='period'>.</span><span class='id write'>write</span> <span class='const'>IO</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:binread</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>IO</span><span class='period'>.</span><span class='id binread'>binread</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>IO</span><span class='period'>.</span><span class='id read'>read</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span>
526
- <span class='kw'>end</span>
527
- <span class='kw'>end</span>
528
- <span class='kw'>end</span>
529
- <span class='kw'>true</span>
530
- <span class='kw'>end</span></pre>
615
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 61</span>
616
+
617
+ <span class='def def kw'>def</span> <span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='confirm_valid identifier id'>confirm_valid</span><span class='assign token'>=</span><span class='false false kw'>false</span><span class='rparen token'>)</span>
618
+ <span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='notop op'>!</span><span class='confirm_valid identifier id'>confirm_valid</span> <span class='orop op'>||</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span>
619
+ <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='parts identifier id'>parts</span>
620
+ <span class='Zip constant id'>Zip</span><span class='colon2 op'>::</span><span class='ZipOutputStream constant id'>ZipOutputStream</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='zip identifier id'>zip</span><span class='bitor op'>|</span>
621
+ <span class='p identifier id'>p</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='part identifier id'>part</span><span class='bitor op'>|</span>
622
+ <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
623
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span>
624
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='puts identifier id'>puts</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
625
+ <span class='end end kw'>end</span>
626
+ <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
627
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span>
628
+ <span class='comment val'># binread for 1.9.3</span>
629
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='write identifier id'>write</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:binread</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='binread identifier id'>binread</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
630
+ <span class='end end kw'>end</span>
631
+ <span class='end end kw'>end</span>
632
+ <span class='end end kw'>end</span>
633
+ <span class='true true kw'>true</span>
634
+ <span class='end end kw'>end</span>
635
+ </pre>
531
636
  </td>
532
637
  </tr>
533
638
  </table>
@@ -545,22 +650,25 @@ serialized</p>
545
650
 
546
651
  <div class="note notetag">
547
652
  <strong>Note:</strong>
548
- <div class='inline'>
549
- <p>This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
653
+ <div class='inline'><p>
654
+ This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
550
655
  and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition.
551
656
  opc schema require an internet connection to import remote schema from
552
657
  dublin core for dc, dcterms and xml namespaces. Those remote schema are
553
- included in this gem, and the original files have been altered to refer to
554
- the local versions.</p>
555
-
556
- <p>If by chance you are able to creat a package that does not validate it
658
+ included in this gem, and the original files have been altered to refer to
659
+ the local versions.
660
+ </p>
661
+ <p>
662
+ If by chance you are able to creat a package that does not validate it
557
663
  indicates that the internal validation is not robust enough and needs to be
558
- improved. Please report your errors to the gem author.</p>
664
+ improved. Please report your errors to the gem author.
665
+ </p>
559
666
  </div>
560
667
  </div>
561
668
 
562
-
563
- <p>Validate all parts of the package against xsd schema.</p>
669
+ <p>
670
+ Validate all parts of the package against xsd schema.
671
+ </p>
564
672
 
565
673
 
566
674
  </div>
@@ -571,10 +679,11 @@ improved. Please report your errors to the gem author.</p>
571
679
  <h3>Examples:</h3>
572
680
 
573
681
  <h4><div class='inline'></div></h4>
574
- <pre class="example code"><span class='comment'># The following will output any error messages found in serialization.
575
- </span><span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span>
576
- <span class='comment'># ... code to create sheets, charts, styles etc.
577
- </span><span class='id p'>p</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id error'>error</span><span class='op'>|</span> <span class='id puts'>puts</span> <span class='id error'>error</span><span class='period'>.</span><span class='id message'>message</span> <span class='rbrace'>}</span></pre>
682
+ <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span>
683
+ <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>
684
+ <span class='comment val'># ... code to create sheets, charts, styles etc.</span>
685
+ <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</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='error identifier id'>error</span><span class='bitor op'>|</span> <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='message identifier id'>message</span> <span class='rbrace token'>}</span>
686
+ </pre>
578
687
 
579
688
  </div>
580
689
 
@@ -589,8 +698,9 @@ improved. Please report your errors to the gem author.</p>
589
698
 
590
699
 
591
700
  &mdash;
592
- <div class='inline'>
593
- <p>An array of all validation errors found.</p>
701
+ <div class='inline'><p>
702
+ An array of all validation errors found.
703
+ </p>
594
704
  </div>
595
705
 
596
706
  </li>
@@ -610,20 +720,21 @@ improved. Please report your errors to the gem author.</p>
610
720
  <pre class="lines">
611
721
 
612
722
 
613
- 88
614
- 89
615
- 90
616
- 91
617
- 92</pre>
723
+ 95
724
+ 96
725
+ 97
726
+ 98
727
+ 99</pre>
618
728
  </td>
619
729
  <td>
620
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 88</span>
621
-
622
- <span class='kw'>def</span> <span class='id validate'>validate</span>
623
- <span class='id errors'>errors</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
624
- <span class='id parts'>parts</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span> <span class='id errors'>errors</span><span class='period'>.</span><span class='id concat'>concat</span> <span class='id validate_single_doc'>validate_single_doc</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='rbrace'>}</span>
625
- <span class='id errors'>errors</span>
626
- <span class='kw'>end</span></pre>
730
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 95</span>
731
+
732
+ <span class='def def kw'>def</span> <span class='validate identifier id'>validate</span>
733
+ <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
734
+ <span class='parts identifier id'>parts</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='part identifier id'>part</span><span class='bitor op'>|</span> <span class='errors identifier id'>errors</span><span class='dot token'>.</span><span class='concat identifier id'>concat</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span>
735
+ <span class='errors identifier id'>errors</span>
736
+ <span class='end end kw'>end</span>
737
+ </pre>
627
738
  </td>
628
739
  </tr>
629
740
  </table>
@@ -632,7 +743,7 @@ improved. Please report your errors to the gem author.</p>
632
743
  <div class="method_details ">
633
744
  <p class="signature " id="workbook-instance_method">
634
745
 
635
- - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong>
746
+ - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> {|@workbook| ... }
636
747
 
637
748
 
638
749
 
@@ -641,28 +752,44 @@ improved. Please report your errors to the gem author.</p>
641
752
 
642
753
  <div class="note notetag">
643
754
  <strong>Note:</strong>
644
- <div class='inline'>
645
- <p>As there are multiple ways to instantiate a workbook for the package, here
646
- are a few examples:</p>
647
-
648
- <pre class="code"><span class='comment'># assign directly during package instanciation
649
- </span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:workbook</span> <span class='op'>=&gt;</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span>
650
-
651
- <span class='comment'># get a fresh workbook automatically from the package
652
- </span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Pacakge</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span>
653
- <span class='comment'># # set the workbook after creating the package
654
- </span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span></pre>
755
+ <div class='inline'><p>
756
+ As there are multiple ways to instantiate a workbook for the package, here
757
+ are a few examples:
758
+ </p>
759
+ <pre class="code">
760
+ <span class='comment val'># assign directly during package instanciation</span>
761
+ <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:workbook</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span>
762
+
763
+ <span class='comment val'># get a fresh workbook automatically from the package</span>
764
+ <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Pacakge constant id'>Pacakge</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span>
765
+ <span class='comment val'># # set the workbook after creating the package</span>
766
+ <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
767
+ </pre>
655
768
  </div>
656
769
  </div>
657
770
 
658
-
659
- <p>The workbook this package will serialize or validate.</p>
771
+ <p>
772
+ The workbook this package will serialize or validate.
773
+ </p>
660
774
 
661
775
 
662
776
  </div>
663
777
  </div>
664
778
  <div class="tags">
665
779
 
780
+ <h3>Yields:</h3>
781
+ <ul class="yield">
782
+
783
+ <li>
784
+
785
+
786
+ <span class='type'>(<tt>@workbook</tt>)</span>
787
+
788
+
789
+
790
+ </li>
791
+
792
+ </ul>
666
793
  <h3>Returns:</h3>
667
794
  <ul class="return">
668
795
 
@@ -674,9 +801,10 @@ are a few examples:</p>
674
801
 
675
802
 
676
803
  &mdash;
677
- <div class='inline'>
678
- <p>If no workbook instance has been assigned with this package a new Workbook
679
- instance is returned.</p>
804
+ <div class='inline'><p>
805
+ If no workbook instance has been assigned with this package a new Workbook
806
+ instance is returned.
807
+ </p>
680
808
  </div>
681
809
 
682
810
  </li>
@@ -693,8 +821,9 @@ instance is returned.</p>
693
821
 
694
822
 
695
823
 
696
- <div class='inline'>
697
- <p>ArgumentError if workbook parameter is not a Workbook instance.</p>
824
+ <div class='inline'><p>
825
+ ArgumentError if workbook parameter is not a Workbook instance.
826
+ </p>
698
827
  </div>
699
828
 
700
829
  </li>
@@ -707,16 +836,21 @@ instance is returned.</p>
707
836
  <pre class="lines">
708
837
 
709
838
 
710
- 32
711
- 33
712
- 34</pre>
839
+ 37
840
+ 38
841
+ 39
842
+ 40
843
+ 41</pre>
713
844
  </td>
714
845
  <td>
715
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 32</span>
846
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span>
716
847
 
717
- <span class='kw'>def</span> <span class='id workbook'>workbook</span>
718
- <span class='ivar'>@workbook</span> <span class='op'>||</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span>
719
- <span class='kw'>end</span></pre>
848
+ <span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span>
849
+ <span class='@workbook ivar id'>@workbook</span> <span class='orop op'>||</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
850
+ <span class='yield yield kw'>yield</span> <span class='@workbook ivar id'>@workbook</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
851
+ <span class='@workbook ivar id'>@workbook</span>
852
+ <span class='end end kw'>end</span>
853
+ </pre>
720
854
  </td>
721
855
  </tr>
722
856
  </table>
@@ -751,12 +885,13 @@ instance is returned.</p>
751
885
  <pre class="lines">
752
886
 
753
887
 
754
- 37</pre>
888
+ 44</pre>
755
889
  </td>
756
890
  <td>
757
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span>
891
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 44</span>
758
892
 
759
- <span class='kw'>def</span> <span class='id workbook='>workbook=</span><span class='lparen'>(</span><span class='id workbook'>workbook</span><span class='rparen'>)</span> <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Package.workbook</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='const'>Workbook</span><span class='comma'>,</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
893
+ <span class='def def kw'>def</span> <span class='workbook= identifier id'>workbook=</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='rparen token'>)</span> <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>&quot;Package.workbook&quot;</span><span class='comma token'>,</span> <span class='Workbook constant id'>Workbook</span><span class='comma token'>,</span> <span class='workbook identifier id'>workbook</span><span class='semicolon token'>;</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='workbook identifier id'>workbook</span> <span class='end end kw'>end</span>
894
+ </pre>
760
895
  </td>
761
896
  </tr>
762
897
  </table>
@@ -767,9 +902,9 @@ instance is returned.</p>
767
902
  </div>
768
903
 
769
904
  <div id="footer">
770
- Generated on Sat Nov 26 13:16:36 2011 by
905
+ Generated on Sun Nov 27 21:54:19 2011 by
771
906
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
772
- 0.7.3 (ruby-1.9.3).
907
+ 0.7.3 (ruby-1.8.7).
773
908
  </div>
774
909
 
775
910
  </body>