axlsx 1.0.5 → 1.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. data/README.md +10 -9
  2. data/doc/Axlsx.html +2443 -0
  3. data/doc/Axlsx/App.html +2640 -0
  4. data/doc/Axlsx/Axis.html +1047 -0
  5. data/doc/Axlsx/Bar3DChart.html +1153 -0
  6. data/doc/Axlsx/BarSeries.html +764 -0
  7. data/doc/Axlsx/Border.html +775 -0
  8. data/doc/Axlsx/BorderPr.html +709 -0
  9. data/doc/Axlsx/CatAxis.html +766 -0
  10. data/doc/Axlsx/Cell.html +1623 -0
  11. data/doc/Axlsx/CellAlignment.html +1247 -0
  12. data/doc/Axlsx/CellProtection.html +565 -0
  13. data/doc/Axlsx/CellStyle.html +949 -0
  14. data/doc/Axlsx/Chart.html +1459 -0
  15. data/doc/Axlsx/Color.html +665 -0
  16. data/doc/Axlsx/ContentType.html +340 -0
  17. data/doc/Axlsx/Core.html +465 -0
  18. data/doc/Axlsx/DataTypeValidator.html +324 -0
  19. data/doc/Axlsx/Default.html +575 -0
  20. data/doc/Axlsx/Drawing.html +1154 -0
  21. data/doc/Axlsx/Fill.html +460 -0
  22. data/doc/Axlsx/Font.html +1554 -0
  23. data/doc/Axlsx/GradientFill.html +1026 -0
  24. data/doc/Axlsx/GradientStop.html +526 -0
  25. data/doc/Axlsx/GraphicFrame.html +646 -0
  26. data/doc/Axlsx/Line3DChart.html +921 -0
  27. data/doc/Axlsx/LineSeries.html +656 -0
  28. data/doc/Axlsx/Marker.html +857 -0
  29. data/doc/Axlsx/NumFmt.html +562 -0
  30. data/doc/Axlsx/Override.html +568 -0
  31. data/doc/Axlsx/Package.html +1293 -0
  32. data/doc/Axlsx/PatternFill.html +681 -0
  33. data/doc/Axlsx/Pie3DChart.html +439 -0
  34. data/doc/Axlsx/PieSeries.html +762 -0
  35. data/doc/Axlsx/RegexValidator.html +268 -0
  36. data/doc/Axlsx/Relationship.html +554 -0
  37. data/doc/Axlsx/Relationships.html +343 -0
  38. data/doc/Axlsx/RestrictionValidator.html +300 -0
  39. data/doc/Axlsx/Row.html +771 -0
  40. data/doc/Axlsx/Scaling.html +740 -0
  41. data/doc/Axlsx/SerAxis.html +624 -0
  42. data/doc/Axlsx/Series.html +746 -0
  43. data/doc/Axlsx/SeriesTitle.html +289 -0
  44. data/doc/Axlsx/SimpleTypedList.html +1617 -0
  45. data/doc/Axlsx/Styles.html +1754 -0
  46. data/doc/Axlsx/TableStyle.html +710 -0
  47. data/doc/Axlsx/TableStyleElement.html +677 -0
  48. data/doc/Axlsx/TableStyles.html +599 -0
  49. data/doc/Axlsx/Title.html +625 -0
  50. data/doc/Axlsx/TwoCellAnchor.html +1115 -0
  51. data/doc/Axlsx/ValAxis.html +539 -0
  52. data/doc/Axlsx/View3D.html +971 -0
  53. data/doc/Axlsx/Workbook.html +1347 -0
  54. data/doc/Axlsx/Worksheet.html +1864 -0
  55. data/doc/Axlsx/Xf.html +1681 -0
  56. data/doc/_index.html +611 -0
  57. data/doc/class_list.html +47 -0
  58. data/doc/css/common.css +1 -0
  59. data/doc/css/full_list.css +55 -0
  60. data/doc/css/style.css +322 -0
  61. data/doc/file.README.html +262 -0
  62. data/doc/file_list.html +49 -0
  63. data/doc/frames.html +13 -0
  64. data/doc/index.html +262 -0
  65. data/doc/js/app.js +205 -0
  66. data/doc/js/full_list.js +167 -0
  67. data/doc/js/jquery.js +16 -0
  68. data/doc/method_list.html +3038 -0
  69. data/doc/top-level-namespace.html +103 -0
  70. data/lib/axlsx/util/constants.rb +1 -1
  71. metadata +71 -3
