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
data/doc/Axlsx/Row.html
ADDED
|
@@ -0,0 +1,771 @@
|
|
|
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::Row
|
|
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 (R)</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">Row</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::Row
|
|
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::Row</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/worksheet/row.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
|
|
98
|
+
<div class="note notetag">
|
|
99
|
+
<strong>Note:</strong>
|
|
100
|
+
<div class='inline'><p>
|
|
101
|
+
The recommended way to manage rows and cells is to use Worksheet#add_row
|
|
102
|
+
</p>
|
|
103
|
+
</div>
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<p>
|
|
107
|
+
A Row is a single row in a worksheet.
|
|
108
|
+
</p>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
<div class="tags">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<h3>See Also:</h3>
|
|
117
|
+
<ul class="see">
|
|
118
|
+
|
|
119
|
+
<li><span class='object_link'><a href="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li>
|
|
120
|
+
|
|
121
|
+
</ul>
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
|
|
125
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
126
|
+
<ul class="summary">
|
|
127
|
+
|
|
128
|
+
<li class="public ">
|
|
129
|
+
<span class="summary_signature">
|
|
130
|
+
|
|
131
|
+
<a href="#cells-instance_method" title="#cells (instance method)">- (SimpleTypedList) <strong>cells</strong> </a>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
</span>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<span class="note title readonly">readonly</span>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
148
|
+
The cells this row holds.
|
|
149
|
+
</p>
|
|
150
|
+
</div></span>
|
|
151
|
+
|
|
152
|
+
</li>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<li class="public ">
|
|
156
|
+
<span class="summary_signature">
|
|
157
|
+
|
|
158
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</span>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<span class="note title readonly">readonly</span>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
175
|
+
The index of this row in the worksheet.
|
|
176
|
+
</p>
|
|
177
|
+
</div></span>
|
|
178
|
+
|
|
179
|
+
</li>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<li class="public ">
|
|
183
|
+
<span class="summary_signature">
|
|
184
|
+
|
|
185
|
+
<a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
</span>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
202
|
+
The worksheet this row belongs to.
|
|
203
|
+
</p>
|
|
204
|
+
</div></span>
|
|
205
|
+
|
|
206
|
+
</li>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</ul>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<h2>
|
|
216
|
+
Instance Method Summary
|
|
217
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
218
|
+
</h2>
|
|
219
|
+
|
|
220
|
+
<ul class="summary">
|
|
221
|
+
|
|
222
|
+
<li class="public ">
|
|
223
|
+
<span class="summary_signature">
|
|
224
|
+
|
|
225
|
+
<a href="#add_cell-instance_method" title="#add_cell (instance method)">- (Cell) <strong>add_cell</strong>(value = "", options = {}) </a>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
</span>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
239
|
+
Adds a singel sell to the row based on the data provided and updates the
|
|
240
|
+
worksheet’s autofit data.
|
|
241
|
+
</p>
|
|
242
|
+
</div></span>
|
|
243
|
+
|
|
244
|
+
</li>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
<li class="public ">
|
|
248
|
+
<span class="summary_signature">
|
|
249
|
+
|
|
250
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Row) <strong>initialize</strong>(worksheet, values = [], options = {}) </a>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
</span>
|
|
255
|
+
|
|
256
|
+
<span class="note title constructor">constructor</span>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
266
|
+
Creates a new row.
|
|
267
|
+
</p>
|
|
268
|
+
</div></span>
|
|
269
|
+
|
|
270
|
+
</li>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<li class="public ">
|
|
274
|
+
<span class="summary_signature">
|
|
275
|
+
|
|
276
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
290
|
+
Serializes the row.
|
|
291
|
+
</p>
|
|
292
|
+
</div></span>
|
|
293
|
+
|
|
294
|
+
</li>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
</ul>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<div id="constructor_details" class="method_details_list">
|
|
301
|
+
<h2>Constructor Details</h2>
|
|
302
|
+
|
|
303
|
+
<div class="method_details first">
|
|
304
|
+
<p class="signature first" id="initialize-instance_method">
|
|
305
|
+
|
|
306
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Row (class)">Row</a></span></tt>) <strong>initialize</strong>(worksheet, values = [], options = {})
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</p><div class="docstring">
|
|
311
|
+
<div class="discussion">
|
|
312
|
+
<p>
|
|
313
|
+
Creates a new row. New Cell objects are created based on the values, types
|
|
314
|
+
and style options. A new cell is created for each item in the values array.
|
|
315
|
+
style and types options are applied as follows:
|
|
316
|
+
</p>
|
|
317
|
+
<pre class="code">
|
|
318
|
+
<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='a identifier id'>a</span> <span class='symbol identifier id'>symbol</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='the identifier id'>the</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span>
|
|
319
|
+
<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='cell identifier id'>cell</span> <span class='types identifier id'>types</span> <span class='are identifier id'>are</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span>
|
|
320
|
+
<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='set identifier id'>set</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='cell identifier id'>cell</span> <span class='will identifier id'>will</span> <span class='automatically identifier id'>automatically</span> <span class='determine identifier id'>determine</span> <span class='its identifier id'>its</span> <span class='type identifier id'>type</span><span class='dot token'>.</span>
|
|
321
|
+
<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='Integer constant id'>Integer</span><span class='comma token'>,</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span>
|
|
322
|
+
<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='style identifier id'>style</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span>
|
|
323
|
+
<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='defined identifier id'>defined</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='default identifier id'>default</span> <span class='style identifier id'>style</span> <span class='lparen token'>(</span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span>
|
|
324
|
+
</pre>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
</div>
|
|
328
|
+
</div>
|
|
329
|
+
<div class="tags">
|
|
330
|
+
<h3>Parameters:</h3>
|
|
331
|
+
<ul class="param">
|
|
332
|
+
|
|
333
|
+
<li>
|
|
334
|
+
|
|
335
|
+
<span class='name'>worksheet</span>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
</li>
|
|
343
|
+
|
|
344
|
+
<li>
|
|
345
|
+
|
|
346
|
+
<span class='name'>options</span>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
—
|
|
356
|
+
<div class='inline'><p>
|
|
357
|
+
a customizable set of options
|
|
358
|
+
</p>
|
|
359
|
+
</div>
|
|
360
|
+
|
|
361
|
+
</li>
|
|
362
|
+
|
|
363
|
+
</ul>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
373
|
+
<ul class="option">
|
|
374
|
+
|
|
375
|
+
<li>
|
|
376
|
+
<span class="name">values</span>
|
|
377
|
+
<span class="type">(<tt>Array</tt>)</span>
|
|
378
|
+
<span class="default">
|
|
379
|
+
|
|
380
|
+
</span>
|
|
381
|
+
|
|
382
|
+
</li>
|
|
383
|
+
|
|
384
|
+
<li>
|
|
385
|
+
<span class="name">types</span>
|
|
386
|
+
<span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span>
|
|
387
|
+
<span class="default">
|
|
388
|
+
|
|
389
|
+
</span>
|
|
390
|
+
|
|
391
|
+
</li>
|
|
392
|
+
|
|
393
|
+
<li>
|
|
394
|
+
<span class="name">style</span>
|
|
395
|
+
<span class="type">(<tt>Array</tt>, <tt>Integer</tt>)</span>
|
|
396
|
+
<span class="default">
|
|
397
|
+
|
|
398
|
+
</span>
|
|
399
|
+
|
|
400
|
+
</li>
|
|
401
|
+
|
|
402
|
+
</ul>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<h3>See Also:</h3>
|
|
407
|
+
<ul class="see">
|
|
408
|
+
|
|
409
|
+
<li><span class='object_link'><a href="#array_to_cells-instance_method" title="Axlsx::Row#array_to_cells (method)">#array_to_cells</a></span></li>
|
|
410
|
+
|
|
411
|
+
<li><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></li>
|
|
412
|
+
|
|
413
|
+
</ul>
|
|
414
|
+
|
|
415
|
+
</div><table class="source_code">
|
|
416
|
+
<tr>
|
|
417
|
+
<td>
|
|
418
|
+
<pre class="lines">
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
33
|
|
422
|
+
34
|
|
423
|
+
35
|
|
424
|
+
36
|
|
425
|
+
37
|
|
426
|
+
38</pre>
|
|
427
|
+
</td>
|
|
428
|
+
<td>
|
|
429
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 33</span>
|
|
430
|
+
|
|
431
|
+
<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='worksheet identifier id'>worksheet</span><span class='comma token'>,</span> <span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='comma 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>
|
|
432
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span>
|
|
433
|
+
<span class='@cells ivar id'>@cells</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='Cell constant id'>Cell</span>
|
|
434
|
+
<span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span>
|
|
435
|
+
<span class='array_to_cells identifier id'>array_to_cells</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
|
|
436
|
+
<span class='end end kw'>end</span>
|
|
437
|
+
</pre>
|
|
438
|
+
</td>
|
|
439
|
+
</tr>
|
|
440
|
+
</table>
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
</div>
|
|
444
|
+
|
|
445
|
+
<div id="instance_attr_details" class="attr_details">
|
|
446
|
+
<h2>Instance Attribute Details</h2>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<span id=""></span>
|
|
450
|
+
<span id="cells-instance_method"></span>
|
|
451
|
+
<div class="method_details first">
|
|
452
|
+
<p class="signature first" id="cells-instance_method">
|
|
453
|
+
|
|
454
|
+
- (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cells</strong> <span class="extras">(readonly)</span>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
</p><div class="docstring">
|
|
459
|
+
<div class="discussion">
|
|
460
|
+
<p>
|
|
461
|
+
The cells this row holds
|
|
462
|
+
</p>
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
</div>
|
|
466
|
+
</div>
|
|
467
|
+
<div class="tags">
|
|
468
|
+
|
|
469
|
+
<h3>Returns:</h3>
|
|
470
|
+
<ul class="return">
|
|
471
|
+
|
|
472
|
+
<li>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
<span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
</li>
|
|
480
|
+
|
|
481
|
+
</ul>
|
|
482
|
+
|
|
483
|
+
</div><table class="source_code">
|
|
484
|
+
<tr>
|
|
485
|
+
<td>
|
|
486
|
+
<pre class="lines">
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
13
|
|
490
|
+
14
|
|
491
|
+
15</pre>
|
|
492
|
+
</td>
|
|
493
|
+
<td>
|
|
494
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 13</span>
|
|
495
|
+
|
|
496
|
+
<span class='def def kw'>def</span> <span class='cells identifier id'>cells</span>
|
|
497
|
+
<span class='@cells ivar id'>@cells</span>
|
|
498
|
+
<span class='end end kw'>end</span>
|
|
499
|
+
</pre>
|
|
500
|
+
</td>
|
|
501
|
+
</tr>
|
|
502
|
+
</table>
|
|
503
|
+
</div>
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
<span id=""></span>
|
|
507
|
+
<span id="index-instance_method"></span>
|
|
508
|
+
<div class="method_details ">
|
|
509
|
+
<p class="signature " id="index-instance_method">
|
|
510
|
+
|
|
511
|
+
- (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
</p><div class="docstring">
|
|
516
|
+
<div class="discussion">
|
|
517
|
+
<p>
|
|
518
|
+
The index of this row in the worksheet
|
|
519
|
+
</p>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
</div>
|
|
523
|
+
</div>
|
|
524
|
+
<div class="tags">
|
|
525
|
+
|
|
526
|
+
<h3>Returns:</h3>
|
|
527
|
+
<ul class="return">
|
|
528
|
+
|
|
529
|
+
<li>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
</li>
|
|
537
|
+
|
|
538
|
+
</ul>
|
|
539
|
+
|
|
540
|
+
</div><table class="source_code">
|
|
541
|
+
<tr>
|
|
542
|
+
<td>
|
|
543
|
+
<pre class="lines">
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
17
|
|
547
|
+
18
|
|
548
|
+
19</pre>
|
|
549
|
+
</td>
|
|
550
|
+
<td>
|
|
551
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 17</span>
|
|
552
|
+
|
|
553
|
+
<span class='def def kw'>def</span> <span class='index identifier id'>index</span>
|
|
554
|
+
<span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span>
|
|
555
|
+
<span class='end end kw'>end</span>
|
|
556
|
+
</pre>
|
|
557
|
+
</td>
|
|
558
|
+
</tr>
|
|
559
|
+
</table>
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<span id="worksheet=-instance_method"></span>
|
|
564
|
+
<span id="worksheet-instance_method"></span>
|
|
565
|
+
<div class="method_details ">
|
|
566
|
+
<p class="signature " id="worksheet-instance_method">
|
|
567
|
+
|
|
568
|
+
- (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
</p><div class="docstring">
|
|
573
|
+
<div class="discussion">
|
|
574
|
+
<p>
|
|
575
|
+
The worksheet this row belongs to
|
|
576
|
+
</p>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
</div>
|
|
580
|
+
</div>
|
|
581
|
+
<div class="tags">
|
|
582
|
+
|
|
583
|
+
<h3>Returns:</h3>
|
|
584
|
+
<ul class="return">
|
|
585
|
+
|
|
586
|
+
<li>
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
<span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
</li>
|
|
594
|
+
|
|
595
|
+
</ul>
|
|
596
|
+
|
|
597
|
+
</div><table class="source_code">
|
|
598
|
+
<tr>
|
|
599
|
+
<td>
|
|
600
|
+
<pre class="lines">
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
9
|
|
604
|
+
10
|
|
605
|
+
11</pre>
|
|
606
|
+
</td>
|
|
607
|
+
<td>
|
|
608
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 9</span>
|
|
609
|
+
|
|
610
|
+
<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span>
|
|
611
|
+
<span class='@worksheet ivar id'>@worksheet</span>
|
|
612
|
+
<span class='end end kw'>end</span>
|
|
613
|
+
</pre>
|
|
614
|
+
</td>
|
|
615
|
+
</tr>
|
|
616
|
+
</table>
|
|
617
|
+
</div>
|
|
618
|
+
|
|
619
|
+
</div>
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
<div id="instance_method_details" class="method_details_list">
|
|
623
|
+
<h2>Instance Method Details</h2>
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
<div class="method_details first">
|
|
627
|
+
<p class="signature first" id="add_cell-instance_method">
|
|
628
|
+
|
|
629
|
+
- (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>add_cell</strong>(value = "", options = {})
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
</p><div class="docstring">
|
|
634
|
+
<div class="discussion">
|
|
635
|
+
<p>
|
|
636
|
+
Adds a singel sell to the row based on the data provided and updates the
|
|
637
|
+
worksheet’s autofit data.
|
|
638
|
+
</p>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
</div>
|
|
642
|
+
</div>
|
|
643
|
+
<div class="tags">
|
|
644
|
+
|
|
645
|
+
<h3>Returns:</h3>
|
|
646
|
+
<ul class="return">
|
|
647
|
+
|
|
648
|
+
<li>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
<span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
</li>
|
|
656
|
+
|
|
657
|
+
</ul>
|
|
658
|
+
|
|
659
|
+
</div><table class="source_code">
|
|
660
|
+
<tr>
|
|
661
|
+
<td>
|
|
662
|
+
<pre class="lines">
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
53
|
|
666
|
+
54
|
|
667
|
+
55
|
|
668
|
+
56
|
|
669
|
+
57</pre>
|
|
670
|
+
</td>
|
|
671
|
+
<td>
|
|
672
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 53</span>
|
|
673
|
+
|
|
674
|
+
<span class='def def kw'>def</span> <span class='add_cell identifier id'>add_cell</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='assign token'>=</span><span class='string val'>""</span><span class='comma 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>
|
|
675
|
+
<span class='c identifier id'>c</span> <span class='assign token'>=</span> <span class='Cell constant id'>Cell</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='value identifier id'>value</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
|
|
676
|
+
<span class='update_auto_fit_data identifier id'>update_auto_fit_data</span>
|
|
677
|
+
<span class='c identifier id'>c</span>
|
|
678
|
+
<span class='end end kw'>end</span>
|
|
679
|
+
</pre>
|
|
680
|
+
</td>
|
|
681
|
+
</tr>
|
|
682
|
+
</table>
|
|
683
|
+
</div>
|
|
684
|
+
|
|
685
|
+
<div class="method_details ">
|
|
686
|
+
<p class="signature " id="to_xml-instance_method">
|
|
687
|
+
|
|
688
|
+
- (<tt>String</tt>) <strong>to_xml</strong>(xml)
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
</p><div class="docstring">
|
|
693
|
+
<div class="discussion">
|
|
694
|
+
<p>
|
|
695
|
+
Serializes the row
|
|
696
|
+
</p>
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
</div>
|
|
700
|
+
</div>
|
|
701
|
+
<div class="tags">
|
|
702
|
+
<h3>Parameters:</h3>
|
|
703
|
+
<ul class="param">
|
|
704
|
+
|
|
705
|
+
<li>
|
|
706
|
+
|
|
707
|
+
<span class='name'>xml</span>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
<span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
—
|
|
715
|
+
<div class='inline'><p>
|
|
716
|
+
The document builder instance this objects xml will be added to.
|
|
717
|
+
</p>
|
|
718
|
+
</div>
|
|
719
|
+
|
|
720
|
+
</li>
|
|
721
|
+
|
|
722
|
+
</ul>
|
|
723
|
+
|
|
724
|
+
<h3>Returns:</h3>
|
|
725
|
+
<ul class="return">
|
|
726
|
+
|
|
727
|
+
<li>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
</li>
|
|
735
|
+
|
|
736
|
+
</ul>
|
|
737
|
+
|
|
738
|
+
</div><table class="source_code">
|
|
739
|
+
<tr>
|
|
740
|
+
<td>
|
|
741
|
+
<pre class="lines">
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
47
|
|
745
|
+
48
|
|
746
|
+
49</pre>
|
|
747
|
+
</td>
|
|
748
|
+
<td>
|
|
749
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 47</span>
|
|
750
|
+
|
|
751
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
|
|
752
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='row identifier id'>row</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</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='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='@cells ivar id'>@cells</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='bitor op'>|</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span>
|
|
753
|
+
<span class='end end kw'>end</span>
|
|
754
|
+
</pre>
|
|
755
|
+
</td>
|
|
756
|
+
</tr>
|
|
757
|
+
</table>
|
|
758
|
+
</div>
|
|
759
|
+
|
|
760
|
+
</div>
|
|
761
|
+
|
|
762
|
+
</div>
|
|
763
|
+
|
|
764
|
+
<div id="footer">
|
|
765
|
+
Generated on Tue Nov 22 00:27:57 2011 by
|
|
766
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
767
|
+
0.7.3 (ruby-1.8.7).
|
|
768
|
+
</div>
|
|
769
|
+
|
|
770
|
+
</body>
|
|
771
|
+
</html>
|