axlsx 1.0.5 → 1.0.6
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/README.md +10 -9
- data/doc/Axlsx.html +2443 -0
- data/doc/Axlsx/App.html +2640 -0
- data/doc/Axlsx/Axis.html +1047 -0
- data/doc/Axlsx/Bar3DChart.html +1153 -0
- data/doc/Axlsx/BarSeries.html +764 -0
- data/doc/Axlsx/Border.html +775 -0
- data/doc/Axlsx/BorderPr.html +709 -0
- data/doc/Axlsx/CatAxis.html +766 -0
- data/doc/Axlsx/Cell.html +1623 -0
- data/doc/Axlsx/CellAlignment.html +1247 -0
- data/doc/Axlsx/CellProtection.html +565 -0
- data/doc/Axlsx/CellStyle.html +949 -0
- data/doc/Axlsx/Chart.html +1459 -0
- data/doc/Axlsx/Color.html +665 -0
- data/doc/Axlsx/ContentType.html +340 -0
- data/doc/Axlsx/Core.html +465 -0
- data/doc/Axlsx/DataTypeValidator.html +324 -0
- data/doc/Axlsx/Default.html +575 -0
- data/doc/Axlsx/Drawing.html +1154 -0
- data/doc/Axlsx/Fill.html +460 -0
- data/doc/Axlsx/Font.html +1554 -0
- data/doc/Axlsx/GradientFill.html +1026 -0
- data/doc/Axlsx/GradientStop.html +526 -0
- data/doc/Axlsx/GraphicFrame.html +646 -0
- data/doc/Axlsx/Line3DChart.html +921 -0
- data/doc/Axlsx/LineSeries.html +656 -0
- data/doc/Axlsx/Marker.html +857 -0
- data/doc/Axlsx/NumFmt.html +562 -0
- data/doc/Axlsx/Override.html +568 -0
- data/doc/Axlsx/Package.html +1293 -0
- data/doc/Axlsx/PatternFill.html +681 -0
- data/doc/Axlsx/Pie3DChart.html +439 -0
- data/doc/Axlsx/PieSeries.html +762 -0
- data/doc/Axlsx/RegexValidator.html +268 -0
- data/doc/Axlsx/Relationship.html +554 -0
- data/doc/Axlsx/Relationships.html +343 -0
- data/doc/Axlsx/RestrictionValidator.html +300 -0
- data/doc/Axlsx/Row.html +771 -0
- data/doc/Axlsx/Scaling.html +740 -0
- data/doc/Axlsx/SerAxis.html +624 -0
- data/doc/Axlsx/Series.html +746 -0
- data/doc/Axlsx/SeriesTitle.html +289 -0
- data/doc/Axlsx/SimpleTypedList.html +1617 -0
- data/doc/Axlsx/Styles.html +1754 -0
- data/doc/Axlsx/TableStyle.html +710 -0
- data/doc/Axlsx/TableStyleElement.html +677 -0
- data/doc/Axlsx/TableStyles.html +599 -0
- data/doc/Axlsx/Title.html +625 -0
- data/doc/Axlsx/TwoCellAnchor.html +1115 -0
- data/doc/Axlsx/ValAxis.html +539 -0
- data/doc/Axlsx/View3D.html +971 -0
- data/doc/Axlsx/Workbook.html +1347 -0
- data/doc/Axlsx/Worksheet.html +1864 -0
- data/doc/Axlsx/Xf.html +1681 -0
- data/doc/_index.html +611 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +262 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +262 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +3038 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/axlsx/util/constants.rb +1 -1
- metadata +71 -3
|
@@ -0,0 +1,1347 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Axlsx::Workbook
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.7.3
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
relpath = '..';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
35
|
+
|
|
36
|
+
<a href="../_index.html">Index (W)</a> »
|
|
37
|
+
<span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
|
|
38
|
+
»
|
|
39
|
+
<span class="title">Workbook</span>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<div id="search">
|
|
46
|
+
|
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
48
|
+
|
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
50
|
+
|
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
<div class="clear"></div>
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<iframe id="search_frame"></iframe>
|
|
58
|
+
|
|
59
|
+
<div id="content"><h1>Class: Axlsx::Workbook
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</h1>
|
|
64
|
+
|
|
65
|
+
<dl class="box">
|
|
66
|
+
|
|
67
|
+
<dt class="r1">Inherits:</dt>
|
|
68
|
+
<dd class="r1">
|
|
69
|
+
<span class="inheritName">Object</span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next">Axlsx::Workbook</li>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
78
|
+
|
|
79
|
+
</dd>
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
<dt class="r2 last">Defined in:</dt>
|
|
90
|
+
<dd class="r2 last">lib/axlsx/workbook/workbook.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
<p>
|
|
98
|
+
The Workbook class is an xlsx workbook that manages worksheets, charts,
|
|
99
|
+
drawings and styles. The following parts of the Office Open XML spreadsheet
|
|
100
|
+
specification are not implimented in this version.
|
|
101
|
+
</p>
|
|
102
|
+
<pre class="code">
|
|
103
|
+
<span class='bookViews identifier id'>bookViews</span>
|
|
104
|
+
<span class='calcPr identifier id'>calcPr</span>
|
|
105
|
+
<span class='customWorkbookViews identifier id'>customWorkbookViews</span>
|
|
106
|
+
<span class='definedNames identifier id'>definedNames</span>
|
|
107
|
+
<span class='externalReferences identifier id'>externalReferences</span>
|
|
108
|
+
<span class='extLst identifier id'>extLst</span>
|
|
109
|
+
<span class='fileRecoveryPr identifier id'>fileRecoveryPr</span>
|
|
110
|
+
<span class='fileSharing identifier id'>fileSharing</span>
|
|
111
|
+
<span class='fileVersion identifier id'>fileVersion</span>
|
|
112
|
+
<span class='functionGroups identifier id'>functionGroups</span>
|
|
113
|
+
<span class='oleSize identifier id'>oleSize</span>
|
|
114
|
+
<span class='pivotCaches identifier id'>pivotCaches</span>
|
|
115
|
+
<span class='smartTagPr identifier id'>smartTagPr</span>
|
|
116
|
+
<span class='smartTagTypes identifier id'>smartTagTypes</span>
|
|
117
|
+
<span class='webPublishing identifier id'>webPublishing</span>
|
|
118
|
+
<span class='webPublishObjects identifier id'>webPublishObjects</span>
|
|
119
|
+
<span class='workbookProtection identifier id'>workbookProtection</span>
|
|
120
|
+
<span class='workbookPr identifier id'>workbookPr</span><span class='mult op'>*</span>
|
|
121
|
+
|
|
122
|
+
<span class='mult op'>*</span><span class='workbookPr identifier id'>workbookPr</span> <span class='is identifier id'>is</span> <span class='only identifier id'>only</span> <span class='supported identifier id'>supported</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='extend identifier id'>extend</span> <span class='of identifier id'>of</span> <span class='date1904 identifier id'>date1904</span>
|
|
123
|
+
</pre>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
</div>
|
|
127
|
+
</div>
|
|
128
|
+
<div class="tags">
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
<h2>Constant Summary</h2>
|
|
133
|
+
|
|
134
|
+
<dl class="constants">
|
|
135
|
+
|
|
136
|
+
<dt id="date1904-classvariable" class="">@@date1904 =
|
|
137
|
+
<div class="docstring">
|
|
138
|
+
<div class="discussion">
|
|
139
|
+
<p>
|
|
140
|
+
Indicates if the epoc date for serialization should be 1904. If false, 1900
|
|
141
|
+
is used.
|
|
142
|
+
</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</dt>
|
|
152
|
+
<dd><pre class="code"><span class='false false kw'>false</span>
|
|
153
|
+
</pre></dd>
|
|
154
|
+
|
|
155
|
+
</dl>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
160
|
+
<ul class="summary">
|
|
161
|
+
|
|
162
|
+
<li class="public ">
|
|
163
|
+
<span class="summary_signature">
|
|
164
|
+
|
|
165
|
+
<a href="#charts-instance_method" title="#charts (instance method)">- (SimpleTypedList) <strong>charts</strong> </a>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</span>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<span class="note title readonly">readonly</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
182
|
+
A colllection of charts associated with this workbook.
|
|
183
|
+
</p>
|
|
184
|
+
</div></span>
|
|
185
|
+
|
|
186
|
+
</li>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<li class="public ">
|
|
190
|
+
<span class="summary_signature">
|
|
191
|
+
|
|
192
|
+
<a href="#date1904-instance_method" title="#date1904 (instance method)">- (Boolean) <strong>date1904</strong> </a>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</span>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
209
|
+
Instance level access to the class variable 1904.
|
|
210
|
+
</p>
|
|
211
|
+
</div></span>
|
|
212
|
+
|
|
213
|
+
</li>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<li class="public ">
|
|
217
|
+
<span class="summary_signature">
|
|
218
|
+
|
|
219
|
+
<a href="#drawings-instance_method" title="#drawings (instance method)">- (SimpleTypedList) <strong>drawings</strong> </a>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</span>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<span class="note title readonly">readonly</span>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
236
|
+
A colllection of drawings associated with this workbook.
|
|
237
|
+
</p>
|
|
238
|
+
</div></span>
|
|
239
|
+
|
|
240
|
+
</li>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<li class="public ">
|
|
244
|
+
<span class="summary_signature">
|
|
245
|
+
|
|
246
|
+
<a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</span>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<span class="note title readonly">readonly</span>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
263
|
+
The workbook relationships.
|
|
264
|
+
</p>
|
|
265
|
+
</div></span>
|
|
266
|
+
|
|
267
|
+
</li>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<li class="public ">
|
|
271
|
+
<span class="summary_signature">
|
|
272
|
+
|
|
273
|
+
<a href="#styles-instance_method" title="#styles (instance method)">- (Styles) <strong>styles</strong> </a>
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class="note title readonly">readonly</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
290
|
+
The styles associated with this workbook.
|
|
291
|
+
</p>
|
|
292
|
+
</div></span>
|
|
293
|
+
|
|
294
|
+
</li>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<li class="public ">
|
|
298
|
+
<span class="summary_signature">
|
|
299
|
+
|
|
300
|
+
<a href="#worksheets-instance_method" title="#worksheets (instance method)">- (SimpleTypedList) <strong>worksheets</strong> </a>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
</span>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<span class="note title readonly">readonly</span>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
317
|
+
A collection of worksheets associated with this workbook.
|
|
318
|
+
</p>
|
|
319
|
+
</div></span>
|
|
320
|
+
|
|
321
|
+
</li>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
</ul>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<h2>
|
|
331
|
+
Class Method Summary
|
|
332
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
333
|
+
</h2>
|
|
334
|
+
|
|
335
|
+
<ul class="summary">
|
|
336
|
+
|
|
337
|
+
<li class="public ">
|
|
338
|
+
<span class="summary_signature">
|
|
339
|
+
|
|
340
|
+
<a href="#date1904-class_method" title="date1904 (class method)">+ (Boolean) <strong>date1904</strong> </a>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</span>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
354
|
+
retrieves the date1904 attribute.
|
|
355
|
+
</p>
|
|
356
|
+
</div></span>
|
|
357
|
+
|
|
358
|
+
</li>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
<li class="public ">
|
|
362
|
+
<span class="summary_signature">
|
|
363
|
+
|
|
364
|
+
<a href="#date1904%3D-class_method" title="date1904= (class method)">+ (Boolean) <strong>date1904=</strong>(v) </a>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</span>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
378
|
+
Sets the date1904 attribute to the provided boolean.
|
|
379
|
+
</p>
|
|
380
|
+
</div></span>
|
|
381
|
+
|
|
382
|
+
</li>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</ul>
|
|
386
|
+
|
|
387
|
+
<h2>
|
|
388
|
+
Instance Method Summary
|
|
389
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
390
|
+
</h2>
|
|
391
|
+
|
|
392
|
+
<ul class="summary">
|
|
393
|
+
|
|
394
|
+
<li class="public ">
|
|
395
|
+
<span class="summary_signature">
|
|
396
|
+
|
|
397
|
+
<a href="#add_worksheet-instance_method" title="#add_worksheet (instance method)">- (Worksheet) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... }</a>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
</span>
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
411
|
+
Adds a worksheet to this workbook.
|
|
412
|
+
</p>
|
|
413
|
+
</div></span>
|
|
414
|
+
|
|
415
|
+
</li>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<li class="public ">
|
|
419
|
+
<span class="summary_signature">
|
|
420
|
+
|
|
421
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Workbook) <strong>initialize</strong>(options = {}) {|_self| ... }</a>
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
</span>
|
|
426
|
+
|
|
427
|
+
<span class="note title constructor">constructor</span>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
437
|
+
Creates a new Workbook.
|
|
438
|
+
</p>
|
|
439
|
+
</div></span>
|
|
440
|
+
|
|
441
|
+
</li>
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
<li class="public ">
|
|
445
|
+
<span class="summary_signature">
|
|
446
|
+
|
|
447
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</span>
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
461
|
+
Serializes the workbook document.
|
|
462
|
+
</p>
|
|
463
|
+
</div></span>
|
|
464
|
+
|
|
465
|
+
</li>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</ul>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<div id="constructor_details" class="method_details_list">
|
|
472
|
+
<h2>Constructor Details</h2>
|
|
473
|
+
|
|
474
|
+
<div class="method_details first">
|
|
475
|
+
<p class="signature first" id="initialize-instance_method">
|
|
476
|
+
|
|
477
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... }
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
</p><div class="docstring">
|
|
482
|
+
<div class="discussion">
|
|
483
|
+
<p>
|
|
484
|
+
Creates a new Workbook
|
|
485
|
+
</p>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
</div>
|
|
489
|
+
</div>
|
|
490
|
+
<div class="tags">
|
|
491
|
+
<h3>Parameters:</h3>
|
|
492
|
+
<ul class="param">
|
|
493
|
+
|
|
494
|
+
<li>
|
|
495
|
+
|
|
496
|
+
<span class='name'>options</span>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
—
|
|
506
|
+
<div class='inline'><p>
|
|
507
|
+
a customizable set of options
|
|
508
|
+
</p>
|
|
509
|
+
</div>
|
|
510
|
+
|
|
511
|
+
</li>
|
|
512
|
+
|
|
513
|
+
</ul>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
519
|
+
<ul class="option">
|
|
520
|
+
|
|
521
|
+
<li>
|
|
522
|
+
<span class="name">date1904</span>
|
|
523
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
524
|
+
<span class="default">
|
|
525
|
+
|
|
526
|
+
</span>
|
|
527
|
+
|
|
528
|
+
</li>
|
|
529
|
+
|
|
530
|
+
</ul>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
<h3>Yields:</h3>
|
|
534
|
+
<ul class="yield">
|
|
535
|
+
|
|
536
|
+
<li>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
<span class='type'>(<tt>_self</tt>)</span>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
</li>
|
|
544
|
+
|
|
545
|
+
</ul>
|
|
546
|
+
<h3>Yield Parameters:</h3>
|
|
547
|
+
<ul class="yieldparam">
|
|
548
|
+
|
|
549
|
+
<li>
|
|
550
|
+
|
|
551
|
+
<span class='name'>_self</span>
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Workbook (class)">Axlsx::Workbook</a></span></tt>)</span>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
—
|
|
559
|
+
<div class='inline'><p>
|
|
560
|
+
the object that the method was called on
|
|
561
|
+
</p>
|
|
562
|
+
</div>
|
|
563
|
+
|
|
564
|
+
</li>
|
|
565
|
+
|
|
566
|
+
</ul>
|
|
567
|
+
|
|
568
|
+
</div><table class="source_code">
|
|
569
|
+
<tr>
|
|
570
|
+
<td>
|
|
571
|
+
<pre class="lines">
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
75
|
|
575
|
+
76
|
|
576
|
+
77
|
|
577
|
+
78
|
|
578
|
+
79
|
|
579
|
+
80
|
|
580
|
+
81
|
|
581
|
+
82</pre>
|
|
582
|
+
</td>
|
|
583
|
+
<td>
|
|
584
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 75</span>
|
|
585
|
+
|
|
586
|
+
<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>
|
|
587
|
+
<span class='@styles ivar id'>@styles</span> <span class='assign token'>=</span> <span class='Styles constant id'>Styles</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
|
588
|
+
<span class='@worksheets ivar id'>@worksheets</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Worksheet constant id'>Worksheet</span>
|
|
589
|
+
<span class='@drawings ivar id'>@drawings</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Drawing constant id'>Drawing</span>
|
|
590
|
+
<span class='@charts ivar id'>@charts</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Chart constant id'>Chart</span>
|
|
591
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
|
592
|
+
<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>
|
|
593
|
+
<span class='end end kw'>end</span>
|
|
594
|
+
</pre>
|
|
595
|
+
</td>
|
|
596
|
+
</tr>
|
|
597
|
+
</table>
|
|
598
|
+
</div>
|
|
599
|
+
|
|
600
|
+
</div>
|
|
601
|
+
|
|
602
|
+
<div id="instance_attr_details" class="attr_details">
|
|
603
|
+
<h2>Instance Attribute Details</h2>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
<span id=""></span>
|
|
607
|
+
<span id="charts-instance_method"></span>
|
|
608
|
+
<div class="method_details first">
|
|
609
|
+
<p class="signature first" id="charts-instance_method">
|
|
610
|
+
|
|
611
|
+
- (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>charts</strong> <span class="extras">(readonly)</span>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
</p><div class="docstring">
|
|
616
|
+
<div class="discussion">
|
|
617
|
+
|
|
618
|
+
<div class="note notetag">
|
|
619
|
+
<strong>Note:</strong>
|
|
620
|
+
<div class='inline'><p>
|
|
621
|
+
The recommended way to manage charts is Worksheet#add_chart
|
|
622
|
+
</p>
|
|
623
|
+
</div>
|
|
624
|
+
</div>
|
|
625
|
+
|
|
626
|
+
<p>
|
|
627
|
+
A colllection of charts associated with this workbook
|
|
628
|
+
</p>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
</div>
|
|
632
|
+
</div>
|
|
633
|
+
<div class="tags">
|
|
634
|
+
|
|
635
|
+
<h3>Returns:</h3>
|
|
636
|
+
<ul class="return">
|
|
637
|
+
|
|
638
|
+
<li>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
<span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
</li>
|
|
646
|
+
|
|
647
|
+
</ul>
|
|
648
|
+
|
|
649
|
+
<h3>See Also:</h3>
|
|
650
|
+
<ul class="see">
|
|
651
|
+
|
|
652
|
+
<li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Axlsx::Worksheet#add_chart</a></span></li>
|
|
653
|
+
|
|
654
|
+
<li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li>
|
|
655
|
+
|
|
656
|
+
</ul>
|
|
657
|
+
|
|
658
|
+
</div><table class="source_code">
|
|
659
|
+
<tr>
|
|
660
|
+
<td>
|
|
661
|
+
<pre class="lines">
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
45
|
|
665
|
+
46
|
|
666
|
+
47</pre>
|
|
667
|
+
</td>
|
|
668
|
+
<td>
|
|
669
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 45</span>
|
|
670
|
+
|
|
671
|
+
<span class='def def kw'>def</span> <span class='charts identifier id'>charts</span>
|
|
672
|
+
<span class='@charts ivar id'>@charts</span>
|
|
673
|
+
<span class='end end kw'>end</span>
|
|
674
|
+
</pre>
|
|
675
|
+
</td>
|
|
676
|
+
</tr>
|
|
677
|
+
</table>
|
|
678
|
+
</div>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<span id="date1904=-instance_method"></span>
|
|
682
|
+
<span id="date1904-instance_method"></span>
|
|
683
|
+
<div class="method_details ">
|
|
684
|
+
<p class="signature " id="date1904-instance_method">
|
|
685
|
+
|
|
686
|
+
- (<tt>Boolean</tt>) <strong>date1904</strong>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
</p><div class="docstring">
|
|
691
|
+
<div class="discussion">
|
|
692
|
+
<p>
|
|
693
|
+
Instance level access to the class variable 1904
|
|
694
|
+
</p>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
</div>
|
|
698
|
+
</div>
|
|
699
|
+
<div class="tags">
|
|
700
|
+
|
|
701
|
+
<h3>Returns:</h3>
|
|
702
|
+
<ul class="return">
|
|
703
|
+
|
|
704
|
+
<li>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
</li>
|
|
712
|
+
|
|
713
|
+
</ul>
|
|
714
|
+
|
|
715
|
+
</div><table class="source_code">
|
|
716
|
+
<tr>
|
|
717
|
+
<td>
|
|
718
|
+
<pre class="lines">
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
67</pre>
|
|
722
|
+
</td>
|
|
723
|
+
<td>
|
|
724
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 67</span>
|
|
725
|
+
|
|
726
|
+
<span class='def def kw'>def</span> <span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span>
|
|
727
|
+
</pre>
|
|
728
|
+
</td>
|
|
729
|
+
</tr>
|
|
730
|
+
</table>
|
|
731
|
+
</div>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
<span id=""></span>
|
|
735
|
+
<span id="drawings-instance_method"></span>
|
|
736
|
+
<div class="method_details ">
|
|
737
|
+
<p class="signature " id="drawings-instance_method">
|
|
738
|
+
|
|
739
|
+
- (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>drawings</strong> <span class="extras">(readonly)</span>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
</p><div class="docstring">
|
|
744
|
+
<div class="discussion">
|
|
745
|
+
|
|
746
|
+
<div class="note notetag">
|
|
747
|
+
<strong>Note:</strong>
|
|
748
|
+
<div class='inline'><p>
|
|
749
|
+
The recommended way to manage drawings is Worksheet#add_chart
|
|
750
|
+
</p>
|
|
751
|
+
</div>
|
|
752
|
+
</div>
|
|
753
|
+
|
|
754
|
+
<p>
|
|
755
|
+
A colllection of drawings associated with this workbook
|
|
756
|
+
</p>
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
</div>
|
|
760
|
+
</div>
|
|
761
|
+
<div class="tags">
|
|
762
|
+
|
|
763
|
+
<h3>Returns:</h3>
|
|
764
|
+
<ul class="return">
|
|
765
|
+
|
|
766
|
+
<li>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
<span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
</li>
|
|
774
|
+
|
|
775
|
+
</ul>
|
|
776
|
+
|
|
777
|
+
<h3>See Also:</h3>
|
|
778
|
+
<ul class="see">
|
|
779
|
+
|
|
780
|
+
<li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Axlsx::Worksheet#add_chart</a></span></li>
|
|
781
|
+
|
|
782
|
+
<li><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></li>
|
|
783
|
+
|
|
784
|
+
</ul>
|
|
785
|
+
|
|
786
|
+
</div><table class="source_code">
|
|
787
|
+
<tr>
|
|
788
|
+
<td>
|
|
789
|
+
<pre class="lines">
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
52
|
|
793
|
+
53
|
|
794
|
+
54</pre>
|
|
795
|
+
</td>
|
|
796
|
+
<td>
|
|
797
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 52</span>
|
|
798
|
+
|
|
799
|
+
<span class='def def kw'>def</span> <span class='drawings identifier id'>drawings</span>
|
|
800
|
+
<span class='@drawings ivar id'>@drawings</span>
|
|
801
|
+
<span class='end end kw'>end</span>
|
|
802
|
+
</pre>
|
|
803
|
+
</td>
|
|
804
|
+
</tr>
|
|
805
|
+
</table>
|
|
806
|
+
</div>
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
<span id=""></span>
|
|
810
|
+
<span id="relationships-instance_method"></span>
|
|
811
|
+
<div class="method_details ">
|
|
812
|
+
<p class="signature " id="relationships-instance_method">
|
|
813
|
+
|
|
814
|
+
- (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> <span class="extras">(readonly)</span>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
</p><div class="docstring">
|
|
819
|
+
<div class="discussion">
|
|
820
|
+
<p>
|
|
821
|
+
The workbook relationships. This is managed automatically by the workbook
|
|
822
|
+
</p>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
</div>
|
|
826
|
+
</div>
|
|
827
|
+
<div class="tags">
|
|
828
|
+
|
|
829
|
+
<h3>Returns:</h3>
|
|
830
|
+
<ul class="return">
|
|
831
|
+
|
|
832
|
+
<li>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
<span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
</li>
|
|
840
|
+
|
|
841
|
+
</ul>
|
|
842
|
+
|
|
843
|
+
</div><table class="source_code">
|
|
844
|
+
<tr>
|
|
845
|
+
<td>
|
|
846
|
+
<pre class="lines">
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
63
|
|
850
|
+
64
|
|
851
|
+
65
|
|
852
|
+
66
|
|
853
|
+
67
|
|
854
|
+
68
|
|
855
|
+
69
|
|
856
|
+
70</pre>
|
|
857
|
+
</td>
|
|
858
|
+
<td>
|
|
859
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 63</span>
|
|
860
|
+
|
|
861
|
+
<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span>
|
|
862
|
+
<span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
|
863
|
+
<span class='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
|
|
864
|
+
<span class='r identifier id'>r</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='WORKSHEET_R constant id'>WORKSHEET_R</span><span class='comma token'>,</span> <span class='WORKSHEET_PN constant id'>WORKSHEET_PN</span> <span class='mod op'>%</span> <span class='lparen token'>(</span><span class='r identifier id'>r</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
|
865
|
+
<span class='end end kw'>end</span>
|
|
866
|
+
<span class='r identifier id'>r</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='STYLES_R constant id'>STYLES_R</span><span class='comma token'>,</span> <span class='STYLES_PN constant id'>STYLES_PN</span><span class='rparen token'>)</span>
|
|
867
|
+
<span class='r identifier id'>r</span>
|
|
868
|
+
<span class='end end kw'>end</span>
|
|
869
|
+
</pre>
|
|
870
|
+
</td>
|
|
871
|
+
</tr>
|
|
872
|
+
</table>
|
|
873
|
+
</div>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<span id=""></span>
|
|
877
|
+
<span id="styles-instance_method"></span>
|
|
878
|
+
<div class="method_details ">
|
|
879
|
+
<p class="signature " id="styles-instance_method">
|
|
880
|
+
|
|
881
|
+
- (<tt><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>) <strong>styles</strong> <span class="extras">(readonly)</span>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
</p><div class="docstring">
|
|
886
|
+
<div class="discussion">
|
|
887
|
+
|
|
888
|
+
<div class="note notetag">
|
|
889
|
+
<strong>Note:</strong>
|
|
890
|
+
<div class='inline'><p>
|
|
891
|
+
The recommended way to manage styles is Styles#add_style
|
|
892
|
+
</p>
|
|
893
|
+
</div>
|
|
894
|
+
</div>
|
|
895
|
+
|
|
896
|
+
<p>
|
|
897
|
+
The styles associated with this workbook
|
|
898
|
+
</p>
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
</div>
|
|
902
|
+
</div>
|
|
903
|
+
<div class="tags">
|
|
904
|
+
|
|
905
|
+
<h3>Returns:</h3>
|
|
906
|
+
<ul class="return">
|
|
907
|
+
|
|
908
|
+
<li>
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
<span class='type'>(<tt><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>)</span>
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
</li>
|
|
916
|
+
|
|
917
|
+
</ul>
|
|
918
|
+
|
|
919
|
+
<h3>See Also:</h3>
|
|
920
|
+
<ul class="see">
|
|
921
|
+
|
|
922
|
+
<li>Style#add_style</li>
|
|
923
|
+
|
|
924
|
+
<li>Style</li>
|
|
925
|
+
|
|
926
|
+
</ul>
|
|
927
|
+
|
|
928
|
+
</div><table class="source_code">
|
|
929
|
+
<tr>
|
|
930
|
+
<td>
|
|
931
|
+
<pre class="lines">
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
59
|
|
935
|
+
60
|
|
936
|
+
61</pre>
|
|
937
|
+
</td>
|
|
938
|
+
<td>
|
|
939
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 59</span>
|
|
940
|
+
|
|
941
|
+
<span class='def def kw'>def</span> <span class='styles identifier id'>styles</span>
|
|
942
|
+
<span class='@styles ivar id'>@styles</span>
|
|
943
|
+
<span class='end end kw'>end</span>
|
|
944
|
+
</pre>
|
|
945
|
+
</td>
|
|
946
|
+
</tr>
|
|
947
|
+
</table>
|
|
948
|
+
</div>
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
<span id=""></span>
|
|
952
|
+
<span id="worksheets-instance_method"></span>
|
|
953
|
+
<div class="method_details ">
|
|
954
|
+
<p class="signature " id="worksheets-instance_method">
|
|
955
|
+
|
|
956
|
+
- (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>worksheets</strong> <span class="extras">(readonly)</span>
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
</p><div class="docstring">
|
|
961
|
+
<div class="discussion">
|
|
962
|
+
|
|
963
|
+
<div class="note notetag">
|
|
964
|
+
<strong>Note:</strong>
|
|
965
|
+
<div class='inline'><p>
|
|
966
|
+
The recommended way to manage worksheets is add_worksheet
|
|
967
|
+
</p>
|
|
968
|
+
</div>
|
|
969
|
+
</div>
|
|
970
|
+
|
|
971
|
+
<p>
|
|
972
|
+
A collection of worksheets associated with this workbook.
|
|
973
|
+
</p>
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
</div>
|
|
977
|
+
</div>
|
|
978
|
+
<div class="tags">
|
|
979
|
+
|
|
980
|
+
<h3>Returns:</h3>
|
|
981
|
+
<ul class="return">
|
|
982
|
+
|
|
983
|
+
<li>
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
<span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
</li>
|
|
991
|
+
|
|
992
|
+
</ul>
|
|
993
|
+
|
|
994
|
+
<h3>See Also:</h3>
|
|
995
|
+
<ul class="see">
|
|
996
|
+
|
|
997
|
+
<li><span class='object_link'><a href="#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">#add_worksheet</a></span></li>
|
|
998
|
+
|
|
999
|
+
<li><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Axlsx::Worksheet</a></span></li>
|
|
1000
|
+
|
|
1001
|
+
</ul>
|
|
1002
|
+
|
|
1003
|
+
</div><table class="source_code">
|
|
1004
|
+
<tr>
|
|
1005
|
+
<td>
|
|
1006
|
+
<pre class="lines">
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
38
|
|
1010
|
+
39
|
|
1011
|
+
40</pre>
|
|
1012
|
+
</td>
|
|
1013
|
+
<td>
|
|
1014
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 38</span>
|
|
1015
|
+
|
|
1016
|
+
<span class='def def kw'>def</span> <span class='worksheets identifier id'>worksheets</span>
|
|
1017
|
+
<span class='@worksheets ivar id'>@worksheets</span>
|
|
1018
|
+
<span class='end end kw'>end</span>
|
|
1019
|
+
</pre>
|
|
1020
|
+
</td>
|
|
1021
|
+
</tr>
|
|
1022
|
+
</table>
|
|
1023
|
+
</div>
|
|
1024
|
+
|
|
1025
|
+
</div>
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
<div id="class_method_details" class="method_details_list">
|
|
1029
|
+
<h2>Class Method Details</h2>
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
<div class="method_details first">
|
|
1033
|
+
<p class="signature first" id="date1904-class_method">
|
|
1034
|
+
|
|
1035
|
+
+ (<tt>Boolean</tt>) <strong>date1904</strong>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
</p><div class="docstring">
|
|
1040
|
+
<div class="discussion">
|
|
1041
|
+
<p>
|
|
1042
|
+
retrieves the date1904 attribute
|
|
1043
|
+
</p>
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
</div>
|
|
1047
|
+
</div>
|
|
1048
|
+
<div class="tags">
|
|
1049
|
+
|
|
1050
|
+
<h3>Returns:</h3>
|
|
1051
|
+
<ul class="return">
|
|
1052
|
+
|
|
1053
|
+
<li>
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
</li>
|
|
1061
|
+
|
|
1062
|
+
</ul>
|
|
1063
|
+
|
|
1064
|
+
</div><table class="source_code">
|
|
1065
|
+
<tr>
|
|
1066
|
+
<td>
|
|
1067
|
+
<pre class="lines">
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
93</pre>
|
|
1071
|
+
</td>
|
|
1072
|
+
<td>
|
|
1073
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 93</span>
|
|
1074
|
+
|
|
1075
|
+
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span>
|
|
1076
|
+
</pre>
|
|
1077
|
+
</td>
|
|
1078
|
+
</tr>
|
|
1079
|
+
</table>
|
|
1080
|
+
</div>
|
|
1081
|
+
|
|
1082
|
+
<div class="method_details ">
|
|
1083
|
+
<p class="signature " id="date1904=-class_method">
|
|
1084
|
+
|
|
1085
|
+
+ (<tt>Boolean</tt>) <strong>date1904=</strong>(v)
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
</p><div class="docstring">
|
|
1090
|
+
<div class="discussion">
|
|
1091
|
+
<p>
|
|
1092
|
+
Sets the date1904 attribute to the provided boolean
|
|
1093
|
+
</p>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
</div>
|
|
1097
|
+
</div>
|
|
1098
|
+
<div class="tags">
|
|
1099
|
+
|
|
1100
|
+
<h3>Returns:</h3>
|
|
1101
|
+
<ul class="return">
|
|
1102
|
+
|
|
1103
|
+
<li>
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
</li>
|
|
1111
|
+
|
|
1112
|
+
</ul>
|
|
1113
|
+
|
|
1114
|
+
</div><table class="source_code">
|
|
1115
|
+
<tr>
|
|
1116
|
+
<td>
|
|
1117
|
+
<pre class="lines">
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
89</pre>
|
|
1121
|
+
</td>
|
|
1122
|
+
<td>
|
|
1123
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 89</span>
|
|
1124
|
+
|
|
1125
|
+
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_boolean identifier id'>validate_boolean</span> <span class='v identifier id'>v</span><span class='semicolon token'>;</span> <span class='@@date1904 ivar id'>@@date1904</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span>
|
|
1126
|
+
</pre>
|
|
1127
|
+
</td>
|
|
1128
|
+
</tr>
|
|
1129
|
+
</table>
|
|
1130
|
+
</div>
|
|
1131
|
+
|
|
1132
|
+
</div>
|
|
1133
|
+
|
|
1134
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1135
|
+
<h2>Instance Method Details</h2>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
<div class="method_details first">
|
|
1139
|
+
<p class="signature first" id="add_worksheet-instance_method">
|
|
1140
|
+
|
|
1141
|
+
- (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... }
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
</p><div class="docstring">
|
|
1146
|
+
<div class="discussion">
|
|
1147
|
+
<p>
|
|
1148
|
+
Adds a worksheet to this workbook
|
|
1149
|
+
</p>
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
</div>
|
|
1153
|
+
</div>
|
|
1154
|
+
<div class="tags">
|
|
1155
|
+
<h3>Parameters:</h3>
|
|
1156
|
+
<ul class="param">
|
|
1157
|
+
|
|
1158
|
+
<li>
|
|
1159
|
+
|
|
1160
|
+
<span class='name'>options</span>
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
—
|
|
1170
|
+
<div class='inline'><p>
|
|
1171
|
+
a customizable set of options
|
|
1172
|
+
</p>
|
|
1173
|
+
</div>
|
|
1174
|
+
|
|
1175
|
+
</li>
|
|
1176
|
+
|
|
1177
|
+
</ul>
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
1183
|
+
<ul class="option">
|
|
1184
|
+
|
|
1185
|
+
<li>
|
|
1186
|
+
<span class="name">name</span>
|
|
1187
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1188
|
+
<span class="default">
|
|
1189
|
+
|
|
1190
|
+
</span>
|
|
1191
|
+
— <div class='inline'><p>
|
|
1192
|
+
The name of the worksheet.
|
|
1193
|
+
</p>
|
|
1194
|
+
</div>
|
|
1195
|
+
</li>
|
|
1196
|
+
|
|
1197
|
+
</ul>
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
<h3>Yields:</h3>
|
|
1201
|
+
<ul class="yield">
|
|
1202
|
+
|
|
1203
|
+
<li>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
<span class='type'>(<tt>worksheet</tt>)</span>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
</li>
|
|
1211
|
+
|
|
1212
|
+
</ul>
|
|
1213
|
+
<h3>Returns:</h3>
|
|
1214
|
+
<ul class="return">
|
|
1215
|
+
|
|
1216
|
+
<li>
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
<span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
</li>
|
|
1224
|
+
|
|
1225
|
+
</ul>
|
|
1226
|
+
|
|
1227
|
+
<h3>See Also:</h3>
|
|
1228
|
+
<ul class="see">
|
|
1229
|
+
|
|
1230
|
+
<li><span class='object_link'><a href="Worksheet.html#initialize-instance_method" title="Axlsx::Worksheet#initialize (method)">Axlsx::Worksheet#initialize</a></span></li>
|
|
1231
|
+
|
|
1232
|
+
</ul>
|
|
1233
|
+
|
|
1234
|
+
</div><table class="source_code">
|
|
1235
|
+
<tr>
|
|
1236
|
+
<td>
|
|
1237
|
+
<pre class="lines">
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
99
|
|
1241
|
+
100
|
|
1242
|
+
101
|
|
1243
|
+
102
|
|
1244
|
+
103</pre>
|
|
1245
|
+
</td>
|
|
1246
|
+
<td>
|
|
1247
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 99</span>
|
|
1248
|
+
|
|
1249
|
+
<span class='def def kw'>def</span> <span class='add_worksheet identifier id'>add_worksheet</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1250
|
+
<span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='Worksheet constant id'>Worksheet</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
|
|
1251
|
+
<span class='yield yield kw'>yield</span> <span class='worksheet identifier id'>worksheet</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
|
|
1252
|
+
<span class='worksheet identifier id'>worksheet</span>
|
|
1253
|
+
<span class='end end kw'>end</span>
|
|
1254
|
+
</pre>
|
|
1255
|
+
</td>
|
|
1256
|
+
</tr>
|
|
1257
|
+
</table>
|
|
1258
|
+
</div>
|
|
1259
|
+
|
|
1260
|
+
<div class="method_details ">
|
|
1261
|
+
<p class="signature " id="to_xml-instance_method">
|
|
1262
|
+
|
|
1263
|
+
- (<tt>String</tt>) <strong>to_xml</strong>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
</p><div class="docstring">
|
|
1268
|
+
<div class="discussion">
|
|
1269
|
+
<p>
|
|
1270
|
+
Serializes the workbook document
|
|
1271
|
+
</p>
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
</div>
|
|
1275
|
+
</div>
|
|
1276
|
+
<div class="tags">
|
|
1277
|
+
|
|
1278
|
+
<h3>Returns:</h3>
|
|
1279
|
+
<ul class="return">
|
|
1280
|
+
|
|
1281
|
+
<li>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
</li>
|
|
1289
|
+
|
|
1290
|
+
</ul>
|
|
1291
|
+
|
|
1292
|
+
</div><table class="source_code">
|
|
1293
|
+
<tr>
|
|
1294
|
+
<td>
|
|
1295
|
+
<pre class="lines">
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
116
|
|
1299
|
+
117
|
|
1300
|
+
118
|
|
1301
|
+
119
|
|
1302
|
+
120
|
|
1303
|
+
121
|
|
1304
|
+
122
|
|
1305
|
+
123
|
|
1306
|
+
124
|
|
1307
|
+
125
|
|
1308
|
+
126
|
|
1309
|
+
127
|
|
1310
|
+
128
|
|
1311
|
+
129</pre>
|
|
1312
|
+
</td>
|
|
1313
|
+
<td>
|
|
1314
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 116</span>
|
|
1315
|
+
|
|
1316
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
|
|
1317
|
+
<span class='add_worksheet identifier id'>add_worksheet</span> <span class='unless unless_mod kw'>unless</span> <span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>0</span>
|
|
1318
|
+
<span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
|
|
1319
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
1320
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbookPr identifier id'>workbookPr</span><span class='lparen token'>(</span><span class='symbol val'>:date1904=</span><span class='gt op'>></span><span class='@@date1904 ivar id'>@@date1904</span><span class='rparen token'>)</span>
|
|
1321
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheets identifier id'>sheets</span> <span class='lbrace token'>{</span>
|
|
1322
|
+
<span class='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span>
|
|
1323
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheet identifier id'>sheet</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:sheetId=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:"r:id"</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='rId identifier id'>rId</span><span class='rparen token'>)</span>
|
|
1324
|
+
<span class='end end kw'>end</span>
|
|
1325
|
+
<span class='rbrace token'>}</span>
|
|
1326
|
+
<span class='rbrace token'>}</span>
|
|
1327
|
+
<span class='end end kw'>end</span>
|
|
1328
|
+
<span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='symbol val'>:indent=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span>
|
|
1329
|
+
<span class='end end kw'>end</span>
|
|
1330
|
+
</pre>
|
|
1331
|
+
</td>
|
|
1332
|
+
</tr>
|
|
1333
|
+
</table>
|
|
1334
|
+
</div>
|
|
1335
|
+
|
|
1336
|
+
</div>
|
|
1337
|
+
|
|
1338
|
+
</div>
|
|
1339
|
+
|
|
1340
|
+
<div id="footer">
|
|
1341
|
+
Generated on Tue Nov 22 00:27:52 2011 by
|
|
1342
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1343
|
+
0.7.3 (ruby-1.8.7).
|
|
1344
|
+
</div>
|
|
1345
|
+
|
|
1346
|
+
</body>
|
|
1347
|
+
</html>
|