data/doc/Axlsx/Package.html ADDED
@@ -0,0 +1,1293 @@
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::Package
8
+
9
+ &mdash; Documentation by YARD 0.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (P)</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">Package</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::Package
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::Package</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/package.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
+ Package is responsible for managing all the bits and peices that Open
99
+ Office XML requires to make a valid xlsx document including valdation and
100
+ serialization.
101
+ </p>
102
+
103
+
104
+ </div>
105
+ </div>
106
+ <div class="tags">
107
+
108
+
109
+ </div>
110
+
111
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
112
+ <ul class="summary">
113
+
114
+ <li class="public ">
115
+ <span class="summary_signature">
116
+
117
+ <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a>
118
+
119
+
120
+
121
+ </span>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+ <span class="summary_desc"><div class='inline'><p>
134
+ The workbook this package will serialize or validate.
135
+ </p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+
144
+
145
+
146
+
147
+ <h2>
148
+ Instance Method Summary
149
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
150
+ </h2>
151
+
152
+ <ul class="summary">
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#base_content_types-instance_method" title="#base_content_types (instance method)">- (ContentType) <strong>base_content_types</strong> </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+ <span class="summary_desc"><div class='inline'><p>
171
+ Creates the minimum content types for generating a valid xlsx document.
172
+ </p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#content_types-instance_method" title="#content_types (instance method)">- (ContentType) <strong>content_types</strong> </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+ <span class="summary_desc"><div class='inline'><p>
195
+ Appends override objects for drawings, charts, and sheets as they exist in
196
+ your workbook to the default content types.
197
+ </p>
198
+ </div></span>
199
+
200
+ </li>
201
+
202
+
203
+ <li class="public ">
204
+ <span class="summary_signature">
205
+
206
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Package) <strong>initialize</strong>(options = {}) {|_self| ... }</a>
207
+
208
+
209
+
210
+ </span>
211
+
212
+ <span class="note title constructor">constructor</span>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'><p>
222
+ Initializes your package.
223
+ </p>
224
+ </div></span>
225
+
226
+ </li>
227
+
228
+
229
+ <li class="public ">
230
+ <span class="summary_signature">
231
+
232
+ <a href="#parts-instance_method" title="#parts (instance method)">- (Array) <strong>parts</strong> </a>
233
+
234
+
235
+
236
+ </span>
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'><p>
246
+ The parts of a package.
247
+ </p>
248
+ </div></span>
249
+
250
+ </li>
251
+
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a>
257
+
258
+
259
+
260
+ </span>
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+ <span class="summary_desc"><div class='inline'><p>
270
+ Creates the relationships required for a valid xlsx document.
271
+ </p>
272
+ </div></span>
273
+
274
+ </li>
275
+
276
+
277
+ <li class="public ">
278
+ <span class="summary_signature">
279
+
280
+ <a href="#serialize-instance_method" title="#serialize (instance method)">- (Boolean) <strong>serialize</strong>(output, confirm_valid = false) </a>
281
+
282
+
283
+
284
+ </span>
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+ <span class="summary_desc"><div class='inline'><p>
294
+ Serialize your workbook to disk as an xlsx document.
295
+ </p>
296
+ </div></span>
297
+
298
+ </li>
299
+
300
+
301
+ <li class="public ">
302
+ <span class="summary_signature">
303
+
304
+ <a href="#validate-instance_method" title="#validate (instance method)">- (Array) <strong>validate</strong> </a>
305
+
306
+
307
+
308
+ </span>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+ <span class="summary_desc"><div class='inline'><p>
318
+ Validate all parts of the package against xsd schema.
319
+ </p>
320
+ </div></span>
321
+
322
+ </li>
323
+
324
+
325
+ <li class="public ">
326
+ <span class="summary_signature">
327
+
328
+ <a href="#validate_single_doc-instance_method" title="#validate_single_doc (instance method)">- (Array) <strong>validate_single_doc</strong>(schema, doc) </a>
329
+
330
+
331
+
332
+ </span>
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <span class="summary_desc"><div class='inline'><p>
342
+ Performs xsd validation for a signle document.
343
+ </p>
344
+ </div></span>
345
+
346
+ </li>
347
+
348
+
349
+ </ul>
350
+
351
+
352
+ <div id="constructor_details" class="method_details_list">
353
+ <h2>Constructor Details</h2>
354
+
355
+ <div class="method_details first">
356
+ <p class="signature first" id="initialize-instance_method">
357
+
358
+ - (<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Package</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... }
359
+
360
+
361
+
362
+ </p><div class="docstring">
363
+ <div class="discussion">
364
+ <p>
365
+ Initializes your package
366
+ </p>
367
+
368
+
369
+ </div>
370
+ </div>
371
+ <div class="tags">
372
+
373
+ <div class="examples">
374
+ <h3>Examples:</h3>
375
+
376
+ <h4><div class='inline'><p>
377
+ Package.new :author =&gt; &#8216;you!&#8217;, :workbook =&gt; Workbook.new
378
+ </p>
379
+ </div></h4>
380
+ <pre class="example code">
381
+ </pre>
382
+
383
+ </div>
384
+ <h3>Parameters:</h3>
385
+ <ul class="param">
386
+
387
+ <li>
388
+
389
+ <span class='name'>options</span>
390
+
391
+
392
+ <span class='type'>(<tt>Hash</tt>)</span>
393
+
394
+
395
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
396
+
397
+
398
+ &mdash;
399
+ <div class='inline'><p>
400
+ A hash that you can use to specify the author and workbook for this
401
+ package.
402
+ </p>
403
+ </div>
404
+
405
+ </li>
406
+
407
+ </ul>
408
+
409
+
410
+
411
+
412
+ <h3>Options Hash (<tt>options</tt>):</h3>
413
+ <ul class="option">
414
+
415
+ <li>
416
+ <span class="name">:author</span>
417
+ <span class="type">(<tt>String</tt>)</span>
418
+ <span class="default">
419
+
420
+ </span>
421
+ &mdash; <div class='inline'><p>
422
+ The author of the document
423
+ </p>
424
+ </div>
425
+ </li>
426
+
427
+ </ul>
428
+
429
+
430
+ <h3>Yields:</h3>
431
+ <ul class="yield">
432
+
433
+ <li>
434
+
435
+
436
+ <span class='type'>(<tt>_self</tt>)</span>
437
+
438
+
439
+
440
+ </li>
441
+
442
+ </ul>
443
+ <h3>Yield Parameters:</h3>
444
+ <ul class="yieldparam">
445
+
446
+ <li>
447
+
448
+ <span class='name'>_self</span>
449
+
450
+
451
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Axlsx::Package</a></span></tt>)</span>
452
+
453
+
454
+
455
+ &mdash;
456
+ <div class='inline'><p>
457
+ the object that the method was called on
458
+ </p>
459
+ </div>
460
+
461
+ </li>
462
+
463
+ </ul>
464
+
465
+ </div><table class="source_code">
466
+ <tr>
467
+ <td>
468
+ <pre class="lines">
469
+
470
+
471
+ 28
472
+ 29
473
+ 30
474
+ 31
475
+ 32</pre>
476
+ </td>
477
+ <td>
478
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 28</span>
479
+
480
+ <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>
481
+ <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>
482
+ <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>
483
+ <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>
484
+ <span class='end end kw'>end</span>
485
+ </pre>
486
+ </td>
487
+ </tr>
488
+ </table>
489
+ </div>
490
+
491
+ </div>
492
+
493
+ <div id="instance_attr_details" class="attr_details">
494
+ <h2>Instance Attribute Details</h2>
495
+
496
+
497
+ <span id="workbook=-instance_method"></span>
498
+ <span id="workbook-instance_method"></span>
499
+ <div class="method_details first">
500
+ <p class="signature first" id="workbook-instance_method">
501
+
502
+ - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong>
503
+
504
+
505
+
506
+ </p><div class="docstring">
507
+ <div class="discussion">
508
+
509
+ <div class="note notetag">
510
+ <strong>Note:</strong>
511
+ <div class='inline'><p>
512
+ As there are multiple ways to instantiate a workbook for the package, here
513
+ are a few examples:
514
+ </p>
515
+ <pre class="code">
516
+ <span class='comment val'># assign directly during package instanciation</span>
517
+ <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>
518
+
519
+ <span class='comment val'># get a fresh workbook automatically from the package</span>
520
+ <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>
521
+ <span class='comment val'># # set the workbook after creating the package</span>
522
+ <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>
523
+ </pre>
524
+ </div>
525
+ </div>
526
+
527
+ <p>
528
+ The workbook this package will serialize or validate.
529
+ </p>
530
+
531
+
532
+ </div>
533
+ </div>
534
+ <div class="tags">
535
+
536
+ <h3>Returns:</h3>
537
+ <ul class="return">
538
+
539
+ <li>
540
+
541
+
542
+ <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span>
543
+
544
+
545
+
546
+ &mdash;
547
+ <div class='inline'><p>
548
+ If no workbook instance has been assigned with this package a new Workbook
549
+ instance is returned.
550
+ </p>
551
+ </div>
552
+
553
+ </li>
554
+
555
+ </ul>
556
+ <h3>Raises:</h3>
557
+ <ul class="raise">
558
+
559
+ <li>
560
+
561
+
562
+ <span class='type'></span>
563
+
564
+
565
+
566
+
567
+ <div class='inline'><p>
568
+ ArgumentError if workbook parameter is not a Workbook instance.
569
+ </p>
570
+ </div>
571
+
572
+ </li>
573
+
574
+ </ul>
575
+
576
+ </div><table class="source_code">
577
+ <tr>
578
+ <td>
579
+ <pre class="lines">
580
+
581
+
582
+ 21
583
+ 22
584
+ 23</pre>
585
+ </td>
586
+ <td>
587
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span>
588
+
589
+ <span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span>
590
+ <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>
591
+ <span class='end end kw'>end</span>
592
+ </pre>
593
+ </td>
594
+ </tr>
595
+ </table>
596
+ </div>
597
+
598
+ </div>
599
+
600
+
601
+ <div id="instance_method_details" class="method_details_list">
602
+ <h2>Instance Method Details</h2>
603
+
604
+
605
+ <div class="method_details first">
606
+ <p class="signature first" id="base_content_types-instance_method">
607
+
608
+ - (<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>) <strong>base_content_types</strong>
609
+
610
+
611
+
612
+ </p><div class="docstring">
613
+ <div class="discussion">
614
+ <p>
615
+ Creates the minimum content types for generating a valid xlsx document.
616
+ </p>
617
+
618
+
619
+ </div>
620
+ </div>
621
+ <div class="tags">
622
+
623
+ <h3>Returns:</h3>
624
+ <ul class="return">
625
+
626
+ <li>
627
+
628
+
629
+ <span class='type'>(<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>)</span>
630
+
631
+
632
+
633
+ </li>
634
+
635
+ </ul>
636
+
637
+ </div><table class="source_code">
638
+ <tr>
639
+ <td>
640
+ <pre class="lines">
641
+
642
+
643
+ 156
644
+ 157
645
+ 158
646
+ 159
647
+ 160
648
+ 161
649
+ 162
650
+ 163
651
+ 164
652
+ 165
653
+ 166</pre>
654
+ </td>
655
+ <td>
656
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 156</span>
657
+
658
+ <span class='def def kw'>def</span> <span class='base_content_types identifier id'>base_content_types</span>
659
+ <span class='c_types identifier id'>c_types</span> <span class='assign token'>=</span> <span class='ContentType constant id'>ContentType</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
660
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Default constant id'>Default</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='RELS_CT constant id'>RELS_CT</span><span class='comma token'>,</span> <span class='symbol val'>:Extension</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='RELS_EX constant id'>RELS_EX</span><span class='rparen token'>)</span>
661
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Default constant id'>Default</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:Extension</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='XML_EX constant id'>XML_EX</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='XML_CT constant id'>XML_CT</span><span class='rparen token'>)</span>
662
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/#{APP_PN}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='APP_CT constant id'>APP_CT</span><span class='rparen token'>)</span>
663
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/#{CORE_PN}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CORE_CT constant id'>CORE_CT</span><span class='rparen token'>)</span>
664
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/xl/#{STYLES_PN}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='STYLES_CT constant id'>STYLES_CT</span><span class='rparen token'>)</span>
665
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/#{WORKBOOK_PN}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='WORKBOOK_CT constant id'>WORKBOOK_CT</span><span class='rparen token'>)</span>
666
+ <span class='c_types identifier id'>c_types</span><span class='dot token'>.</span><span class='lock identifier id'>lock</span>
667
+ <span class='c_types identifier id'>c_types</span>
668
+ <span class='end end kw'>end</span>
669
+ </pre>
670
+ </td>
671
+ </tr>
672
+ </table>
673
+ </div>
674
+
675
+ <div class="method_details ">
676
+ <p class="signature " id="content_types-instance_method">
677
+
678
+ - (<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>) <strong>content_types</strong>
679
+
680
+
681
+
682
+ </p><div class="docstring">
683
+ <div class="discussion">
684
+ <p>
685
+ Appends override objects for drawings, charts, and sheets as they exist in
686
+ your workbook to the default content types.
687
+ </p>
688
+
689
+
690
+ </div>
691
+ </div>
692
+ <div class="tags">
693
+
694
+ <h3>Returns:</h3>
695
+ <ul class="return">
696
+
697
+ <li>
698
+
699
+
700
+ <span class='type'>(<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>)</span>
701
+
702
+
703
+
704
+ </li>
705
+
706
+ </ul>
707
+
708
+ </div><table class="source_code">
709
+ <tr>
710
+ <td>
711
+ <pre class="lines">
712
+
713
+
714
+ 136
715
+ 137
716
+ 138
717
+ 139
718
+ 140
719
+ 141
720
+ 142
721
+ 143
722
+ 144
723
+ 145
724
+ 146
725
+ 147
726
+ 148
727
+ 149
728
+ 150
729
+ 151</pre>
730
+ </td>
731
+ <td>
732
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 136</span>
733
+
734
+ <span class='def def kw'>def</span> <span class='content_types identifier id'>content_types</span>
735
+ <span class='c_types identifier id'>c_types</span> <span class='assign token'>=</span> <span class='base_content_types identifier id'>base_content_types</span>
736
+ <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</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='drawing identifier id'>drawing</span><span class='bitor op'>|</span>
737
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/xl/#{drawing.pn}&quot;</span><span class='comma token'>,</span>
738
+ <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='DRAWING_CT constant id'>DRAWING_CT</span><span class='rparen token'>)</span>
739
+ <span class='end end kw'>end</span>
740
+ <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</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='chart identifier id'>chart</span><span class='bitor op'>|</span>
741
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/xl/#{chart.pn}&quot;</span><span class='comma token'>,</span>
742
+ <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CHART_CT constant id'>CHART_CT</span><span class='rparen token'>)</span>
743
+ <span class='end end kw'>end</span>
744
+ <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier 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>
745
+ <span class='c_types identifier id'>c_types</span> <span class='lshft op'>&lt;&lt;</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;/xl/#{sheet.pn}&quot;</span><span class='comma token'>,</span>
746
+ <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='WORKSHEET_CT constant id'>WORKSHEET_CT</span><span class='rparen token'>)</span>
747
+ <span class='end end kw'>end</span>
748
+ <span class='c_types identifier id'>c_types</span>
749
+ <span class='end end kw'>end</span>
750
+ </pre>
751
+ </td>
752
+ </tr>
753
+ </table>
754
+ </div>
755
+
756
+ <div class="method_details ">
757
+ <p class="signature " id="parts-instance_method">
758
+
759
+ - (<tt>Array</tt>) <strong>parts</strong>
760
+
761
+
762
+
763
+ </p><div class="docstring">
764
+ <div class="discussion">
765
+ <p>
766
+ The parts of a package
767
+ </p>
768
+
769
+
770
+ </div>
771
+ </div>
772
+ <div class="tags">
773
+
774
+ <h3>Returns:</h3>
775
+ <ul class="return">
776
+
777
+ <li>
778
+
779
+
780
+ <span class='type'>(<tt>Array</tt>)</span>
781
+
782
+
783
+
784
+ &mdash;
785
+ <div class='inline'><p>
786
+ An array of hashes that define the entry, document and schema for each part
787
+ of the package.
788
+ </p>
789
+ </div>
790
+
791
+ </li>
792
+
793
+ </ul>
794
+
795
+ </div><table class="source_code">
796
+ <tr>
797
+ <td>
798
+ <pre class="lines">
799
+
800
+
801
+ 90
802
+ 91
803
+ 92
804
+ 93
805
+ 94
806
+ 95
807
+ 96
808
+ 97
809
+ 98
810
+ 99
811
+ 100
812
+ 101
813
+ 102
814
+ 103
815
+ 104
816
+ 105
817
+ 106
818
+ 107
819
+ 108
820
+ 109
821
+ 110
822
+ 111
823
+ 112
824
+ 113
825
+ 114</pre>
826
+ </td>
827
+ <td>
828
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 90</span>
829
+
830
+ <span class='def def kw'>def</span> <span class='parts identifier id'>parts</span>
831
+ <span class='@parts ivar id'>@parts</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span>
832
+ <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='RELS_PN constant id'>RELS_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
833
+ <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CORE_PN constant id'>CORE_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CORE_XSD constant id'>CORE_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
834
+ <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='APP_PN constant id'>APP_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='@app ivar id'>@app</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='APP_XSD constant id'>APP_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
835
+ <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='WORKBOOK_RELS_PN constant id'>WORKBOOK_RELS_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
836
+ <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='WORKBOOK_PN constant id'>WORKBOOK_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
837
+ <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CONTENT_TYPES_PN constant id'>CONTENT_TYPES_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='content_types identifier id'>content_types</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CONTENT_TYPES_XSD constant id'>CONTENT_TYPES_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
838
+ <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;xl/#{STYLES_PN}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span>
839
+ <span class='rbrack token'>]</span>
840
+ <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</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='drawing identifier id'>drawing</span><span class='bitor op'>|</span>
841
+ <span class='@parts ivar id'>@parts</span> <span class='lshft op'>&lt;&lt;</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;xl/#{drawing.rels_pn}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span>
842
+ <span class='@parts ivar id'>@parts</span> <span class='lshft op'>&lt;&lt;</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;xl/#{drawing.pn}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='DRAWING_XSD constant id'>DRAWING_XSD</span><span class='rbrace token'>}</span>
843
+ <span class='end end kw'>end</span>
844
+
845
+ <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</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='chart identifier id'>chart</span><span class='bitor op'>|</span>
846
+ <span class='@parts ivar id'>@parts</span> <span class='lshft op'>&lt;&lt;</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;xl/#{chart.pn}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='DRAWING_XSD constant id'>DRAWING_XSD</span><span class='rbrace token'>}</span>
847
+ <span class='end end kw'>end</span>
848
+
849
+ <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier 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>
850
+ <span class='@parts ivar id'>@parts</span> <span class='lshft op'>&lt;&lt;</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;xl/#{sheet.rels_pn}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:doc</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='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span>
851
+ <span class='@parts ivar id'>@parts</span> <span class='lshft op'>&lt;&lt;</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='dstring node'>&quot;xl/#{sheet.pn}&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:doc</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='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span>
852
+ <span class='end end kw'>end</span>
853
+ <span class='@parts ivar id'>@parts</span>
854
+ <span class='end end kw'>end</span>
855
+ </pre>
856
+ </td>
857
+ </tr>
858
+ </table>
859
+ </div>
860
+
861
+ <div class="method_details ">
862
+ <p class="signature " id="relationships-instance_method">
863
+
864
+ - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong>
865
+
866
+
867
+
868
+ </p><div class="docstring">
869
+ <div class="discussion">
870
+ <p>
871
+ Creates the relationships required for a valid xlsx document
872
+ </p>
873
+
874
+
875
+ </div>
876
+ </div>
877
+ <div class="tags">
878
+
879
+ <h3>Returns:</h3>
880
+ <ul class="return">
881
+
882
+ <li>
883
+
884
+
885
+ <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span>
886
+
887
+
888
+
889
+ </li>
890
+
891
+ </ul>
892
+
893
+ </div><table class="source_code">
894
+ <tr>
895
+ <td>
896
+ <pre class="lines">
897
+
898
+
899
+ 171
900
+ 172
901
+ 173
902
+ 174
903
+ 175
904
+ 176
905
+ 177
906
+ 178</pre>
907
+ </td>
908
+ <td>
909
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 171</span>
910
+
911
+ <span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span>
912
+ <span class='rels identifier id'>rels</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
913
+ <span class='rels identifier id'>rels</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='WORKBOOK_R constant id'>WORKBOOK_R</span><span class='comma token'>,</span> <span class='WORKBOOK_PN constant id'>WORKBOOK_PN</span><span class='rparen token'>)</span>
914
+ <span class='rels identifier id'>rels</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='CORE_R constant id'>CORE_R</span><span class='comma token'>,</span> <span class='CORE_PN constant id'>CORE_PN</span><span class='rparen token'>)</span>
915
+ <span class='rels identifier id'>rels</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='APP_R constant id'>APP_R</span><span class='comma token'>,</span> <span class='APP_PN constant id'>APP_PN</span><span class='rparen token'>)</span>
916
+ <span class='rels identifier id'>rels</span><span class='dot token'>.</span><span class='lock identifier id'>lock</span>
917
+ <span class='rels identifier id'>rels</span>
918
+ <span class='end end kw'>end</span>
919
+ </pre>
920
+ </td>
921
+ </tr>
922
+ </table>
923
+ </div>
924
+
925
+ <div class="method_details ">
926
+ <p class="signature " id="serialize-instance_method">
927
+
928
+ - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false)
929
+
930
+
931
+
932
+ </p><div class="docstring">
933
+ <div class="discussion">
934
+
935
+ <div class="note notetag">
936
+ <strong>Note:</strong>
937
+ <div class='inline'><p>
938
+ A tremendous amount of effort has gone into ensuring that you cannot create
939
+ invalid xlsx documents. confirm_valid should be used in the rare case that
940
+ you cannot open the serialized file.
941
+ </p>
942
+ </div>
943
+ </div>
944
+
945
+ <p>
946
+ Serialize your workbook to disk as an xlsx document.
947
+ </p>
948
+
949
+
950
+ </div>
951
+ </div>
952
+ <div class="tags">
953
+
954
+ <div class="examples">
955
+ <h3>Examples:</h3>
956
+
957
+ <h4><div class='inline'></div></h4>
958
+ <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>
959
+ <span class='comment val'># Take a look at the README for an example of how to do it!</span>
960
+ <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>
961
+ <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>
962
+
963
+ <span class='comment val'># You will find a file called test.xlsx</span>
964
+ </pre>
965
+
966
+ </div>
967
+ <h3>Parameters:</h3>
968
+ <ul class="param">
969
+
970
+ <li>
971
+
972
+ <span class='name'>output</span>
973
+
974
+
975
+ <span class='type'>(<tt>File</tt>)</span>
976
+
977
+
978
+
979
+ &mdash;
980
+ <div class='inline'><p>
981
+ The file you want to serialize your package to
982
+ </p>
983
+ </div>
984
+
985
+ </li>
986
+
987
+ <li>
988
+
989
+ <span class='name'>confirm_valid</span>
990
+
991
+
992
+ <span class='type'>(<tt>Boolean</tt>)</span>
993
+
994
+
995
+ <em class="default">(defaults to: <tt>false</tt>)</em>
996
+
997
+
998
+ &mdash;
999
+ <div class='inline'><p>
1000
+ Validate the package prior to serialization.
1001
+ </p>
1002
+ </div>
1003
+
1004
+ </li>
1005
+
1006
+ </ul>
1007
+
1008
+ <h3>Returns:</h3>
1009
+ <ul class="return">
1010
+
1011
+ <li>
1012
+
1013
+
1014
+ <span class='type'>(<tt>Boolean</tt>)</span>
1015
+
1016
+
1017
+
1018
+ &mdash;
1019
+ <div class='inline'><p>
1020
+ False if confirm_valid and validation errors exist. True if the package was
1021
+ serialized
1022
+ </p>
1023
+ </div>
1024
+
1025
+ </li>
1026
+
1027
+ </ul>
1028
+
1029
+ <h3>See Also:</h3>
1030
+ <ul class="see">
1031
+
1032
+ <li><span class='object_link'><a href="#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span></li>
1033
+
1034
+ </ul>
1035
+
1036
+ </div><table class="source_code">
1037
+ <tr>
1038
+ <td>
1039
+ <pre class="lines">
1040
+
1041
+
1042
+ 55
1043
+ 56
1044
+ 57
1045
+ 58
1046
+ 59
1047
+ 60
1048
+ 61
1049
+ 62</pre>
1050
+ </td>
1051
+ <td>
1052
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 55</span>
1053
+
1054
+ <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>
1055
+ <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>
1056
+ <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='new identifier id'>new</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='string val'>&quot;w&quot;</span><span class='rparen token'>)</span>
1057
+ <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='f identifier id'>f</span><span class='dot token'>.</span><span class='path identifier id'>path</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>
1058
+ <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='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> <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> <span class='rbrace token'>}</span>
1059
+ <span class='end end kw'>end</span>
1060
+ <span class='true true kw'>true</span>
1061
+ <span class='end end kw'>end</span>
1062
+ </pre>
1063
+ </td>
1064
+ </tr>
1065
+ </table>
1066
+ </div>
1067
+
1068
+ <div class="method_details ">
1069
+ <p class="signature " id="validate-instance_method">
1070
+
1071
+ - (<tt>Array</tt>) <strong>validate</strong>
1072
+
1073
+
1074
+
1075
+ </p><div class="docstring">
1076
+ <div class="discussion">
1077
+
1078
+ <div class="note notetag">
1079
+ <strong>Note:</strong>
1080
+ <div class='inline'><p>
1081
+ This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
1082
+ and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition.
1083
+ opc schema require an internet connection to import remote schema from
1084
+ dublin core for dc, dcterms and xml namespaces. Those remote schema are
1085
+ included in this gem, and the original files have been altered to refer to
1086
+ the local versions.
1087
+ </p>
1088
+ <p>
1089
+ If by chance you are able to creat a package that does not validate it
1090
+ indicates that the internal validation is not robust enough and needs to be
1091
+ improved. Please report your errors to the gem author.
1092
+ </p>
1093
+ </div>
1094
+ </div>
1095
+
1096
+ <p>
1097
+ Validate all parts of the package against xsd schema.
1098
+ </p>
1099
+
1100
+
1101
+ </div>
1102
+ </div>
1103
+ <div class="tags">
1104
+
1105
+ <div class="examples">
1106
+ <h3>Examples:</h3>
1107
+
1108
+ <h4><div class='inline'></div></h4>
1109
+ <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span>
1110
+ <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>
1111
+ <span class='comment val'># ... code to create sheets, charts, styles etc.</span>
1112
+ <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>
1113
+ </pre>
1114
+
1115
+ </div>
1116
+
1117
+ <h3>Returns:</h3>
1118
+ <ul class="return">
1119
+
1120
+ <li>
1121
+
1122
+
1123
+ <span class='type'>(<tt>Array</tt>)</span>
1124
+
1125
+
1126
+
1127
+ &mdash;
1128
+ <div class='inline'><p>
1129
+ An array of all validation errors found.
1130
+ </p>
1131
+ </div>
1132
+
1133
+ </li>
1134
+
1135
+ </ul>
1136
+
1137
+ <h3>See Also:</h3>
1138
+ <ul class="see">
1139
+
1140
+ <li><a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm" target="_parent" title="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a></li>
1141
+
1142
+ </ul>
1143
+
1144
+ </div><table class="source_code">
1145
+ <tr>
1146
+ <td>
1147
+ <pre class="lines">
1148
+
1149
+
1150
+ 79
1151
+ 80
1152
+ 81
1153
+ 82
1154
+ 83</pre>
1155
+ </td>
1156
+ <td>
1157
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 79</span>
1158
+
1159
+ <span class='def def kw'>def</span> <span class='validate identifier id'>validate</span>
1160
+ <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
1161
+ <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='rbrace token'>}</span>
1162
+ <span class='errors identifier id'>errors</span>
1163
+ <span class='end end kw'>end</span>
1164
+ </pre>
1165
+ </td>
1166
+ </tr>
1167
+ </table>
1168
+ </div>
1169
+
1170
+ <div class="method_details ">
1171
+ <p class="signature " id="validate_single_doc-instance_method">
1172
+
1173
+ - (<tt>Array</tt>) <strong>validate_single_doc</strong>(schema, doc)
1174
+
1175
+
1176
+
1177
+ </p><div class="docstring">
1178
+ <div class="discussion">
1179
+ <p>
1180
+ Performs xsd validation for a signle document
1181
+ </p>
1182
+
1183
+
1184
+ </div>
1185
+ </div>
1186
+ <div class="tags">
1187
+ <h3>Parameters:</h3>
1188
+ <ul class="param">
1189
+
1190
+ <li>
1191
+
1192
+ <span class='name'>schema</span>
1193
+
1194
+
1195
+ <span class='type'>(<tt>String</tt>)</span>
1196
+
1197
+
1198
+
1199
+ &mdash;
1200
+ <div class='inline'><p>
1201
+ path to the xsd schema to be used in validation.
1202
+ </p>
1203
+ </div>
1204
+
1205
+ </li>
1206
+
1207
+ <li>
1208
+
1209
+ <span class='name'>doc</span>
1210
+
1211
+
1212
+ <span class='type'>(<tt>String</tt>)</span>
1213
+
1214
+
1215
+
1216
+ &mdash;
1217
+ <div class='inline'><p>
1218
+ The xml text to be validated
1219
+ </p>
1220
+ </div>
1221
+
1222
+ </li>
1223
+
1224
+ </ul>
1225
+
1226
+ <h3>Returns:</h3>
1227
+ <ul class="return">
1228
+
1229
+ <li>
1230
+
1231
+
1232
+ <span class='type'>(<tt>Array</tt>)</span>
1233
+
1234
+
1235
+
1236
+ &mdash;
1237
+ <div class='inline'><p>
1238
+ An array of all validation errors encountered.
1239
+ </p>
1240
+ </div>
1241
+
1242
+ </li>
1243
+
1244
+ </ul>
1245
+
1246
+ </div><table class="source_code">
1247
+ <tr>
1248
+ <td>
1249
+ <pre class="lines">
1250
+
1251
+
1252
+ 122
1253
+ 123
1254
+ 124
1255
+ 125
1256
+ 126
1257
+ 127
1258
+ 128
1259
+ 129
1260
+ 130
1261
+ 131</pre>
1262
+ </td>
1263
+ <td>
1264
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 122</span>
1265
+
1266
+ <span class='def def kw'>def</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='schema identifier id'>schema</span><span class='comma token'>,</span> <span class='doc identifier id'>doc</span><span class='rparen token'>)</span>
1267
+ <span class='schema identifier id'>schema</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='Schema constant id'>Schema</span><span class='lparen 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='schema identifier id'>schema</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
1268
+ <span class='doc identifier id'>doc</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='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='rparen token'>)</span>
1269
+
1270
+ <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
1271
+ <span class='schema identifier id'>schema</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='rparen token'>)</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='error identifier id'>error</span><span class='bitor op'>|</span>
1272
+ <span class='errors identifier id'>errors</span> <span class='lshft op'>&lt;&lt;</span> <span class='error identifier id'>error</span>
1273
+ <span class='end end kw'>end</span>
1274
+ <span class='errors identifier id'>errors</span>
1275
+ <span class='end end kw'>end</span>
1276
+ </pre>
1277
+ </td>
1278
+ </tr>
1279
+ </table>
1280
+ </div>
1281
+
1282
+ </div>
1283
+
1284
+ </div>
1285
+
1286
+ <div id="footer">
1287
+ Generated on Tue Nov 22 00:27:37 2011 by
1288
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1289
+ 0.7.3 (ruby-1.8.7).
1290
+ </div>
1291
+
1292
+ </body>
1293
+ </html>