axlsx 1.0.8 → 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGELOG.md +14 -0
- data/README.md +22 -21
- data/Rakefile +1 -1
- data/axlsx.gemspec +36 -0
- data/doc/Axlsx.html +373 -559
- data/doc/Axlsx/App.html +257 -360
- data/doc/Axlsx/Axis.html +113 -144
- data/doc/Axlsx/Bar3DChart.html +122 -152
- data/doc/Axlsx/BarSeries.html +67 -81
- data/doc/Axlsx/Border.html +96 -119
- data/doc/Axlsx/BorderPr.html +89 -114
- data/doc/Axlsx/CatAxis.html +79 -104
- data/doc/Axlsx/CatAxisData.html +40 -54
- data/doc/Axlsx/Cell.html +193 -679
- data/doc/Axlsx/CellAlignment.html +116 -157
- data/doc/Axlsx/CellProtection.html +50 -68
- data/doc/Axlsx/CellStyle.html +78 -106
- data/doc/Axlsx/Chart.html +361 -432
- data/doc/Axlsx/Color.html +56 -78
- data/doc/Axlsx/ContentType.html +28 -41
- data/doc/Axlsx/Core.html +43 -55
- data/doc/Axlsx/DataTypeValidator.html +34 -43
- data/doc/Axlsx/Default.html +55 -81
- data/doc/Axlsx/Drawing.html +322 -412
- data/doc/Axlsx/Fill.html +34 -47
- data/doc/Axlsx/Font.html +157 -207
- data/doc/Axlsx/GradientFill.html +90 -122
- data/doc/Axlsx/GradientStop.html +36 -50
- data/doc/Axlsx/GraphicFrame.html +106 -130
- data/doc/Axlsx/Line3DChart.html +108 -134
- data/doc/Axlsx/LineSeries.html +58 -67
- data/doc/Axlsx/Marker.html +84 -111
- data/doc/Axlsx/NumFmt.html +83 -102
- data/doc/Axlsx/OneCellAnchor.html +158 -196
- data/doc/Axlsx/Override.html +60 -92
- data/doc/Axlsx/Package.html +190 -759
- data/doc/Axlsx/PatternFill.html +78 -99
- data/doc/Axlsx/Pic.html +451 -405
- data/doc/Axlsx/Pie3DChart.html +33 -42
- data/doc/Axlsx/PieSeries.html +68 -80
- data/doc/Axlsx/RegexValidator.html +15 -20
- data/doc/Axlsx/Relationship.html +49 -66
- data/doc/Axlsx/Relationships.html +28 -41
- data/doc/Axlsx/RestrictionValidator.html +23 -32
- data/doc/Axlsx/Row.html +132 -161
- data/doc/Axlsx/Scaling.html +71 -90
- data/doc/Axlsx/SerAxis.html +61 -79
- data/doc/Axlsx/Series.html +125 -201
- data/doc/Axlsx/SeriesTitle.html +26 -31
- data/doc/Axlsx/Styles.html +286 -355
- data/doc/Axlsx/TableStyle.html +62 -87
- data/doc/Axlsx/TableStyleElement.html +84 -104
- data/doc/Axlsx/TableStyles.html +59 -82
- data/doc/Axlsx/Title.html +58 -155
- data/doc/Axlsx/TwoCellAnchor.html +165 -204
- data/doc/Axlsx/ValAxis.html +39 -53
- data/doc/Axlsx/ValAxisData.html +29 -39
- data/doc/Axlsx/View3D.html +93 -122
- data/doc/Axlsx/Workbook.html +359 -362
- data/doc/Axlsx/Worksheet.html +471 -816
- data/doc/Axlsx/Xf.html +341 -296
- data/doc/_index.html +7 -11
- data/doc/class_list.html +1 -1
- data/doc/file.LICENSE.html +86 -0
- data/doc/file.README.html +105 -107
- data/doc/file_list.html +3 -0
- data/doc/frames.html +1 -1
- data/doc/index.html +105 -107
- data/doc/method_list.html +426 -602
- data/doc/top-level-namespace.html +3 -3
- data/examples/example.rb +20 -1
- data/lib/axlsx.rb +20 -15
- data/lib/axlsx/content_type/default.rb +8 -3
- data/lib/axlsx/content_type/override.rb +11 -4
- data/lib/axlsx/doc_props/app.rb +53 -23
- data/lib/axlsx/drawing/axis.rb +16 -5
- data/lib/axlsx/drawing/bar_3D_chart.rb +15 -7
- data/lib/axlsx/drawing/bar_series.rb +7 -5
- data/lib/axlsx/drawing/cat_axis.rb +10 -3
- data/lib/axlsx/drawing/chart.rb +21 -15
- data/lib/axlsx/drawing/drawing.rb +16 -30
- data/lib/axlsx/drawing/graphic_frame.rb +2 -4
- data/lib/axlsx/drawing/line_3D_chart.rb +5 -2
- data/lib/axlsx/drawing/line_series.rb +6 -5
- data/lib/axlsx/drawing/marker.rb +9 -5
- data/lib/axlsx/drawing/one_cell_anchor.rb +7 -7
- data/lib/axlsx/drawing/pic.rb +29 -37
- data/lib/axlsx/drawing/pie_series.rb +7 -5
- data/lib/axlsx/drawing/scaling.rb +11 -5
- data/lib/axlsx/drawing/ser_axis.rb +6 -2
- data/lib/axlsx/drawing/series.rb +11 -11
- data/lib/axlsx/drawing/series_title.rb +1 -1
- data/lib/axlsx/drawing/title.rb +5 -12
- data/lib/axlsx/drawing/two_cell_anchor.rb +2 -3
- data/lib/axlsx/drawing/val_axis.rb +2 -2
- data/lib/axlsx/drawing/view_3D.rb +16 -9
- data/lib/axlsx/package.rb +25 -27
- data/lib/axlsx/rels/relationship.rb +4 -2
- data/lib/axlsx/stylesheet/border.rb +9 -4
- data/lib/axlsx/stylesheet/border_pr.rb +7 -4
- data/lib/axlsx/stylesheet/cell_alignment.rb +18 -9
- data/lib/axlsx/stylesheet/cell_protection.rb +5 -2
- data/lib/axlsx/stylesheet/cell_style.rb +12 -7
- data/lib/axlsx/stylesheet/color.rb +8 -6
- data/lib/axlsx/stylesheet/fill.rb +2 -1
- data/lib/axlsx/stylesheet/font.rb +24 -13
- data/lib/axlsx/stylesheet/gradient_fill.rb +16 -10
- data/lib/axlsx/stylesheet/gradient_stop.rb +5 -3
- data/lib/axlsx/stylesheet/num_fmt.rb +4 -2
- data/lib/axlsx/stylesheet/pattern_fill.rb +6 -4
- data/lib/axlsx/stylesheet/styles.rb +12 -12
- data/lib/axlsx/stylesheet/table_style.rb +6 -3
- data/lib/axlsx/stylesheet/table_style_element.rb +9 -4
- data/lib/axlsx/stylesheet/table_styles.rb +4 -4
- data/lib/axlsx/stylesheet/xf.rb +52 -31
- data/lib/axlsx/util/validators.rb +3 -3
- data/lib/axlsx/version.rb +1 -1
- data/lib/axlsx/workbook/workbook.rb +8 -9
- data/lib/axlsx/workbook/worksheet/cell.rb +25 -16
- data/lib/axlsx/workbook/worksheet/row.rb +2 -4
- data/lib/axlsx/workbook/worksheet/worksheet.rb +23 -32
- data/test/drawing/tc_one_cell_anchor.rb +1 -1
- metadata +135 -165
- data/doc/Axlsx/SimpleTypedList.html +0 -1686
- data/lib/schema/dc.xsd~ +0 -118
- data/lib/schema/dcterms.xsd~ +0 -331
- data/lib/schema/opc-coreProperties.xsd~ +0 -50
- data/test/drawing/tc_line_series.tc~ +0 -34
data/doc/Axlsx/Override.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: Axlsx::Override
|
|
8
8
|
|
|
9
|
-
—
|
|
9
|
+
— AXLSX
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -94,10 +94,9 @@
|
|
|
94
94
|
|
|
95
95
|
<h2>Overview</h2><div class="docstring">
|
|
96
96
|
<div class="discussion">
|
|
97
|
-
|
|
98
|
-
An override content part. These parts are automatically created by for you
|
|
99
|
-
based on the content of your package
|
|
100
|
-
</p>
|
|
97
|
+
|
|
98
|
+
<p>An override content part. These parts are automatically created by for you
|
|
99
|
+
based on the content of your package.</p>
|
|
101
100
|
|
|
102
101
|
|
|
103
102
|
</div>
|
|
@@ -129,9 +128,8 @@ based on the content of your package.
|
|
|
129
128
|
|
|
130
129
|
|
|
131
130
|
|
|
132
|
-
<span class="summary_desc"><div class='inline'
|
|
133
|
-
|
|
134
|
-
</p>
|
|
131
|
+
<span class="summary_desc"><div class='inline'>
|
|
132
|
+
<p>The type of content.</p>
|
|
135
133
|
</div></span>
|
|
136
134
|
|
|
137
135
|
</li>
|
|
@@ -156,9 +154,8 @@ ContentType The type of content.
|
|
|
156
154
|
|
|
157
155
|
|
|
158
156
|
|
|
159
|
-
<span class="summary_desc"><div class='inline'
|
|
160
|
-
|
|
161
|
-
</p>
|
|
157
|
+
<span class="summary_desc"><div class='inline'>
|
|
158
|
+
<p>The name and location of the part.</p>
|
|
162
159
|
</div></span>
|
|
163
160
|
|
|
164
161
|
</li>
|
|
@@ -195,9 +192,8 @@ PartName The name and location of the part.
|
|
|
195
192
|
|
|
196
193
|
|
|
197
194
|
|
|
198
|
-
<span class="summary_desc"><div class='inline'
|
|
199
|
-
Creates a new Override object
|
|
200
|
-
</p>
|
|
195
|
+
<span class="summary_desc"><div class='inline'>
|
|
196
|
+
<p>Creates a new Override object.</p>
|
|
201
197
|
</div></span>
|
|
202
198
|
|
|
203
199
|
</li>
|
|
@@ -219,9 +215,8 @@ Creates a new Override object.
|
|
|
219
215
|
|
|
220
216
|
|
|
221
217
|
|
|
222
|
-
<span class="summary_desc"><div class='inline'
|
|
223
|
-
Serializes the Override object to xml
|
|
224
|
-
</p>
|
|
218
|
+
<span class="summary_desc"><div class='inline'>
|
|
219
|
+
<p>Serializes the Override object to xml.</p>
|
|
225
220
|
</div></span>
|
|
226
221
|
|
|
227
222
|
</li>
|
|
@@ -242,9 +237,8 @@ Serializes the Override object to xml.
|
|
|
242
237
|
|
|
243
238
|
</p><div class="docstring">
|
|
244
239
|
<div class="discussion">
|
|
245
|
-
|
|
246
|
-
Creates a new Override object
|
|
247
|
-
</p>
|
|
240
|
+
|
|
241
|
+
<p>Creates a new Override object</p>
|
|
248
242
|
|
|
249
243
|
|
|
250
244
|
</div>
|
|
@@ -265,9 +259,8 @@ Creates a new Override object
|
|
|
265
259
|
|
|
266
260
|
|
|
267
261
|
—
|
|
268
|
-
<div class='inline'
|
|
269
|
-
a customizable set of options
|
|
270
|
-
</p>
|
|
262
|
+
<div class='inline'>
|
|
263
|
+
<p>a customizable set of options</p>
|
|
271
264
|
</div>
|
|
272
265
|
|
|
273
266
|
</li>
|
|
@@ -312,10 +305,9 @@ a customizable set of options
|
|
|
312
305
|
|
|
313
306
|
|
|
314
307
|
—
|
|
315
|
-
<div class='inline'
|
|
316
|
-
An argument error is raised if both PartName and ContentType are not
|
|
317
|
-
specified
|
|
318
|
-
</p>
|
|
308
|
+
<div class='inline'>
|
|
309
|
+
<p>An argument error is raised if both PartName and ContentType are not
|
|
310
|
+
specified.</p>
|
|
319
311
|
</div>
|
|
320
312
|
|
|
321
313
|
</li>
|
|
@@ -328,23 +320,22 @@ specified.
|
|
|
328
320
|
<pre class="lines">
|
|
329
321
|
|
|
330
322
|
|
|
331
|
-
15
|
|
332
|
-
16
|
|
333
323
|
17
|
|
334
324
|
18
|
|
335
325
|
19
|
|
336
|
-
20
|
|
326
|
+
20
|
|
327
|
+
21
|
|
328
|
+
22</pre>
|
|
337
329
|
</td>
|
|
338
330
|
<td>
|
|
339
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line
|
|
340
|
-
|
|
341
|
-
<span class='
|
|
342
|
-
<span class='raise
|
|
343
|
-
<span class='options
|
|
344
|
-
<span class='
|
|
345
|
-
<span class='
|
|
346
|
-
<span class='
|
|
347
|
-
</pre>
|
|
331
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 17</span>
|
|
332
|
+
|
|
333
|
+
<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
334
|
+
<span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PartName and ContentType are required</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:PartName</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ContentType</span><span class='rbracket'>]</span>
|
|
335
|
+
<span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span>
|
|
336
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span>
|
|
337
|
+
<span class='kw'>end</span>
|
|
338
|
+
<span class='kw'>end</span></pre>
|
|
348
339
|
</td>
|
|
349
340
|
</tr>
|
|
350
341
|
</table>
|
|
@@ -367,11 +358,8 @@ specified.
|
|
|
367
358
|
|
|
368
359
|
</p><div class="docstring">
|
|
369
360
|
<div class="discussion">
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT,
|
|
373
|
-
DRAWING_CT are allowed
|
|
374
|
-
</p>
|
|
361
|
+
|
|
362
|
+
<p>The type of content.</p>
|
|
375
363
|
|
|
376
364
|
|
|
377
365
|
</div>
|
|
@@ -388,14 +376,6 @@ DRAWING_CT are allowed
|
|
|
388
376
|
|
|
389
377
|
|
|
390
378
|
|
|
391
|
-
—
|
|
392
|
-
<div class='inline'><p>
|
|
393
|
-
ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT,
|
|
394
|
-
STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT,
|
|
395
|
-
DRAWING_CT are allowed
|
|
396
|
-
</p>
|
|
397
|
-
</div>
|
|
398
|
-
|
|
399
379
|
</li>
|
|
400
380
|
|
|
401
381
|
</ul>
|
|
@@ -406,17 +386,16 @@ DRAWING_CT are allowed
|
|
|
406
386
|
<pre class="lines">
|
|
407
387
|
|
|
408
388
|
|
|
409
|
-
6
|
|
410
389
|
7
|
|
411
|
-
8
|
|
390
|
+
8
|
|
391
|
+
9</pre>
|
|
412
392
|
</td>
|
|
413
393
|
<td>
|
|
414
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line
|
|
394
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 7</span>
|
|
415
395
|
|
|
416
|
-
<span class='
|
|
417
|
-
<span class='
|
|
418
|
-
<span class='
|
|
419
|
-
</pre>
|
|
396
|
+
<span class='kw'>def</span> <span class='const'>ContentType</span>
|
|
397
|
+
<span class='ivar'>@ContentType</span>
|
|
398
|
+
<span class='kw'>end</span></pre>
|
|
420
399
|
</td>
|
|
421
400
|
</tr>
|
|
422
401
|
</table>
|
|
@@ -434,9 +413,8 @@ DRAWING_CT are allowed
|
|
|
434
413
|
|
|
435
414
|
</p><div class="docstring">
|
|
436
415
|
<div class="discussion">
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
</p>
|
|
416
|
+
|
|
417
|
+
<p>The name and location of the part.</p>
|
|
440
418
|
|
|
441
419
|
|
|
442
420
|
</div>
|
|
@@ -453,12 +431,6 @@ PartName The name and location of the part.
|
|
|
453
431
|
|
|
454
432
|
|
|
455
433
|
|
|
456
|
-
—
|
|
457
|
-
<div class='inline'><p>
|
|
458
|
-
PartName The name and location of the part.
|
|
459
|
-
</p>
|
|
460
|
-
</div>
|
|
461
|
-
|
|
462
434
|
</li>
|
|
463
435
|
|
|
464
436
|
</ul>
|
|
@@ -469,17 +441,16 @@ PartName The name and location of the part.
|
|
|
469
441
|
<pre class="lines">
|
|
470
442
|
|
|
471
443
|
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
444
|
+
11
|
|
445
|
+
12
|
|
446
|
+
13</pre>
|
|
475
447
|
</td>
|
|
476
448
|
<td>
|
|
477
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line
|
|
449
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 11</span>
|
|
478
450
|
|
|
479
|
-
<span class='
|
|
480
|
-
<span class='
|
|
481
|
-
<span class='
|
|
482
|
-
</pre>
|
|
451
|
+
<span class='kw'>def</span> <span class='const'>PartName</span>
|
|
452
|
+
<span class='ivar'>@PartName</span>
|
|
453
|
+
<span class='kw'>end</span></pre>
|
|
483
454
|
</td>
|
|
484
455
|
</tr>
|
|
485
456
|
</table>
|
|
@@ -501,9 +472,8 @@ PartName The name and location of the part.
|
|
|
501
472
|
|
|
502
473
|
</p><div class="docstring">
|
|
503
474
|
<div class="discussion">
|
|
504
|
-
|
|
505
|
-
Serializes the Override object to xml
|
|
506
|
-
</p>
|
|
475
|
+
|
|
476
|
+
<p>Serializes the Override object to xml</p>
|
|
507
477
|
|
|
508
478
|
|
|
509
479
|
</div>
|
|
@@ -522,9 +492,8 @@ Serializes the Override object to xml
|
|
|
522
492
|
|
|
523
493
|
|
|
524
494
|
—
|
|
525
|
-
<div class='inline'
|
|
526
|
-
The document builder instance this objects xml will be added to
|
|
527
|
-
</p>
|
|
495
|
+
<div class='inline'>
|
|
496
|
+
<p>The document builder instance this objects xml will be added to.</p>
|
|
528
497
|
</div>
|
|
529
498
|
|
|
530
499
|
</li>
|
|
@@ -538,17 +507,16 @@ The document builder instance this objects xml will be added to.
|
|
|
538
507
|
<pre class="lines">
|
|
539
508
|
|
|
540
509
|
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
510
|
+
33
|
|
511
|
+
34
|
|
512
|
+
35</pre>
|
|
544
513
|
</td>
|
|
545
514
|
<td>
|
|
546
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line
|
|
515
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 33</span>
|
|
547
516
|
|
|
548
|
-
<span class='
|
|
549
|
-
<span class='xml
|
|
550
|
-
<span class='
|
|
551
|
-
</pre>
|
|
517
|
+
<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span>
|
|
518
|
+
<span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Override</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span>
|
|
519
|
+
<span class='kw'>end</span></pre>
|
|
552
520
|
</td>
|
|
553
521
|
</tr>
|
|
554
522
|
</table>
|
|
@@ -559,9 +527,9 @@ The document builder instance this objects xml will be added to.
|
|
|
559
527
|
</div>
|
|
560
528
|
|
|
561
529
|
<div id="footer">
|
|
562
|
-
Generated on
|
|
530
|
+
Generated on Sat Nov 26 13:16:39 2011 by
|
|
563
531
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
564
|
-
0.7.3 (ruby-1.
|
|
532
|
+
0.7.3 (ruby-1.9.3).
|
|
565
533
|
</div>
|
|
566
534
|
|
|
567
535
|
</body>
|
data/doc/Axlsx/Package.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: Axlsx::Package
|
|
8
8
|
|
|
9
|
-
—
|
|
9
|
+
— AXLSX
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -94,11 +94,10 @@
|
|
|
94
94
|
|
|
95
95
|
<h2>Overview</h2><div class="docstring">
|
|
96
96
|
<div class="discussion">
|
|
97
|
-
|
|
98
|
-
Package is responsible for managing all the bits and peices that Open
|
|
97
|
+
|
|
98
|
+
<p>Package is responsible for managing all the bits and peices that Open
|
|
99
99
|
Office XML requires to make a valid xlsx document including valdation and
|
|
100
|
-
serialization
|
|
101
|
-
</p>
|
|
100
|
+
serialization.</p>
|
|
102
101
|
|
|
103
102
|
|
|
104
103
|
</div>
|
|
@@ -108,38 +107,6 @@ serialization.
|
|
|
108
107
|
|
|
109
108
|
</div>
|
|
110
109
|
|
|
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
110
|
|
|
144
111
|
|
|
145
112
|
|
|
@@ -154,55 +121,6 @@ The workbook this package will serialize or validate.
|
|
|
154
121
|
<li class="public ">
|
|
155
122
|
<span class="summary_signature">
|
|
156
123
|
|
|
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
124
|
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Package) <strong>initialize</strong>(options = {}) {|_self| ... }</a>
|
|
207
125
|
|
|
208
126
|
|
|
@@ -218,33 +136,8 @@ your workbook to the default content types.
|
|
|
218
136
|
|
|
219
137
|
|
|
220
138
|
|
|
221
|
-
<span class="summary_desc"><div class='inline'
|
|
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>
|
|
139
|
+
<span class="summary_desc"><div class='inline'>
|
|
140
|
+
<p>Initializes your package.</p>
|
|
248
141
|
</div></span>
|
|
249
142
|
|
|
250
143
|
</li>
|
|
@@ -253,7 +146,7 @@ The parts of a package.
|
|
|
253
146
|
<li class="public ">
|
|
254
147
|
<span class="summary_signature">
|
|
255
148
|
|
|
256
|
-
<a href="#
|
|
149
|
+
<a href="#serialize-instance_method" title="#serialize (instance method)">- (Boolean) <strong>serialize</strong>(output, confirm_valid = false) </a>
|
|
257
150
|
|
|
258
151
|
|
|
259
152
|
|
|
@@ -266,9 +159,8 @@ The parts of a package.
|
|
|
266
159
|
|
|
267
160
|
|
|
268
161
|
|
|
269
|
-
<span class="summary_desc"><div class='inline'
|
|
270
|
-
|
|
271
|
-
</p>
|
|
162
|
+
<span class="summary_desc"><div class='inline'>
|
|
163
|
+
<p>Serialize your workbook to disk as an xlsx document.</p>
|
|
272
164
|
</div></span>
|
|
273
165
|
|
|
274
166
|
</li>
|
|
@@ -277,7 +169,7 @@ Creates the relationships required for a valid xlsx document.
|
|
|
277
169
|
<li class="public ">
|
|
278
170
|
<span class="summary_signature">
|
|
279
171
|
|
|
280
|
-
<a href="#
|
|
172
|
+
<a href="#validate-instance_method" title="#validate (instance method)">- (Array) <strong>validate</strong> </a>
|
|
281
173
|
|
|
282
174
|
|
|
283
175
|
|
|
@@ -290,9 +182,8 @@ Creates the relationships required for a valid xlsx document.
|
|
|
290
182
|
|
|
291
183
|
|
|
292
184
|
|
|
293
|
-
<span class="summary_desc"><div class='inline'
|
|
294
|
-
|
|
295
|
-
</p>
|
|
185
|
+
<span class="summary_desc"><div class='inline'>
|
|
186
|
+
<p>Validate all parts of the package against xsd schema.</p>
|
|
296
187
|
</div></span>
|
|
297
188
|
|
|
298
189
|
</li>
|
|
@@ -301,7 +192,7 @@ Serialize your workbook to disk as an xlsx document.
|
|
|
301
192
|
<li class="public ">
|
|
302
193
|
<span class="summary_signature">
|
|
303
194
|
|
|
304
|
-
<a href="#
|
|
195
|
+
<a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a>
|
|
305
196
|
|
|
306
197
|
|
|
307
198
|
|
|
@@ -314,9 +205,8 @@ Serialize your workbook to disk as an xlsx document.
|
|
|
314
205
|
|
|
315
206
|
|
|
316
207
|
|
|
317
|
-
<span class="summary_desc"><div class='inline'
|
|
318
|
-
|
|
319
|
-
</p>
|
|
208
|
+
<span class="summary_desc"><div class='inline'>
|
|
209
|
+
<p>The workbook this package will serialize or validate.</p>
|
|
320
210
|
</div></span>
|
|
321
211
|
|
|
322
212
|
</li>
|
|
@@ -325,7 +215,7 @@ Validate all parts of the package against xsd schema.
|
|
|
325
215
|
<li class="public ">
|
|
326
216
|
<span class="summary_signature">
|
|
327
217
|
|
|
328
|
-
<a href="#
|
|
218
|
+
<a href="#workbook%3D-instance_method" title="#workbook= (instance method)">- (Object) <strong>workbook=</strong>(workbook) </a>
|
|
329
219
|
|
|
330
220
|
|
|
331
221
|
|
|
@@ -338,10 +228,7 @@ Validate all parts of the package against xsd schema.
|
|
|
338
228
|
|
|
339
229
|
|
|
340
230
|
|
|
341
|
-
<span class="summary_desc"><div class='inline'
|
|
342
|
-
Performs xsd validation for a signle document.
|
|
343
|
-
</p>
|
|
344
|
-
</div></span>
|
|
231
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
345
232
|
|
|
346
233
|
</li>
|
|
347
234
|
|
|
@@ -361,9 +248,8 @@ Performs xsd validation for a signle document.
|
|
|
361
248
|
|
|
362
249
|
</p><div class="docstring">
|
|
363
250
|
<div class="discussion">
|
|
364
|
-
|
|
365
|
-
Initializes your package
|
|
366
|
-
</p>
|
|
251
|
+
|
|
252
|
+
<p>Initializes your package</p>
|
|
367
253
|
|
|
368
254
|
|
|
369
255
|
</div>
|
|
@@ -373,12 +259,10 @@ Initializes your package
|
|
|
373
259
|
<div class="examples">
|
|
374
260
|
<h3>Examples:</h3>
|
|
375
261
|
|
|
376
|
-
<h4><div class='inline'
|
|
377
|
-
Package.new :author =>
|
|
378
|
-
</p>
|
|
262
|
+
<h4><div class='inline'>
|
|
263
|
+
<p>Package.new :author => ‘you!’, :workbook => Workbook.new</p>
|
|
379
264
|
</div></h4>
|
|
380
|
-
<pre class="example code">
|
|
381
|
-
</pre>
|
|
265
|
+
<pre class="example code"></pre>
|
|
382
266
|
|
|
383
267
|
</div>
|
|
384
268
|
<h3>Parameters:</h3>
|
|
@@ -396,10 +280,9 @@ Package.new :author => ‘you!’, :workbook => Workbook.new
|
|
|
396
280
|
|
|
397
281
|
|
|
398
282
|
—
|
|
399
|
-
<div class='inline'
|
|
400
|
-
A hash that you can use to specify the author and workbook for this
|
|
401
|
-
package
|
|
402
|
-
</p>
|
|
283
|
+
<div class='inline'>
|
|
284
|
+
<p>A hash that you can use to specify the author and workbook for this
|
|
285
|
+
package.</p>
|
|
403
286
|
</div>
|
|
404
287
|
|
|
405
288
|
</li>
|
|
@@ -418,9 +301,8 @@ package.
|
|
|
418
301
|
<span class="default">
|
|
419
302
|
|
|
420
303
|
</span>
|
|
421
|
-
— <div class='inline'
|
|
422
|
-
The author of the document
|
|
423
|
-
</p>
|
|
304
|
+
— <div class='inline'>
|
|
305
|
+
<p>The author of the document</p>
|
|
424
306
|
</div>
|
|
425
307
|
</li>
|
|
426
308
|
|
|
@@ -453,9 +335,8 @@ The author of the document
|
|
|
453
335
|
|
|
454
336
|
|
|
455
337
|
—
|
|
456
|
-
<div class='inline'
|
|
457
|
-
the object that the method was called on
|
|
458
|
-
</p>
|
|
338
|
+
<div class='inline'>
|
|
339
|
+
<p>the object that the method was called on</p>
|
|
459
340
|
</div>
|
|
460
341
|
|
|
461
342
|
</li>
|
|
@@ -468,21 +349,22 @@ the object that the method was called on
|
|
|
468
349
|
<pre class="lines">
|
|
469
350
|
|
|
470
351
|
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
352
|
+
12
|
|
353
|
+
13
|
|
354
|
+
14
|
|
355
|
+
15
|
|
356
|
+
16
|
|
357
|
+
17</pre>
|
|
476
358
|
</td>
|
|
477
359
|
<td>
|
|
478
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line
|
|
479
|
-
|
|
480
|
-
<span class='
|
|
481
|
-
<span class='
|
|
482
|
-
<span class='
|
|
483
|
-
<span class='
|
|
484
|
-
<span class='
|
|
485
|
-
</pre>
|
|
360
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 12</span>
|
|
361
|
+
|
|
362
|
+
<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
363
|
+
<span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
364
|
+
<span class='ivar'>@core</span><span class='comma'>,</span> <span class='ivar'>@app</span> <span class='op'>=</span> <span class='const'>Core</span><span class='period'>.</span><span class='id new'>new</span><span class='comma'>,</span> <span class='const'>App</span><span class='period'>.</span><span class='id new'>new</span>
|
|
365
|
+
<span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:author</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span>
|
|
366
|
+
<span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
|
|
367
|
+
<span class='kw'>end</span></pre>
|
|
486
368
|
</td>
|
|
487
369
|
</tr>
|
|
488
370
|
</table>
|
|
@@ -490,470 +372,13 @@ the object that the method was called on
|
|
|
490
372
|
|
|
491
373
|
</div>
|
|
492
374
|
|
|
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'>></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
|
-
—
|
|
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
375
|
|
|
601
376
|
<div id="instance_method_details" class="method_details_list">
|
|
602
377
|
<h2>Instance Method Details</h2>
|
|
603
378
|
|
|
604
379
|
|
|
605
380
|
<div class="method_details first">
|
|
606
|
-
<p class="signature first" id="
|
|
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
|
-
182
|
|
644
|
-
183
|
|
645
|
-
184
|
|
646
|
-
185
|
|
647
|
-
186
|
|
648
|
-
187
|
|
649
|
-
188
|
|
650
|
-
189
|
|
651
|
-
190
|
|
652
|
-
191
|
|
653
|
-
192</pre>
|
|
654
|
-
</td>
|
|
655
|
-
<td>
|
|
656
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 182</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'><<</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'>></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'>></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'><<</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'>></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'>></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'><<</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'>></span> <span class='dstring node'>"/#{APP_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></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'><<</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'>></span> <span class='dstring node'>"/#{CORE_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></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'><<</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'>></span> <span class='dstring node'>"/xl/#{STYLES_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></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'><<</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'>></span> <span class='dstring node'>"/#{WORKBOOK_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></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
|
-
151
|
|
715
|
-
152
|
|
716
|
-
153
|
|
717
|
-
154
|
|
718
|
-
155
|
|
719
|
-
156
|
|
720
|
-
157
|
|
721
|
-
158
|
|
722
|
-
159
|
|
723
|
-
160
|
|
724
|
-
161
|
|
725
|
-
162
|
|
726
|
-
163
|
|
727
|
-
164
|
|
728
|
-
165
|
|
729
|
-
166
|
|
730
|
-
167
|
|
731
|
-
168
|
|
732
|
-
169
|
|
733
|
-
170
|
|
734
|
-
171
|
|
735
|
-
172
|
|
736
|
-
173
|
|
737
|
-
174
|
|
738
|
-
175
|
|
739
|
-
176
|
|
740
|
-
177</pre>
|
|
741
|
-
</td>
|
|
742
|
-
<td>
|
|
743
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 151</span>
|
|
744
|
-
|
|
745
|
-
<span class='def def kw'>def</span> <span class='content_types identifier id'>content_types</span>
|
|
746
|
-
<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>
|
|
747
|
-
<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>
|
|
748
|
-
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</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'>></span> <span class='dstring node'>"/xl/#{drawing.pn}"</span><span class='comma token'>,</span>
|
|
749
|
-
<span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='DRAWING_CT constant id'>DRAWING_CT</span><span class='rparen token'>)</span>
|
|
750
|
-
<span class='end end kw'>end</span>
|
|
751
|
-
<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>
|
|
752
|
-
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</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'>></span> <span class='dstring node'>"/xl/#{chart.pn}"</span><span class='comma token'>,</span>
|
|
753
|
-
<span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CHART_CT constant id'>CHART_CT</span><span class='rparen token'>)</span>
|
|
754
|
-
<span class='end end kw'>end</span>
|
|
755
|
-
<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>
|
|
756
|
-
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</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'>></span> <span class='dstring node'>"/xl/#{sheet.pn}"</span><span class='comma token'>,</span>
|
|
757
|
-
<span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKSHEET_CT constant id'>WORKSHEET_CT</span><span class='rparen token'>)</span>
|
|
758
|
-
<span class='end end kw'>end</span>
|
|
759
|
-
<span class='exts identifier id'>exts</span> <span class='assign token'>=</span> <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='image identifier id'>image</span><span class='bitor op'>|</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='extname identifier id'>extname</span> <span class='rbrace token'>}</span>
|
|
760
|
-
<span class='exts identifier id'>exts</span><span class='dot token'>.</span><span class='uniq identifier id'>uniq</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='ext identifier id'>ext</span><span class='bitor op'>|</span>
|
|
761
|
-
<span class='ct identifier id'>ct</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='lbrack token'>[</span><span class='string val'>'jpeg'</span><span class='comma token'>,</span> <span class='string val'>'jpg'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='ext identifier id'>ext</span><span class='rparen token'>)</span>
|
|
762
|
-
<span class='JPEG_CT constant id'>JPEG_CT</span>
|
|
763
|
-
<span class='elsif elsif kw'>elsif</span> <span class='ext identifier id'>ext</span> <span class='eq op'>==</span> <span class='string val'>'gif'</span>
|
|
764
|
-
<span class='GIF_CT constant id'>GIF_CT</span>
|
|
765
|
-
<span class='elsif elsif kw'>elsif</span> <span class='ext identifier id'>ext</span> <span class='eq op'>==</span> <span class='string val'>'png'</span>
|
|
766
|
-
<span class='PNG_CT constant id'>PNG_CT</span>
|
|
767
|
-
<span class='end end kw'>end</span>
|
|
768
|
-
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</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'>></span> <span class='ct identifier id'>ct</span><span class='comma token'>,</span> <span class='symbol val'>:Extension</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ext identifier id'>ext</span> <span class='rparen token'>)</span>
|
|
769
|
-
<span class='end end kw'>end</span>
|
|
770
|
-
<span class='c_types identifier id'>c_types</span>
|
|
771
|
-
<span class='end end kw'>end</span>
|
|
772
|
-
</pre>
|
|
773
|
-
</td>
|
|
774
|
-
</tr>
|
|
775
|
-
</table>
|
|
776
|
-
</div>
|
|
777
|
-
|
|
778
|
-
<div class="method_details ">
|
|
779
|
-
<p class="signature " id="parts-instance_method">
|
|
780
|
-
|
|
781
|
-
- (<tt>Array</tt>) <strong>parts</strong>
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
</p><div class="docstring">
|
|
786
|
-
<div class="discussion">
|
|
787
|
-
<p>
|
|
788
|
-
The parts of a package
|
|
789
|
-
</p>
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
</div>
|
|
793
|
-
</div>
|
|
794
|
-
<div class="tags">
|
|
795
|
-
|
|
796
|
-
<h3>Returns:</h3>
|
|
797
|
-
<ul class="return">
|
|
798
|
-
|
|
799
|
-
<li>
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
—
|
|
807
|
-
<div class='inline'><p>
|
|
808
|
-
An array of hashes that define the entry, document and schema for each part
|
|
809
|
-
of the package.
|
|
810
|
-
</p>
|
|
811
|
-
</div>
|
|
812
|
-
|
|
813
|
-
</li>
|
|
814
|
-
|
|
815
|
-
</ul>
|
|
816
|
-
|
|
817
|
-
</div><table class="source_code">
|
|
818
|
-
<tr>
|
|
819
|
-
<td>
|
|
820
|
-
<pre class="lines">
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
101
|
|
824
|
-
102
|
|
825
|
-
103
|
|
826
|
-
104
|
|
827
|
-
105
|
|
828
|
-
106
|
|
829
|
-
107
|
|
830
|
-
108
|
|
831
|
-
109
|
|
832
|
-
110
|
|
833
|
-
111
|
|
834
|
-
112
|
|
835
|
-
113
|
|
836
|
-
114
|
|
837
|
-
115
|
|
838
|
-
116
|
|
839
|
-
117
|
|
840
|
-
118
|
|
841
|
-
119
|
|
842
|
-
120
|
|
843
|
-
121
|
|
844
|
-
122
|
|
845
|
-
123
|
|
846
|
-
124
|
|
847
|
-
125
|
|
848
|
-
126
|
|
849
|
-
127
|
|
850
|
-
128
|
|
851
|
-
129</pre>
|
|
852
|
-
</td>
|
|
853
|
-
<td>
|
|
854
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 101</span>
|
|
855
|
-
|
|
856
|
-
<span class='def def kw'>def</span> <span class='parts identifier id'>parts</span>
|
|
857
|
-
<span class='@parts ivar id'>@parts</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span>
|
|
858
|
-
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></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'>></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'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
859
|
-
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></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'>></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'>></span> <span class='CORE_XSD constant id'>CORE_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
860
|
-
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></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'>></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'>></span> <span class='APP_XSD constant id'>APP_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
861
|
-
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></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'>></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'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
862
|
-
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></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'>></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'>></span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
863
|
-
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></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'>></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'>></span> <span class='CONTENT_TYPES_XSD constant id'>CONTENT_TYPES_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
|
|
864
|
-
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{STYLES_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></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'>></span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span>
|
|
865
|
-
<span class='rbrack token'>]</span>
|
|
866
|
-
<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>
|
|
867
|
-
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{drawing.rels_pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></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'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span>
|
|
868
|
-
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{drawing.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></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'>></span> <span class='DRAWING_XSD constant id'>DRAWING_XSD</span><span class='rbrace token'>}</span>
|
|
869
|
-
<span class='end end kw'>end</span>
|
|
870
|
-
|
|
871
|
-
<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>
|
|
872
|
-
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{chart.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></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'>></span> <span class='DRAWING_XSD constant id'>DRAWING_XSD</span><span class='rbrace token'>}</span>
|
|
873
|
-
<span class='end end kw'>end</span>
|
|
874
|
-
|
|
875
|
-
<span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</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='image identifier id'>image</span><span class='bitor op'>|</span>
|
|
876
|
-
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{image.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:path</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='image_src identifier id'>image_src</span><span class='rbrace token'>}</span>
|
|
877
|
-
<span class='end end kw'>end</span>
|
|
878
|
-
|
|
879
|
-
<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>
|
|
880
|
-
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{sheet.rels_pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></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'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span>
|
|
881
|
-
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{sheet.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></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'>></span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span>
|
|
882
|
-
<span class='end end kw'>end</span>
|
|
883
|
-
<span class='@parts ivar id'>@parts</span>
|
|
884
|
-
<span class='end end kw'>end</span>
|
|
885
|
-
</pre>
|
|
886
|
-
</td>
|
|
887
|
-
</tr>
|
|
888
|
-
</table>
|
|
889
|
-
</div>
|
|
890
|
-
|
|
891
|
-
<div class="method_details ">
|
|
892
|
-
<p class="signature " id="relationships-instance_method">
|
|
893
|
-
|
|
894
|
-
- (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong>
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
</p><div class="docstring">
|
|
899
|
-
<div class="discussion">
|
|
900
|
-
<p>
|
|
901
|
-
Creates the relationships required for a valid xlsx document
|
|
902
|
-
</p>
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
</div>
|
|
906
|
-
</div>
|
|
907
|
-
<div class="tags">
|
|
908
|
-
|
|
909
|
-
<h3>Returns:</h3>
|
|
910
|
-
<ul class="return">
|
|
911
|
-
|
|
912
|
-
<li>
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
<span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span>
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
</li>
|
|
920
|
-
|
|
921
|
-
</ul>
|
|
922
|
-
|
|
923
|
-
</div><table class="source_code">
|
|
924
|
-
<tr>
|
|
925
|
-
<td>
|
|
926
|
-
<pre class="lines">
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
197
|
|
930
|
-
198
|
|
931
|
-
199
|
|
932
|
-
200
|
|
933
|
-
201
|
|
934
|
-
202
|
|
935
|
-
203
|
|
936
|
-
204</pre>
|
|
937
|
-
</td>
|
|
938
|
-
<td>
|
|
939
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 197</span>
|
|
940
|
-
|
|
941
|
-
<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span>
|
|
942
|
-
<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>
|
|
943
|
-
<span class='rels identifier id'>rels</span> <span class='lshft op'><<</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>
|
|
944
|
-
<span class='rels identifier id'>rels</span> <span class='lshft op'><<</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>
|
|
945
|
-
<span class='rels identifier id'>rels</span> <span class='lshft op'><<</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>
|
|
946
|
-
<span class='rels identifier id'>rels</span><span class='dot token'>.</span><span class='lock identifier id'>lock</span>
|
|
947
|
-
<span class='rels identifier id'>rels</span>
|
|
948
|
-
<span class='end end kw'>end</span>
|
|
949
|
-
</pre>
|
|
950
|
-
</td>
|
|
951
|
-
</tr>
|
|
952
|
-
</table>
|
|
953
|
-
</div>
|
|
954
|
-
|
|
955
|
-
<div class="method_details ">
|
|
956
|
-
<p class="signature " id="serialize-instance_method">
|
|
381
|
+
<p class="signature first" id="serialize-instance_method">
|
|
957
382
|
|
|
958
383
|
- (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false)
|
|
959
384
|
|
|
@@ -964,17 +389,15 @@ Creates the relationships required for a valid xlsx document
|
|
|
964
389
|
|
|
965
390
|
<div class="note notetag">
|
|
966
391
|
<strong>Note:</strong>
|
|
967
|
-
<div class='inline'
|
|
968
|
-
A tremendous amount of effort has gone into ensuring that you cannot create
|
|
392
|
+
<div class='inline'>
|
|
393
|
+
<p>A tremendous amount of effort has gone into ensuring that you cannot create
|
|
969
394
|
invalid xlsx documents. confirm_valid should be used in the rare case that
|
|
970
|
-
you cannot open the serialized file
|
|
971
|
-
</p>
|
|
395
|
+
you cannot open the serialized file.</p>
|
|
972
396
|
</div>
|
|
973
397
|
</div>
|
|
974
398
|
|
|
975
|
-
|
|
976
|
-
Serialize your workbook to disk as an xlsx document
|
|
977
|
-
</p>
|
|
399
|
+
|
|
400
|
+
<p>Serialize your workbook to disk as an xlsx document.</p>
|
|
978
401
|
|
|
979
402
|
|
|
980
403
|
</div>
|
|
@@ -985,13 +408,12 @@ Serialize your workbook to disk as an xlsx document.
|
|
|
985
408
|
<h3>Examples:</h3>
|
|
986
409
|
|
|
987
410
|
<h4><div class='inline'></div></h4>
|
|
988
|
-
<pre class="example code"><span class='comment
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
<span class='
|
|
411
|
+
<pre class="example code"><span class='comment'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
|
|
412
|
+
</span><span class='comment'># Take a look at the README for an example of how to do it!
|
|
413
|
+
</span><span class='id f'>f</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>test.xlsx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>w</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
414
|
+
<span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id f'>f</span><span class='rparen'>)</span>
|
|
992
415
|
|
|
993
|
-
<span class='comment
|
|
994
|
-
</pre>
|
|
416
|
+
<span class='comment'># You will find a file called test.xlsx</span></pre>
|
|
995
417
|
|
|
996
418
|
</div>
|
|
997
419
|
<h3>Parameters:</h3>
|
|
@@ -1007,9 +429,8 @@ Serialize your workbook to disk as an xlsx document.
|
|
|
1007
429
|
|
|
1008
430
|
|
|
1009
431
|
—
|
|
1010
|
-
<div class='inline'
|
|
1011
|
-
The file you want to serialize your package to
|
|
1012
|
-
</p>
|
|
432
|
+
<div class='inline'>
|
|
433
|
+
<p>The file you want to serialize your package to</p>
|
|
1013
434
|
</div>
|
|
1014
435
|
|
|
1015
436
|
</li>
|
|
@@ -1026,9 +447,8 @@ The file you want to serialize your package to
|
|
|
1026
447
|
|
|
1027
448
|
|
|
1028
449
|
—
|
|
1029
|
-
<div class='inline'
|
|
1030
|
-
Validate the package prior to serialization
|
|
1031
|
-
</p>
|
|
450
|
+
<div class='inline'>
|
|
451
|
+
<p>Validate the package prior to serialization.</p>
|
|
1032
452
|
</div>
|
|
1033
453
|
|
|
1034
454
|
</li>
|
|
@@ -1046,10 +466,9 @@ Validate the package prior to serialization.
|
|
|
1046
466
|
|
|
1047
467
|
|
|
1048
468
|
—
|
|
1049
|
-
<div class='inline'
|
|
1050
|
-
False if confirm_valid and validation errors exist. True if the package was
|
|
1051
|
-
serialized
|
|
1052
|
-
</p>
|
|
469
|
+
<div class='inline'>
|
|
470
|
+
<p>False if confirm_valid and validation errors exist. True if the package was
|
|
471
|
+
serialized</p>
|
|
1053
472
|
</div>
|
|
1054
473
|
|
|
1055
474
|
</li>
|
|
@@ -1069,6 +488,7 @@ serialized
|
|
|
1069
488
|
<pre class="lines">
|
|
1070
489
|
|
|
1071
490
|
|
|
491
|
+
54
|
|
1072
492
|
55
|
|
1073
493
|
56
|
|
1074
494
|
57
|
|
@@ -1085,33 +505,29 @@ serialized
|
|
|
1085
505
|
68
|
|
1086
506
|
69
|
|
1087
507
|
70
|
|
1088
|
-
71
|
|
1089
|
-
72
|
|
1090
|
-
73</pre>
|
|
508
|
+
71</pre>
|
|
1091
509
|
</td>
|
|
1092
510
|
<td>
|
|
1093
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line
|
|
1094
|
-
|
|
1095
|
-
<span class='
|
|
1096
|
-
<span class='
|
|
1097
|
-
<span class='p
|
|
1098
|
-
<span class='
|
|
1099
|
-
<span class='p
|
|
1100
|
-
<span class='
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
<span class='
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
<span class='end end kw'>end</span>
|
|
1114
|
-
</pre>
|
|
511
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 54</span>
|
|
512
|
+
|
|
513
|
+
<span class='kw'>def</span> <span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id output'>output</span><span class='comma'>,</span> <span class='id confirm_valid'>confirm_valid</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
|
|
514
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id confirm_valid'>confirm_valid</span> <span class='op'>||</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id empty?'>empty?</span>
|
|
515
|
+
<span class='id p'>p</span> <span class='op'>=</span> <span class='id parts'>parts</span>
|
|
516
|
+
<span class='const'>Zip</span><span class='op'>::</span><span class='const'>ZipOutputStream</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='id output'>output</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id zip'>zip</span><span class='op'>|</span>
|
|
517
|
+
<span class='id p'>p</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span>
|
|
518
|
+
<span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
|
|
519
|
+
<span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span>
|
|
520
|
+
<span class='id zip'>zip</span><span class='period'>.</span><span class='id puts'>puts</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
521
|
+
<span class='kw'>end</span>
|
|
522
|
+
<span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
|
|
523
|
+
<span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span>
|
|
524
|
+
<span class='comment'># binread for 1.9.3
|
|
525
|
+
</span> <span class='id zip'>zip</span><span class='period'>.</span><span class='id write'>write</span> <span class='const'>IO</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:binread</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>IO</span><span class='period'>.</span><span class='id binread'>binread</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>IO</span><span class='period'>.</span><span class='id read'>read</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
526
|
+
<span class='kw'>end</span>
|
|
527
|
+
<span class='kw'>end</span>
|
|
528
|
+
<span class='kw'>end</span>
|
|
529
|
+
<span class='kw'>true</span>
|
|
530
|
+
<span class='kw'>end</span></pre>
|
|
1115
531
|
</td>
|
|
1116
532
|
</tr>
|
|
1117
533
|
</table>
|
|
@@ -1129,25 +545,22 @@ serialized
|
|
|
1129
545
|
|
|
1130
546
|
<div class="note notetag">
|
|
1131
547
|
<strong>Note:</strong>
|
|
1132
|
-
<div class='inline'
|
|
1133
|
-
This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
|
|
548
|
+
<div class='inline'>
|
|
549
|
+
<p>This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
|
|
1134
550
|
and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition.
|
|
1135
551
|
opc schema require an internet connection to import remote schema from
|
|
1136
552
|
dublin core for dc, dcterms and xml namespaces. Those remote schema are
|
|
1137
|
-
included in this gem, and the original files have been altered to
|
|
1138
|
-
the local versions
|
|
1139
|
-
|
|
1140
|
-
<p>
|
|
1141
|
-
If by chance you are able to creat a package that does not validate it
|
|
553
|
+
included in this gem, and the original files have been altered to refer to
|
|
554
|
+
the local versions.</p>
|
|
555
|
+
|
|
556
|
+
<p>If by chance you are able to creat a package that does not validate it
|
|
1142
557
|
indicates that the internal validation is not robust enough and needs to be
|
|
1143
|
-
improved. Please report your errors to the gem author
|
|
1144
|
-
</p>
|
|
558
|
+
improved. Please report your errors to the gem author.</p>
|
|
1145
559
|
</div>
|
|
1146
560
|
</div>
|
|
1147
561
|
|
|
1148
|
-
|
|
1149
|
-
Validate all parts of the package against xsd schema
|
|
1150
|
-
</p>
|
|
562
|
+
|
|
563
|
+
<p>Validate all parts of the package against xsd schema.</p>
|
|
1151
564
|
|
|
1152
565
|
|
|
1153
566
|
</div>
|
|
@@ -1158,11 +571,10 @@ Validate all parts of the package against xsd schema.
|
|
|
1158
571
|
<h3>Examples:</h3>
|
|
1159
572
|
|
|
1160
573
|
<h4><div class='inline'></div></h4>
|
|
1161
|
-
<pre class="example code"><span class='comment
|
|
1162
|
-
|
|
1163
|
-
<span class='comment
|
|
1164
|
-
|
|
1165
|
-
</pre>
|
|
574
|
+
<pre class="example code"><span class='comment'># The following will output any error messages found in serialization.
|
|
575
|
+
</span><span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span>
|
|
576
|
+
<span class='comment'># ... code to create sheets, charts, styles etc.
|
|
577
|
+
</span><span class='id p'>p</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id error'>error</span><span class='op'>|</span> <span class='id puts'>puts</span> <span class='id error'>error</span><span class='period'>.</span><span class='id message'>message</span> <span class='rbrace'>}</span></pre>
|
|
1166
578
|
|
|
1167
579
|
</div>
|
|
1168
580
|
|
|
@@ -1177,9 +589,8 @@ Validate all parts of the package against xsd schema.
|
|
|
1177
589
|
|
|
1178
590
|
|
|
1179
591
|
—
|
|
1180
|
-
<div class='inline'
|
|
1181
|
-
An array of all validation errors found
|
|
1182
|
-
</p>
|
|
592
|
+
<div class='inline'>
|
|
593
|
+
<p>An array of all validation errors found.</p>
|
|
1183
594
|
</div>
|
|
1184
595
|
|
|
1185
596
|
</li>
|
|
@@ -1199,101 +610,140 @@ An array of all validation errors found.
|
|
|
1199
610
|
<pre class="lines">
|
|
1200
611
|
|
|
1201
612
|
|
|
613
|
+
88
|
|
614
|
+
89
|
|
1202
615
|
90
|
|
1203
616
|
91
|
|
1204
|
-
92
|
|
1205
|
-
93
|
|
1206
|
-
94</pre>
|
|
617
|
+
92</pre>
|
|
1207
618
|
</td>
|
|
1208
619
|
<td>
|
|
1209
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line
|
|
1210
|
-
|
|
1211
|
-
<span class='
|
|
1212
|
-
<span class='errors
|
|
1213
|
-
<span class='parts
|
|
1214
|
-
<span class='errors
|
|
1215
|
-
<span class='
|
|
1216
|
-
</pre>
|
|
620
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 88</span>
|
|
621
|
+
|
|
622
|
+
<span class='kw'>def</span> <span class='id validate'>validate</span>
|
|
623
|
+
<span class='id errors'>errors</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
624
|
+
<span class='id parts'>parts</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span> <span class='id errors'>errors</span><span class='period'>.</span><span class='id concat'>concat</span> <span class='id validate_single_doc'>validate_single_doc</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='rbrace'>}</span>
|
|
625
|
+
<span class='id errors'>errors</span>
|
|
626
|
+
<span class='kw'>end</span></pre>
|
|
1217
627
|
</td>
|
|
1218
628
|
</tr>
|
|
1219
629
|
</table>
|
|
1220
630
|
</div>
|
|
1221
631
|
|
|
1222
632
|
<div class="method_details ">
|
|
1223
|
-
<p class="signature " id="
|
|
633
|
+
<p class="signature " id="workbook-instance_method">
|
|
1224
634
|
|
|
1225
|
-
- (<tt>
|
|
635
|
+
- (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong>
|
|
1226
636
|
|
|
1227
637
|
|
|
1228
638
|
|
|
1229
639
|
</p><div class="docstring">
|
|
1230
640
|
<div class="discussion">
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
641
|
+
|
|
642
|
+
<div class="note notetag">
|
|
643
|
+
<strong>Note:</strong>
|
|
644
|
+
<div class='inline'>
|
|
645
|
+
<p>As there are multiple ways to instantiate a workbook for the package, here
|
|
646
|
+
are a few examples:</p>
|
|
647
|
+
|
|
648
|
+
<pre class="code"><span class='comment'># assign directly during package instanciation
|
|
649
|
+
</span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:workbook</span> <span class='op'>=></span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span>
|
|
650
|
+
|
|
651
|
+
<span class='comment'># get a fresh workbook automatically from the package
|
|
652
|
+
</span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Pacakge</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span>
|
|
653
|
+
<span class='comment'># # set the workbook after creating the package
|
|
654
|
+
</span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span></pre>
|
|
655
|
+
</div>
|
|
656
|
+
</div>
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
<p>The workbook this package will serialize or validate.</p>
|
|
1234
660
|
|
|
1235
661
|
|
|
1236
662
|
</div>
|
|
1237
663
|
</div>
|
|
1238
664
|
<div class="tags">
|
|
1239
|
-
|
|
1240
|
-
<
|
|
665
|
+
|
|
666
|
+
<h3>Returns:</h3>
|
|
667
|
+
<ul class="return">
|
|
1241
668
|
|
|
1242
669
|
<li>
|
|
1243
670
|
|
|
1244
|
-
<span class='name'>schema</span>
|
|
1245
|
-
|
|
1246
671
|
|
|
1247
|
-
<span class='type'>(<tt>
|
|
672
|
+
<span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span>
|
|
1248
673
|
|
|
1249
674
|
|
|
1250
675
|
|
|
1251
676
|
—
|
|
1252
|
-
<div class='inline'
|
|
1253
|
-
|
|
1254
|
-
|
|
677
|
+
<div class='inline'>
|
|
678
|
+
<p>If no workbook instance has been assigned with this package a new Workbook
|
|
679
|
+
instance is returned.</p>
|
|
1255
680
|
</div>
|
|
1256
681
|
|
|
1257
682
|
</li>
|
|
1258
683
|
|
|
684
|
+
</ul>
|
|
685
|
+
<h3>Raises:</h3>
|
|
686
|
+
<ul class="raise">
|
|
687
|
+
|
|
1259
688
|
<li>
|
|
1260
689
|
|
|
1261
|
-
<span class='name'>doc</span>
|
|
1262
|
-
|
|
1263
690
|
|
|
1264
|
-
<span class='type'
|
|
691
|
+
<span class='type'></span>
|
|
1265
692
|
|
|
1266
693
|
|
|
1267
694
|
|
|
1268
|
-
|
|
1269
|
-
<div class='inline'
|
|
1270
|
-
|
|
1271
|
-
</p>
|
|
695
|
+
|
|
696
|
+
<div class='inline'>
|
|
697
|
+
<p>ArgumentError if workbook parameter is not a Workbook instance.</p>
|
|
1272
698
|
</div>
|
|
1273
699
|
|
|
1274
700
|
</li>
|
|
1275
701
|
|
|
1276
702
|
</ul>
|
|
1277
703
|
|
|
1278
|
-
|
|
1279
|
-
<
|
|
704
|
+
</div><table class="source_code">
|
|
705
|
+
<tr>
|
|
706
|
+
<td>
|
|
707
|
+
<pre class="lines">
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
32
|
|
711
|
+
33
|
|
712
|
+
34</pre>
|
|
713
|
+
</td>
|
|
714
|
+
<td>
|
|
715
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 32</span>
|
|
716
|
+
|
|
717
|
+
<span class='kw'>def</span> <span class='id workbook'>workbook</span>
|
|
718
|
+
<span class='ivar'>@workbook</span> <span class='op'>||</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span>
|
|
719
|
+
<span class='kw'>end</span></pre>
|
|
720
|
+
</td>
|
|
721
|
+
</tr>
|
|
722
|
+
</table>
|
|
723
|
+
</div>
|
|
724
|
+
|
|
725
|
+
<div class="method_details ">
|
|
726
|
+
<p class="signature " id="workbook=-instance_method">
|
|
1280
727
|
|
|
1281
|
-
<
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
An array of all validation errors encountered.
|
|
1291
|
-
</p>
|
|
728
|
+
- (<tt>Object</tt>) <strong>workbook=</strong>(workbook)
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
</p><div class="docstring">
|
|
733
|
+
<div class="discussion">
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</div>
|
|
1292
737
|
</div>
|
|
1293
|
-
|
|
1294
|
-
</li>
|
|
738
|
+
<div class="tags">
|
|
1295
739
|
|
|
1296
|
-
|
|
740
|
+
|
|
741
|
+
<h3>See Also:</h3>
|
|
742
|
+
<ul class="see">
|
|
743
|
+
|
|
744
|
+
<li>workbook</li>
|
|
745
|
+
|
|
746
|
+
</ul>
|
|
1297
747
|
|
|
1298
748
|
</div><table class="source_code">
|
|
1299
749
|
<tr>
|
|
@@ -1301,31 +751,12 @@ An array of all validation errors encountered.
|
|
|
1301
751
|
<pre class="lines">
|
|
1302
752
|
|
|
1303
753
|
|
|
1304
|
-
|
|
1305
|
-
138
|
|
1306
|
-
139
|
|
1307
|
-
140
|
|
1308
|
-
141
|
|
1309
|
-
142
|
|
1310
|
-
143
|
|
1311
|
-
144
|
|
1312
|
-
145
|
|
1313
|
-
146</pre>
|
|
754
|
+
37</pre>
|
|
1314
755
|
</td>
|
|
1315
756
|
<td>
|
|
1316
|
-
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line
|
|
1317
|
-
|
|
1318
|
-
<span class='
|
|
1319
|
-
<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>
|
|
1320
|
-
<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>
|
|
1321
|
-
|
|
1322
|
-
<span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
|
|
1323
|
-
<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>
|
|
1324
|
-
<span class='errors identifier id'>errors</span> <span class='lshft op'><<</span> <span class='error identifier id'>error</span>
|
|
1325
|
-
<span class='end end kw'>end</span>
|
|
1326
|
-
<span class='errors identifier id'>errors</span>
|
|
1327
|
-
<span class='end end kw'>end</span>
|
|
1328
|
-
</pre>
|
|
757
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span>
|
|
758
|
+
|
|
759
|
+
<span class='kw'>def</span> <span class='id workbook='>workbook=</span><span class='lparen'>(</span><span class='id workbook'>workbook</span><span class='rparen'>)</span> <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Package.workbook</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Workbook</span><span class='comma'>,</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1329
760
|
</td>
|
|
1330
761
|
</tr>
|
|
1331
762
|
</table>
|
|
@@ -1336,9 +767,9 @@ An array of all validation errors encountered.
|
|
|
1336
767
|
</div>
|
|
1337
768
|
|
|
1338
769
|
<div id="footer">
|
|
1339
|
-
Generated on
|
|
770
|
+
Generated on Sat Nov 26 13:16:36 2011 by
|
|
1340
771
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1341
|
-
0.7.3 (ruby-1.
|
|
772
|
+
0.7.3 (ruby-1.9.3).
|
|
1342
773
|
</div>
|
|
1343
774
|
|
|
1344
775
|
</body>
|