axlsx 1.0.11 → 1.0.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (145) hide show
  1. data/.yardopts +4 -0
  2. data/README.md +7 -4
  3. data/examples/example.rb +6 -4
  4. data/examples/example.rb~ +112 -0
  5. data/lib/schema/dc.xsd~ +118 -0
  6. data/lib/schema/dcterms.xsd~ +331 -0
  7. data/lib/schema/opc-coreProperties.xsd~ +50 -0
  8. metadata +43 -193
  9. data/Gemfile +0 -3
  10. data/Gemfile.lock +0 -29
  11. data/axlsx.gemspec +0 -42
  12. data/doc/Axlsx.html +0 -2718
  13. data/doc/Axlsx/App.html +0 -2640
  14. data/doc/Axlsx/Axis.html +0 -1075
  15. data/doc/Axlsx/Bar3DChart.html +0 -1182
  16. data/doc/Axlsx/BarSeries.html +0 -711
  17. data/doc/Axlsx/Border.html +0 -779
  18. data/doc/Axlsx/BorderPr.html +0 -709
  19. data/doc/Axlsx/CatAxis.html +0 -769
  20. data/doc/Axlsx/CatAxisData.html +0 -397
  21. data/doc/Axlsx/Cell.html +0 -3187
  22. data/doc/Axlsx/CellAlignment.html +0 -1247
  23. data/doc/Axlsx/CellProtection.html +0 -565
  24. data/doc/Axlsx/CellStyle.html +0 -949
  25. data/doc/Axlsx/Chart.html +0 -1692
  26. data/doc/Axlsx/Color.html +0 -670
  27. data/doc/Axlsx/ContentType.html +0 -335
  28. data/doc/Axlsx/Core.html +0 -465
  29. data/doc/Axlsx/DataTypeValidator.html +0 -324
  30. data/doc/Axlsx/Default.html +0 -565
  31. data/doc/Axlsx/Drawing.html +0 -1264
  32. data/doc/Axlsx/Fill.html +0 -460
  33. data/doc/Axlsx/Font.html +0 -1554
  34. data/doc/Axlsx/GradientFill.html +0 -1026
  35. data/doc/Axlsx/GradientStop.html +0 -526
  36. data/doc/Axlsx/GraphicFrame.html +0 -642
  37. data/doc/Axlsx/Line3DChart.html +0 -1004
  38. data/doc/Axlsx/LineSeries.html +0 -605
  39. data/doc/Axlsx/Marker.html +0 -857
  40. data/doc/Axlsx/NumFmt.html +0 -562
  41. data/doc/Axlsx/OneCellAnchor.html +0 -982
  42. data/doc/Axlsx/Override.html +0 -552
  43. data/doc/Axlsx/Package.html +0 -825
  44. data/doc/Axlsx/Parser.html +0 -549
  45. data/doc/Axlsx/PatternFill.html +0 -681
  46. data/doc/Axlsx/Pic.html +0 -1701
  47. data/doc/Axlsx/PictureLocking.html +0 -1159
  48. data/doc/Axlsx/Pie3DChart.html +0 -489
  49. data/doc/Axlsx/PieSeries.html +0 -710
  50. data/doc/Axlsx/RegexValidator.html +0 -268
  51. data/doc/Axlsx/Relationship.html +0 -554
  52. data/doc/Axlsx/Relationships.html +0 -338
  53. data/doc/Axlsx/RestrictionValidator.html +0 -300
  54. data/doc/Axlsx/Row.html +0 -916
  55. data/doc/Axlsx/Scaling.html +0 -742
  56. data/doc/Axlsx/SerAxis.html +0 -641
  57. data/doc/Axlsx/Series.html +0 -813
  58. data/doc/Axlsx/SeriesTitle.html +0 -290
  59. data/doc/Axlsx/Styles.html +0 -1754
  60. data/doc/Axlsx/TableStyle.html +0 -705
  61. data/doc/Axlsx/TableStyleElement.html +0 -677
  62. data/doc/Axlsx/TableStyles.html +0 -594
  63. data/doc/Axlsx/Title.html +0 -543
  64. data/doc/Axlsx/TwoCellAnchor.html +0 -973
  65. data/doc/Axlsx/ValAxis.html +0 -538
  66. data/doc/Axlsx/ValAxisData.html +0 -321
  67. data/doc/Axlsx/View3D.html +0 -973
  68. data/doc/Axlsx/Workbook.html +0 -1630
  69. data/doc/Axlsx/Worksheet.html +0 -2682
  70. data/doc/Axlsx/Xf.html +0 -1780
  71. data/doc/_index.html +0 -649
  72. data/doc/class_list.html +0 -47
  73. data/doc/css/common.css +0 -1
  74. data/doc/css/full_list.css +0 -55
  75. data/doc/css/style.css +0 -322
  76. data/doc/file.LICENSE.html +0 -91
  77. data/doc/file.README.html +0 -338
  78. data/doc/file_list.html +0 -52
  79. data/doc/frames.html +0 -13
  80. data/doc/index.html +0 -338
  81. data/doc/js/app.js +0 -205
  82. data/doc/js/full_list.js +0 -167
  83. data/doc/js/jquery.js +0 -16
  84. data/doc/method_list.html +0 -3502
  85. data/doc/top-level-namespace.html +0 -103
  86. data/lib/axlsx.rb +0 -54
  87. data/lib/axlsx/content_type/content_type.rb +0 -23
  88. data/lib/axlsx/content_type/default.rb +0 -37
  89. data/lib/axlsx/content_type/override.rb +0 -37
  90. data/lib/axlsx/doc_props/app.rb +0 -178
  91. data/lib/axlsx/doc_props/core.rb +0 -34
  92. data/lib/axlsx/drawing/axis.rb +0 -90
  93. data/lib/axlsx/drawing/bar_3D_chart.rb +0 -128
  94. data/lib/axlsx/drawing/bar_series.rb +0 -64
  95. data/lib/axlsx/drawing/cat_axis.rb +0 -63
  96. data/lib/axlsx/drawing/cat_axis_data.rb +0 -35
  97. data/lib/axlsx/drawing/chart.rb +0 -179
  98. data/lib/axlsx/drawing/drawing.rb +0 -137
  99. data/lib/axlsx/drawing/graphic_frame.rb +0 -52
  100. data/lib/axlsx/drawing/line_3D_chart.rb +0 -106
  101. data/lib/axlsx/drawing/line_series.rb +0 -46
  102. data/lib/axlsx/drawing/marker.rb +0 -61
  103. data/lib/axlsx/drawing/one_cell_anchor.rb +0 -89
  104. data/lib/axlsx/drawing/pic.rb +0 -153
  105. data/lib/axlsx/drawing/picture_locking.rb +0 -72
  106. data/lib/axlsx/drawing/pie_3D_chart.rb +0 -41
  107. data/lib/axlsx/drawing/pie_series.rb +0 -56
  108. data/lib/axlsx/drawing/scaling.rb +0 -59
  109. data/lib/axlsx/drawing/ser_axis.rb +0 -45
  110. data/lib/axlsx/drawing/series.rb +0 -71
  111. data/lib/axlsx/drawing/series_title.rb +0 -22
  112. data/lib/axlsx/drawing/title.rb +0 -61
  113. data/lib/axlsx/drawing/two_cell_anchor.rb +0 -76
  114. data/lib/axlsx/drawing/val_axis.rb +0 -34
  115. data/lib/axlsx/drawing/val_axis_data.rb +0 -28
  116. data/lib/axlsx/drawing/view_3D.rb +0 -85
  117. data/lib/axlsx/package.rb +0 -214
  118. data/lib/axlsx/rels/relationship.rb +0 -44
  119. data/lib/axlsx/rels/relationships.rb +0 -25
  120. data/lib/axlsx/stylesheet/border.rb +0 -57
  121. data/lib/axlsx/stylesheet/border_pr.rb +0 -68
  122. data/lib/axlsx/stylesheet/cell_alignment.rb +0 -105
  123. data/lib/axlsx/stylesheet/cell_protection.rb +0 -36
  124. data/lib/axlsx/stylesheet/cell_style.rb +0 -65
  125. data/lib/axlsx/stylesheet/color.rb +0 -69
  126. data/lib/axlsx/stylesheet/fill.rb +0 -32
  127. data/lib/axlsx/stylesheet/font.rb +0 -139
  128. data/lib/axlsx/stylesheet/gradient_fill.rb +0 -76
  129. data/lib/axlsx/stylesheet/gradient_stop.rb +0 -33
  130. data/lib/axlsx/stylesheet/num_fmt.rb +0 -63
  131. data/lib/axlsx/stylesheet/pattern_fill.rb +0 -66
  132. data/lib/axlsx/stylesheet/styles.rb +0 -298
  133. data/lib/axlsx/stylesheet/table_style.rb +0 -47
  134. data/lib/axlsx/stylesheet/table_style_element.rb +0 -71
  135. data/lib/axlsx/stylesheet/table_styles.rb +0 -39
  136. data/lib/axlsx/stylesheet/xf.rb +0 -138
  137. data/lib/axlsx/util/constants.rb +0 -216
  138. data/lib/axlsx/util/parser.rb +0 -43
  139. data/lib/axlsx/util/simple_typed_list.rb +0 -160
  140. data/lib/axlsx/util/validators.rb +0 -132
  141. data/lib/axlsx/version.rb +0 -4
  142. data/lib/axlsx/workbook/workbook.rb +0 -160
  143. data/lib/axlsx/workbook/worksheet/cell.rb +0 -340
  144. data/lib/axlsx/workbook/worksheet/row.rb +0 -107
  145. data/lib/axlsx/workbook/worksheet/worksheet.rb +0 -278
@@ -1,825 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
- <title>
7
- Class: Axlsx::Package
8
-
9
- &mdash; AXLSX
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- relpath = '..';
19
- if (relpath != '') relpath += '/';
20
- </script>
21
-
22
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
-
24
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
-
26
-
27
- </head>
28
- <body>
29
- <script type="text/javascript" charset="utf-8">
30
- if (window.top.frames.main) document.body.className = 'frames';
31
- </script>
32
-
33
- <div id="header">
34
- <div id="menu">
35
-
36
- <a href="../_index.html">Index (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
-
112
-
113
-
114
-
115
- <h2>
116
- Instance Method Summary
117
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
118
- </h2>
119
-
120
- <ul class="summary">
121
-
122
- <li class="public ">
123
- <span class="summary_signature">
124
-
125
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Package) <strong>initialize</strong>(options = {}) {|_self| ... }</a>
126
-
127
-
128
-
129
- </span>
130
-
131
- <span class="note title constructor">constructor</span>
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
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="#serialize-instance_method" title="#serialize (instance method)">- (Boolean) <strong>serialize</strong>(output, confirm_valid = false) </a>
152
-
153
-
154
-
155
- </span>
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
- <span class="summary_desc"><div class='inline'><p>
165
- Serialize your workbook to disk as an xlsx document.
166
- </p>
167
- </div></span>
168
-
169
- </li>
170
-
171
-
172
- <li class="public ">
173
- <span class="summary_signature">
174
-
175
- <a href="#validate-instance_method" title="#validate (instance method)">- (Array) <strong>validate</strong> </a>
176
-
177
-
178
-
179
- </span>
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
- <span class="summary_desc"><div class='inline'><p>
189
- Validate all parts of the package against xsd schema.
190
- </p>
191
- </div></span>
192
-
193
- </li>
194
-
195
-
196
- <li class="public ">
197
- <span class="summary_signature">
198
-
199
- <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> {|@workbook| ... }</a>
200
-
201
-
202
-
203
- </span>
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
- <span class="summary_desc"><div class='inline'><p>
213
- The workbook this package will serialize or validate.
214
- </p>
215
- </div></span>
216
-
217
- </li>
218
-
219
-
220
- <li class="public ">
221
- <span class="summary_signature">
222
-
223
- <a href="#workbook%3D-instance_method" title="#workbook= (instance method)">- (Object) <strong>workbook=</strong>(workbook) </a>
224
-
225
-
226
-
227
- </span>
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
- <span class="summary_desc"><div class='inline'></div></span>
237
-
238
- </li>
239
-
240
-
241
- </ul>
242
-
243
-
244
- <div id="constructor_details" class="method_details_list">
245
- <h2>Constructor Details</h2>
246
-
247
- <div class="method_details first">
248
- <p class="signature first" id="initialize-instance_method">
249
-
250
- - (<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Package</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... }
251
-
252
-
253
-
254
- </p><div class="docstring">
255
- <div class="discussion">
256
- <p>
257
- Initializes your package
258
- </p>
259
-
260
-
261
- </div>
262
- </div>
263
- <div class="tags">
264
-
265
- <div class="examples">
266
- <h3>Examples:</h3>
267
-
268
- <h4><div class='inline'><p>
269
- Package.new :author =&gt; &#8216;you!&#8217;, :workbook =&gt; Workbook.new
270
- </p>
271
- </div></h4>
272
- <pre class="example code">
273
- </pre>
274
-
275
- </div>
276
- <h3>Parameters:</h3>
277
- <ul class="param">
278
-
279
- <li>
280
-
281
- <span class='name'>options</span>
282
-
283
-
284
- <span class='type'>(<tt>Hash</tt>)</span>
285
-
286
-
287
- <em class="default">(defaults to: <tt>{}</tt>)</em>
288
-
289
-
290
- &mdash;
291
- <div class='inline'><p>
292
- A hash that you can use to specify the author and workbook for this
293
- package.
294
- </p>
295
- </div>
296
-
297
- </li>
298
-
299
- </ul>
300
-
301
-
302
-
303
-
304
- <h3>Options Hash (<tt>options</tt>):</h3>
305
- <ul class="option">
306
-
307
- <li>
308
- <span class="name">:author</span>
309
- <span class="type">(<tt>String</tt>)</span>
310
- <span class="default">
311
-
312
- </span>
313
- &mdash; <div class='inline'><p>
314
- The author of the document
315
- </p>
316
- </div>
317
- </li>
318
-
319
- </ul>
320
-
321
-
322
- <h3>Yields:</h3>
323
- <ul class="yield">
324
-
325
- <li>
326
-
327
-
328
- <span class='type'>(<tt>_self</tt>)</span>
329
-
330
-
331
-
332
- </li>
333
-
334
- </ul>
335
- <h3>Yield Parameters:</h3>
336
- <ul class="yieldparam">
337
-
338
- <li>
339
-
340
- <span class='name'>_self</span>
341
-
342
-
343
- <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Axlsx::Package</a></span></tt>)</span>
344
-
345
-
346
-
347
- &mdash;
348
- <div class='inline'><p>
349
- the object that the method was called on
350
- </p>
351
- </div>
352
-
353
- </li>
354
-
355
- </ul>
356
-
357
- </div><table class="source_code">
358
- <tr>
359
- <td>
360
- <pre class="lines">
361
-
362
-
363
- 12
364
- 13
365
- 14
366
- 15
367
- 16
368
- 17</pre>
369
- </td>
370
- <td>
371
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 12</span>
372
-
373
- <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>
374
- <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span>
375
- <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>
376
- <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>
377
- <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>
378
- <span class='end end kw'>end</span>
379
- </pre>
380
- </td>
381
- </tr>
382
- </table>
383
- </div>
384
-
385
- </div>
386
-
387
-
388
- <div id="instance_method_details" class="method_details_list">
389
- <h2>Instance Method Details</h2>
390
-
391
-
392
- <div class="method_details first">
393
- <p class="signature first" id="serialize-instance_method">
394
-
395
- - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false)
396
-
397
-
398
-
399
- </p><div class="docstring">
400
- <div class="discussion">
401
-
402
- <div class="note notetag">
403
- <strong>Note:</strong>
404
- <div class='inline'><p>
405
- A tremendous amount of effort has gone into ensuring that you cannot create
406
- invalid xlsx documents. confirm_valid should be used in the rare case that
407
- you cannot open the serialized file.
408
- </p>
409
- </div>
410
- </div>
411
-
412
- <p>
413
- Serialize your workbook to disk as an xlsx document.
414
- </p>
415
-
416
-
417
- </div>
418
- </div>
419
- <div class="tags">
420
-
421
- <div class="examples">
422
- <h3>Examples:</h3>
423
-
424
- <h4><div class='inline'></div></h4>
425
- <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>
426
- <span class='comment val'># Take a look at the README for an example of how to do it!</span>
427
- <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>
428
- <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>
429
-
430
- <span class='comment val'># You will find a file called test.xlsx</span>
431
- </pre>
432
-
433
- </div>
434
- <h3>Parameters:</h3>
435
- <ul class="param">
436
-
437
- <li>
438
-
439
- <span class='name'>output</span>
440
-
441
-
442
- <span class='type'>(<tt>File</tt>)</span>
443
-
444
-
445
-
446
- &mdash;
447
- <div class='inline'><p>
448
- The file you want to serialize your package to
449
- </p>
450
- </div>
451
-
452
- </li>
453
-
454
- <li>
455
-
456
- <span class='name'>confirm_valid</span>
457
-
458
-
459
- <span class='type'>(<tt>Boolean</tt>)</span>
460
-
461
-
462
- <em class="default">(defaults to: <tt>false</tt>)</em>
463
-
464
-
465
- &mdash;
466
- <div class='inline'><p>
467
- Validate the package prior to serialization.
468
- </p>
469
- </div>
470
-
471
- </li>
472
-
473
- </ul>
474
-
475
- <h3>Returns:</h3>
476
- <ul class="return">
477
-
478
- <li>
479
-
480
-
481
- <span class='type'>(<tt>Boolean</tt>)</span>
482
-
483
-
484
-
485
- &mdash;
486
- <div class='inline'><p>
487
- False if confirm_valid and validation errors exist. True if the package was
488
- serialized
489
- </p>
490
- </div>
491
-
492
- </li>
493
-
494
- </ul>
495
-
496
- <h3>See Also:</h3>
497
- <ul class="see">
498
-
499
- <li><span class='object_link'><a href="#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span></li>
500
-
501
- </ul>
502
-
503
- </div><table class="source_code">
504
- <tr>
505
- <td>
506
- <pre class="lines">
507
-
508
-
509
- 62
510
- 63
511
- 64
512
- 65
513
- 66
514
- 67
515
- 68
516
- 69
517
- 70
518
- 71
519
- 72
520
- 73
521
- 74
522
- 75
523
- 76
524
- 77
525
- 78
526
- 79</pre>
527
- </td>
528
- <td>
529
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 62</span>
530
-
531
- <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>
532
- <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>
533
- <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='parts identifier id'>parts</span>
534
- <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>
535
- <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>
536
- <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>
537
- <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>
538
- <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>
539
- <span class='end end kw'>end</span>
540
- <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>
541
- <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>
542
- <span class='comment val'># binread for 1.9.3</span>
543
- <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>
544
- <span class='end end kw'>end</span>
545
- <span class='end end kw'>end</span>
546
- <span class='end end kw'>end</span>
547
- <span class='true true kw'>true</span>
548
- <span class='end end kw'>end</span>
549
- </pre>
550
- </td>
551
- </tr>
552
- </table>
553
- </div>
554
-
555
- <div class="method_details ">
556
- <p class="signature " id="validate-instance_method">
557
-
558
- - (<tt>Array</tt>) <strong>validate</strong>
559
-
560
-
561
-
562
- </p><div class="docstring">
563
- <div class="discussion">
564
-
565
- <div class="note notetag">
566
- <strong>Note:</strong>
567
- <div class='inline'><p>
568
- This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
569
- and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition.
570
- opc schema require an internet connection to import remote schema from
571
- dublin core for dc, dcterms and xml namespaces. Those remote schema are
572
- included in this gem, and the original files have been altered to refer to
573
- the local versions.
574
- </p>
575
- <p>
576
- If by chance you are able to creat a package that does not validate it
577
- indicates that the internal validation is not robust enough and needs to be
578
- improved. Please report your errors to the gem author.
579
- </p>
580
- </div>
581
- </div>
582
-
583
- <p>
584
- Validate all parts of the package against xsd schema.
585
- </p>
586
-
587
-
588
- </div>
589
- </div>
590
- <div class="tags">
591
-
592
- <div class="examples">
593
- <h3>Examples:</h3>
594
-
595
- <h4><div class='inline'></div></h4>
596
- <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span>
597
- <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>
598
- <span class='comment val'># ... code to create sheets, charts, styles etc.</span>
599
- <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>
600
- </pre>
601
-
602
- </div>
603
-
604
- <h3>Returns:</h3>
605
- <ul class="return">
606
-
607
- <li>
608
-
609
-
610
- <span class='type'>(<tt>Array</tt>)</span>
611
-
612
-
613
-
614
- &mdash;
615
- <div class='inline'><p>
616
- An array of all validation errors found.
617
- </p>
618
- </div>
619
-
620
- </li>
621
-
622
- </ul>
623
-
624
- <h3>See Also:</h3>
625
- <ul class="see">
626
-
627
- <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>
628
-
629
- </ul>
630
-
631
- </div><table class="source_code">
632
- <tr>
633
- <td>
634
- <pre class="lines">
635
-
636
-
637
- 97
638
- 98
639
- 99
640
- 100
641
- 101</pre>
642
- </td>
643
- <td>
644
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 97</span>
645
-
646
- <span class='def def kw'>def</span> <span class='validate identifier id'>validate</span>
647
- <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
648
- <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>
649
- <span class='errors identifier id'>errors</span>
650
- <span class='end end kw'>end</span>
651
- </pre>
652
- </td>
653
- </tr>
654
- </table>
655
- </div>
656
-
657
- <div class="method_details ">
658
- <p class="signature " id="workbook-instance_method">
659
-
660
- - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> {|@workbook| ... }
661
-
662
-
663
-
664
- </p><div class="docstring">
665
- <div class="discussion">
666
-
667
- <div class="note notetag">
668
- <strong>Note:</strong>
669
- <div class='inline'><p>
670
- As there are multiple ways to instantiate a workbook for the package, here
671
- are a few examples:
672
- </p>
673
- <pre class="code">
674
- <span class='comment val'># assign directly during package instanciation</span>
675
- <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>
676
-
677
- <span class='comment val'># get a fresh workbook automatically from the package</span>
678
- <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>
679
- <span class='comment val'># # set the workbook after creating the package</span>
680
- <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>
681
- </pre>
682
- </div>
683
- </div>
684
-
685
- <p>
686
- The workbook this package will serialize or validate.
687
- </p>
688
-
689
-
690
- </div>
691
- </div>
692
- <div class="tags">
693
-
694
- <h3>Yields:</h3>
695
- <ul class="yield">
696
-
697
- <li>
698
-
699
-
700
- <span class='type'>(<tt>@workbook</tt>)</span>
701
-
702
-
703
-
704
- </li>
705
-
706
- </ul>
707
- <h3>Returns:</h3>
708
- <ul class="return">
709
-
710
- <li>
711
-
712
-
713
- <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span>
714
-
715
-
716
-
717
- &mdash;
718
- <div class='inline'><p>
719
- If no workbook instance has been assigned with this package a new Workbook
720
- instance is returned.
721
- </p>
722
- </div>
723
-
724
- </li>
725
-
726
- </ul>
727
- <h3>Raises:</h3>
728
- <ul class="raise">
729
-
730
- <li>
731
-
732
-
733
- <span class='type'></span>
734
-
735
-
736
-
737
-
738
- <div class='inline'><p>
739
- ArgumentError if workbook parameter is not a Workbook instance.
740
- </p>
741
- </div>
742
-
743
- </li>
744
-
745
- </ul>
746
-
747
- </div><table class="source_code">
748
- <tr>
749
- <td>
750
- <pre class="lines">
751
-
752
-
753
- 31
754
- 32
755
- 33
756
- 34
757
- 35</pre>
758
- </td>
759
- <td>
760
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 31</span>
761
-
762
- <span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span>
763
- <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>
764
- <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>
765
- <span class='@workbook ivar id'>@workbook</span>
766
- <span class='end end kw'>end</span>
767
- </pre>
768
- </td>
769
- </tr>
770
- </table>
771
- </div>
772
-
773
- <div class="method_details ">
774
- <p class="signature " id="workbook=-instance_method">
775
-
776
- - (<tt>Object</tt>) <strong>workbook=</strong>(workbook)
777
-
778
-
779
-
780
- </p><div class="docstring">
781
- <div class="discussion">
782
-
783
-
784
- </div>
785
- </div>
786
- <div class="tags">
787
-
788
-
789
- <h3>See Also:</h3>
790
- <ul class="see">
791
-
792
- <li>workbook</li>
793
-
794
- </ul>
795
-
796
- </div><table class="source_code">
797
- <tr>
798
- <td>
799
- <pre class="lines">
800
-
801
-
802
- 45</pre>
803
- </td>
804
- <td>
805
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 45</span>
806
-
807
- <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>
808
- </pre>
809
- </td>
810
- </tr>
811
- </table>
812
- </div>
813
-
814
- </div>
815
-
816
- </div>
817
-
818
- <div id="footer">
819
- Generated on Mon Dec 5 14:21:15 2011 by
820
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
821
- 0.7.3 (ruby-1.8.7).
822
- </div>
823
-
824
- </body>
825
- </html>