axlsx 1.0.11 → 1.0.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (145) hide show
  1. data/.yardopts +4 -0
  2. data/README.md +7 -4
  3. data/examples/example.rb +6 -4
  4. data/examples/example.rb~ +112 -0
  5. data/lib/schema/dc.xsd~ +118 -0
  6. data/lib/schema/dcterms.xsd~ +331 -0
  7. data/lib/schema/opc-coreProperties.xsd~ +50 -0
  8. metadata +43 -193
  9. data/Gemfile +0 -3
  10. data/Gemfile.lock +0 -29
  11. data/axlsx.gemspec +0 -42
  12. data/doc/Axlsx.html +0 -2718
  13. data/doc/Axlsx/App.html +0 -2640
  14. data/doc/Axlsx/Axis.html +0 -1075
  15. data/doc/Axlsx/Bar3DChart.html +0 -1182
  16. data/doc/Axlsx/BarSeries.html +0 -711
  17. data/doc/Axlsx/Border.html +0 -779
  18. data/doc/Axlsx/BorderPr.html +0 -709
  19. data/doc/Axlsx/CatAxis.html +0 -769
  20. data/doc/Axlsx/CatAxisData.html +0 -397
  21. data/doc/Axlsx/Cell.html +0 -3187
  22. data/doc/Axlsx/CellAlignment.html +0 -1247
  23. data/doc/Axlsx/CellProtection.html +0 -565
  24. data/doc/Axlsx/CellStyle.html +0 -949
  25. data/doc/Axlsx/Chart.html +0 -1692
  26. data/doc/Axlsx/Color.html +0 -670
  27. data/doc/Axlsx/ContentType.html +0 -335
  28. data/doc/Axlsx/Core.html +0 -465
  29. data/doc/Axlsx/DataTypeValidator.html +0 -324
  30. data/doc/Axlsx/Default.html +0 -565
  31. data/doc/Axlsx/Drawing.html +0 -1264
  32. data/doc/Axlsx/Fill.html +0 -460
  33. data/doc/Axlsx/Font.html +0 -1554
  34. data/doc/Axlsx/GradientFill.html +0 -1026
  35. data/doc/Axlsx/GradientStop.html +0 -526
  36. data/doc/Axlsx/GraphicFrame.html +0 -642
  37. data/doc/Axlsx/Line3DChart.html +0 -1004
  38. data/doc/Axlsx/LineSeries.html +0 -605
  39. data/doc/Axlsx/Marker.html +0 -857
  40. data/doc/Axlsx/NumFmt.html +0 -562
  41. data/doc/Axlsx/OneCellAnchor.html +0 -982
  42. data/doc/Axlsx/Override.html +0 -552
  43. data/doc/Axlsx/Package.html +0 -825
  44. data/doc/Axlsx/Parser.html +0 -549
  45. data/doc/Axlsx/PatternFill.html +0 -681
  46. data/doc/Axlsx/Pic.html +0 -1701
  47. data/doc/Axlsx/PictureLocking.html +0 -1159
  48. data/doc/Axlsx/Pie3DChart.html +0 -489
  49. data/doc/Axlsx/PieSeries.html +0 -710
  50. data/doc/Axlsx/RegexValidator.html +0 -268
  51. data/doc/Axlsx/Relationship.html +0 -554
  52. data/doc/Axlsx/Relationships.html +0 -338
  53. data/doc/Axlsx/RestrictionValidator.html +0 -300
  54. data/doc/Axlsx/Row.html +0 -916
  55. data/doc/Axlsx/Scaling.html +0 -742
  56. data/doc/Axlsx/SerAxis.html +0 -641
  57. data/doc/Axlsx/Series.html +0 -813
  58. data/doc/Axlsx/SeriesTitle.html +0 -290
  59. data/doc/Axlsx/Styles.html +0 -1754
  60. data/doc/Axlsx/TableStyle.html +0 -705
  61. data/doc/Axlsx/TableStyleElement.html +0 -677
  62. data/doc/Axlsx/TableStyles.html +0 -594
  63. data/doc/Axlsx/Title.html +0 -543
  64. data/doc/Axlsx/TwoCellAnchor.html +0 -973
  65. data/doc/Axlsx/ValAxis.html +0 -538
  66. data/doc/Axlsx/ValAxisData.html +0 -321
  67. data/doc/Axlsx/View3D.html +0 -973
  68. data/doc/Axlsx/Workbook.html +0 -1630
  69. data/doc/Axlsx/Worksheet.html +0 -2682
  70. data/doc/Axlsx/Xf.html +0 -1780
  71. data/doc/_index.html +0 -649
  72. data/doc/class_list.html +0 -47
  73. data/doc/css/common.css +0 -1
  74. data/doc/css/full_list.css +0 -55
  75. data/doc/css/style.css +0 -322
  76. data/doc/file.LICENSE.html +0 -91
  77. data/doc/file.README.html +0 -338
  78. data/doc/file_list.html +0 -52
  79. data/doc/frames.html +0 -13
  80. data/doc/index.html +0 -338
  81. data/doc/js/app.js +0 -205
  82. data/doc/js/full_list.js +0 -167
  83. data/doc/js/jquery.js +0 -16
  84. data/doc/method_list.html +0 -3502
  85. data/doc/top-level-namespace.html +0 -103
  86. data/lib/axlsx.rb +0 -54
  87. data/lib/axlsx/content_type/content_type.rb +0 -23
  88. data/lib/axlsx/content_type/default.rb +0 -37
  89. data/lib/axlsx/content_type/override.rb +0 -37
  90. data/lib/axlsx/doc_props/app.rb +0 -178
  91. data/lib/axlsx/doc_props/core.rb +0 -34
  92. data/lib/axlsx/drawing/axis.rb +0 -90
  93. data/lib/axlsx/drawing/bar_3D_chart.rb +0 -128
  94. data/lib/axlsx/drawing/bar_series.rb +0 -64
  95. data/lib/axlsx/drawing/cat_axis.rb +0 -63
  96. data/lib/axlsx/drawing/cat_axis_data.rb +0 -35
  97. data/lib/axlsx/drawing/chart.rb +0 -179
  98. data/lib/axlsx/drawing/drawing.rb +0 -137
  99. data/lib/axlsx/drawing/graphic_frame.rb +0 -52
  100. data/lib/axlsx/drawing/line_3D_chart.rb +0 -106
  101. data/lib/axlsx/drawing/line_series.rb +0 -46
  102. data/lib/axlsx/drawing/marker.rb +0 -61
  103. data/lib/axlsx/drawing/one_cell_anchor.rb +0 -89
  104. data/lib/axlsx/drawing/pic.rb +0 -153
  105. data/lib/axlsx/drawing/picture_locking.rb +0 -72
  106. data/lib/axlsx/drawing/pie_3D_chart.rb +0 -41
  107. data/lib/axlsx/drawing/pie_series.rb +0 -56
  108. data/lib/axlsx/drawing/scaling.rb +0 -59
  109. data/lib/axlsx/drawing/ser_axis.rb +0 -45
  110. data/lib/axlsx/drawing/series.rb +0 -71
  111. data/lib/axlsx/drawing/series_title.rb +0 -22
  112. data/lib/axlsx/drawing/title.rb +0 -61
  113. data/lib/axlsx/drawing/two_cell_anchor.rb +0 -76
  114. data/lib/axlsx/drawing/val_axis.rb +0 -34
  115. data/lib/axlsx/drawing/val_axis_data.rb +0 -28
  116. data/lib/axlsx/drawing/view_3D.rb +0 -85
  117. data/lib/axlsx/package.rb +0 -214
  118. data/lib/axlsx/rels/relationship.rb +0 -44
  119. data/lib/axlsx/rels/relationships.rb +0 -25
  120. data/lib/axlsx/stylesheet/border.rb +0 -57
  121. data/lib/axlsx/stylesheet/border_pr.rb +0 -68
  122. data/lib/axlsx/stylesheet/cell_alignment.rb +0 -105
  123. data/lib/axlsx/stylesheet/cell_protection.rb +0 -36
  124. data/lib/axlsx/stylesheet/cell_style.rb +0 -65
  125. data/lib/axlsx/stylesheet/color.rb +0 -69
  126. data/lib/axlsx/stylesheet/fill.rb +0 -32
  127. data/lib/axlsx/stylesheet/font.rb +0 -139
  128. data/lib/axlsx/stylesheet/gradient_fill.rb +0 -76
  129. data/lib/axlsx/stylesheet/gradient_stop.rb +0 -33
  130. data/lib/axlsx/stylesheet/num_fmt.rb +0 -63
  131. data/lib/axlsx/stylesheet/pattern_fill.rb +0 -66
  132. data/lib/axlsx/stylesheet/styles.rb +0 -298
  133. data/lib/axlsx/stylesheet/table_style.rb +0 -47
  134. data/lib/axlsx/stylesheet/table_style_element.rb +0 -71
  135. data/lib/axlsx/stylesheet/table_styles.rb +0 -39
  136. data/lib/axlsx/stylesheet/xf.rb +0 -138
  137. data/lib/axlsx/util/constants.rb +0 -216
  138. data/lib/axlsx/util/parser.rb +0 -43
  139. data/lib/axlsx/util/simple_typed_list.rb +0 -160
  140. data/lib/axlsx/util/validators.rb +0 -132
  141. data/lib/axlsx/version.rb +0 -4
  142. data/lib/axlsx/workbook/workbook.rb +0 -160
  143. data/lib/axlsx/workbook/worksheet/cell.rb +0 -340
  144. data/lib/axlsx/workbook/worksheet/row.rb +0 -107
  145. data/lib/axlsx/workbook/worksheet/worksheet.rb +0 -278
@@ -1,916 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
- <title>
7
- Class: Axlsx::Row
8
-
9
- &mdash; AXLSX
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- relpath = '..';
19
- if (relpath != '') relpath += '/';
20
- </script>
21
-
22
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
-
24
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
-
26
-
27
- </head>
28
- <body>
29
- <script type="text/javascript" charset="utf-8">
30
- if (window.top.frames.main) document.body.className = 'frames';
31
- </script>
32
-
33
- <div id="header">
34
- <div id="menu">
35
-
36
- <a href="../_index.html">Index (R)</a> &raquo;
37
- <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
38
- &raquo;
39
- <span class="title">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="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a>
159
-
160
-
161
-
162
- </span>
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
- <span class="summary_desc"><div class='inline'><p>
175
- The worksheet this row belongs to.
176
- </p>
177
- </div></span>
178
-
179
- </li>
180
-
181
-
182
- </ul>
183
-
184
-
185
-
186
-
187
-
188
- <h2>
189
- Instance Method Summary
190
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
191
- </h2>
192
-
193
- <ul class="summary">
194
-
195
- <li class="public ">
196
- <span class="summary_signature">
197
-
198
- <a href="#add_cell-instance_method" title="#add_cell (instance method)">- (Cell) <strong>add_cell</strong>(value = &quot;&quot;, options = {}) </a>
199
-
200
-
201
-
202
- </span>
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
- <span class="summary_desc"><div class='inline'><p>
212
- Adds a singel sell to the row based on the data provided and updates the
213
- worksheet&#8217;s autofit data.
214
- </p>
215
- </div></span>
216
-
217
- </li>
218
-
219
-
220
- <li class="public ">
221
- <span class="summary_signature">
222
-
223
- <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
224
-
225
-
226
-
227
- </span>
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
- <span class="summary_desc"><div class='inline'><p>
237
- The index of this row in the worksheet.
238
- </p>
239
- </div></span>
240
-
241
- </li>
242
-
243
-
244
- <li class="public ">
245
- <span class="summary_signature">
246
-
247
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Row) <strong>initialize</strong>(worksheet, values = [], options = {}) </a>
248
-
249
-
250
-
251
- </span>
252
-
253
- <span class="note title constructor">constructor</span>
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
- <span class="summary_desc"><div class='inline'><p>
263
- Creates a new row.
264
- </p>
265
- </div></span>
266
-
267
- </li>
268
-
269
-
270
- <li class="public ">
271
- <span class="summary_signature">
272
-
273
- <a href="#style%3D-instance_method" title="#style= (instance method)">- (Object) <strong>style=</strong>(style) </a>
274
-
275
-
276
-
277
- </span>
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
- <span class="summary_desc"><div class='inline'><p>
287
- sets the style for every cell in this row.
288
- </p>
289
- </div></span>
290
-
291
- </li>
292
-
293
-
294
- <li class="public ">
295
- <span class="summary_signature">
296
-
297
- <a href="#to_ary-instance_method" title="#to_ary (instance method)">- (Array) <strong>to_ary</strong> </a>
298
-
299
-
300
-
301
- </span>
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
- <span class="summary_desc"><div class='inline'><p>
311
- returns the cells in this row as an array This lets us transpose the rows
312
- into columns.
313
- </p>
314
- </div></span>
315
-
316
- </li>
317
-
318
-
319
- <li class="public ">
320
- <span class="summary_signature">
321
-
322
- <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
323
-
324
-
325
-
326
- </span>
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
- <span class="summary_desc"><div class='inline'><p>
336
- Serializes the row.
337
- </p>
338
- </div></span>
339
-
340
- </li>
341
-
342
-
343
- </ul>
344
-
345
-
346
- <div id="constructor_details" class="method_details_list">
347
- <h2>Constructor Details</h2>
348
-
349
- <div class="method_details first">
350
- <p class="signature first" id="initialize-instance_method">
351
-
352
- - (<tt><span class='object_link'><a href="" title="Axlsx::Row (class)">Row</a></span></tt>) <strong>initialize</strong>(worksheet, values = [], options = {})
353
-
354
-
355
-
356
- </p><div class="docstring">
357
- <div class="discussion">
358
- <p>
359
- Creates a new row. New Cell objects are created based on the values, types
360
- and style options. A new cell is created for each item in the values array.
361
- style and types options are applied as follows:
362
- </p>
363
- <pre class="code">
364
- <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>
365
- <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>
366
- <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>
367
- <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>
368
- <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>
369
- <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>
370
- </pre>
371
-
372
-
373
- </div>
374
- </div>
375
- <div class="tags">
376
- <h3>Parameters:</h3>
377
- <ul class="param">
378
-
379
- <li>
380
-
381
- <span class='name'>worksheet</span>
382
-
383
-
384
- <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
385
-
386
-
387
-
388
- </li>
389
-
390
- <li>
391
-
392
- <span class='name'>options</span>
393
-
394
-
395
- <span class='type'>(<tt>Hash</tt>)</span>
396
-
397
-
398
- <em class="default">(defaults to: <tt>{}</tt>)</em>
399
-
400
-
401
- &mdash;
402
- <div class='inline'><p>
403
- a customizable set of options
404
- </p>
405
- </div>
406
-
407
- </li>
408
-
409
- </ul>
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
- <h3>Options Hash (<tt>options</tt>):</h3>
419
- <ul class="option">
420
-
421
- <li>
422
- <span class="name">values</span>
423
- <span class="type">(<tt>Array</tt>)</span>
424
- <span class="default">
425
-
426
- </span>
427
-
428
- </li>
429
-
430
- <li>
431
- <span class="name">types</span>
432
- <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span>
433
- <span class="default">
434
-
435
- </span>
436
-
437
- </li>
438
-
439
- <li>
440
- <span class="name">style</span>
441
- <span class="type">(<tt>Array</tt>, <tt>Integer</tt>)</span>
442
- <span class="default">
443
-
444
- </span>
445
-
446
- </li>
447
-
448
- </ul>
449
-
450
-
451
-
452
- <h3>See Also:</h3>
453
- <ul class="see">
454
-
455
- <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>
456
-
457
- <li><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></li>
458
-
459
- </ul>
460
-
461
- </div><table class="source_code">
462
- <tr>
463
- <td>
464
- <pre class="lines">
465
-
466
-
467
- 29
468
- 30
469
- 31
470
- 32
471
- 33
472
- 34</pre>
473
- </td>
474
- <td>
475
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 29</span>
476
-
477
- <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>
478
- <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>
479
- <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>
480
- <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'>&lt;&lt;</span> <span class='self self kw'>self</span>
481
- <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>
482
- <span class='end end kw'>end</span>
483
- </pre>
484
- </td>
485
- </tr>
486
- </table>
487
- </div>
488
-
489
- </div>
490
-
491
- <div id="instance_attr_details" class="attr_details">
492
- <h2>Instance Attribute Details</h2>
493
-
494
-
495
- <span id=""></span>
496
- <span id="cells-instance_method"></span>
497
- <div class="method_details first">
498
- <p class="signature first" id="cells-instance_method">
499
-
500
- - (<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>
501
-
502
-
503
-
504
- </p><div class="docstring">
505
- <div class="discussion">
506
- <p>
507
- The cells this row holds
508
- </p>
509
-
510
-
511
- </div>
512
- </div>
513
- <div class="tags">
514
-
515
- <h3>Returns:</h3>
516
- <ul class="return">
517
-
518
- <li>
519
-
520
-
521
- <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
522
-
523
-
524
-
525
- </li>
526
-
527
- </ul>
528
-
529
- </div><table class="source_code">
530
- <tr>
531
- <td>
532
- <pre class="lines">
533
-
534
-
535
- 13
536
- 14
537
- 15</pre>
538
- </td>
539
- <td>
540
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 13</span>
541
-
542
- <span class='def def kw'>def</span> <span class='cells identifier id'>cells</span>
543
- <span class='@cells ivar id'>@cells</span>
544
- <span class='end end kw'>end</span>
545
- </pre>
546
- </td>
547
- </tr>
548
- </table>
549
- </div>
550
-
551
-
552
- <span id="worksheet=-instance_method"></span>
553
- <span id="worksheet-instance_method"></span>
554
- <div class="method_details ">
555
- <p class="signature " id="worksheet-instance_method">
556
-
557
- - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong>
558
-
559
-
560
-
561
- </p><div class="docstring">
562
- <div class="discussion">
563
- <p>
564
- The worksheet this row belongs to
565
- </p>
566
-
567
-
568
- </div>
569
- </div>
570
- <div class="tags">
571
-
572
- <h3>Returns:</h3>
573
- <ul class="return">
574
-
575
- <li>
576
-
577
-
578
- <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
579
-
580
-
581
-
582
- </li>
583
-
584
- </ul>
585
-
586
- </div><table class="source_code">
587
- <tr>
588
- <td>
589
- <pre class="lines">
590
-
591
-
592
- 9
593
- 10
594
- 11</pre>
595
- </td>
596
- <td>
597
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 9</span>
598
-
599
- <span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span>
600
- <span class='@worksheet ivar id'>@worksheet</span>
601
- <span class='end end kw'>end</span>
602
- </pre>
603
- </td>
604
- </tr>
605
- </table>
606
- </div>
607
-
608
- </div>
609
-
610
-
611
- <div id="instance_method_details" class="method_details_list">
612
- <h2>Instance Method Details</h2>
613
-
614
-
615
- <div class="method_details first">
616
- <p class="signature first" id="add_cell-instance_method">
617
-
618
- - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>add_cell</strong>(value = &quot;&quot;, options = {})
619
-
620
-
621
-
622
- </p><div class="docstring">
623
- <div class="discussion">
624
- <p>
625
- Adds a singel sell to the row based on the data provided and updates the
626
- worksheet&#8217;s autofit data.
627
- </p>
628
-
629
-
630
- </div>
631
- </div>
632
- <div class="tags">
633
-
634
- <h3>Returns:</h3>
635
- <ul class="return">
636
-
637
- <li>
638
-
639
-
640
- <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span>
641
-
642
-
643
-
644
- </li>
645
-
646
- </ul>
647
-
648
- </div><table class="source_code">
649
- <tr>
650
- <td>
651
- <pre class="lines">
652
-
653
-
654
- 51
655
- 52
656
- 53
657
- 54
658
- 55</pre>
659
- </td>
660
- <td>
661
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 51</span>
662
-
663
- <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'>&quot;&quot;</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>
664
- <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>
665
- <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span>
666
- <span class='c identifier id'>c</span>
667
- <span class='end end kw'>end</span>
668
- </pre>
669
- </td>
670
- </tr>
671
- </table>
672
- </div>
673
-
674
- <div class="method_details ">
675
- <p class="signature " id="index-instance_method">
676
-
677
- - (<tt>Integer</tt>) <strong>index</strong>
678
-
679
-
680
-
681
- </p><div class="docstring">
682
- <div class="discussion">
683
- <p>
684
- The index of this row in the worksheet
685
- </p>
686
-
687
-
688
- </div>
689
- </div>
690
- <div class="tags">
691
-
692
- <h3>Returns:</h3>
693
- <ul class="return">
694
-
695
- <li>
696
-
697
-
698
- <span class='type'>(<tt>Integer</tt>)</span>
699
-
700
-
701
-
702
- </li>
703
-
704
- </ul>
705
-
706
- </div><table class="source_code">
707
- <tr>
708
- <td>
709
- <pre class="lines">
710
-
711
-
712
- 38
713
- 39
714
- 40</pre>
715
- </td>
716
- <td>
717
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 38</span>
718
-
719
- <span class='def def kw'>def</span> <span class='index identifier id'>index</span>
720
- <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>
721
- <span class='end end kw'>end</span>
722
- </pre>
723
- </td>
724
- </tr>
725
- </table>
726
- </div>
727
-
728
- <div class="method_details ">
729
- <p class="signature " id="style=-instance_method">
730
-
731
- - (<tt>Object</tt>) <strong>style=</strong>(style)
732
-
733
-
734
-
735
- </p><div class="docstring">
736
- <div class="discussion">
737
- <p>
738
- sets the style for every cell in this row
739
- </p>
740
-
741
-
742
- </div>
743
- </div>
744
- <div class="tags">
745
-
746
-
747
- </div><table class="source_code">
748
- <tr>
749
- <td>
750
- <pre class="lines">
751
-
752
-
753
- 58
754
- 59
755
- 60
756
- 61
757
- 62
758
- 63</pre>
759
- </td>
760
- <td>
761
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 58</span>
762
-
763
- <span class='def def kw'>def</span> <span class='style= identifier id'>style=</span><span class='lparen token'>(</span><span class='style identifier id'>style</span><span class='rparen token'>)</span>
764
- <span class='cells identifier id'>cells</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='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span> <span class='bitor op'>|</span>
765
- <span class='s identifier id'>s</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='style identifier id'>style</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='colon op'>:</span> <span class='style identifier id'>style</span>
766
- <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='s identifier id'>s</span>
767
- <span class='end end kw'>end</span>
768
- <span class='end end kw'>end</span>
769
- </pre>
770
- </td>
771
- </tr>
772
- </table>
773
- </div>
774
-
775
- <div class="method_details ">
776
- <p class="signature " id="to_ary-instance_method">
777
-
778
- - (<tt>Array</tt>) <strong>to_ary</strong>
779
-
780
-
781
-
782
- </p><div class="docstring">
783
- <div class="discussion">
784
- <p>
785
- returns the cells in this row as an array This lets us transpose the rows
786
- into columns
787
- </p>
788
-
789
-
790
- </div>
791
- </div>
792
- <div class="tags">
793
-
794
- <h3>Returns:</h3>
795
- <ul class="return">
796
-
797
- <li>
798
-
799
-
800
- <span class='type'>(<tt>Array</tt>)</span>
801
-
802
-
803
-
804
- </li>
805
-
806
- </ul>
807
-
808
- </div><table class="source_code">
809
- <tr>
810
- <td>
811
- <pre class="lines">
812
-
813
-
814
- 68
815
- 69
816
- 70</pre>
817
- </td>
818
- <td>
819
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 68</span>
820
-
821
- <span class='def def kw'>def</span> <span class='to_ary identifier id'>to_ary</span>
822
- <span class='@cells ivar id'>@cells</span><span class='dot token'>.</span><span class='to_ary identifier id'>to_ary</span>
823
- <span class='end end kw'>end</span>
824
- </pre>
825
- </td>
826
- </tr>
827
- </table>
828
- </div>
829
-
830
- <div class="method_details ">
831
- <p class="signature " id="to_xml-instance_method">
832
-
833
- - (<tt>String</tt>) <strong>to_xml</strong>(xml)
834
-
835
-
836
-
837
- </p><div class="docstring">
838
- <div class="discussion">
839
- <p>
840
- Serializes the row
841
- </p>
842
-
843
-
844
- </div>
845
- </div>
846
- <div class="tags">
847
- <h3>Parameters:</h3>
848
- <ul class="param">
849
-
850
- <li>
851
-
852
- <span class='name'>xml</span>
853
-
854
-
855
- <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
856
-
857
-
858
-
859
- &mdash;
860
- <div class='inline'><p>
861
- The document builder instance this objects xml will be added to.
862
- </p>
863
- </div>
864
-
865
- </li>
866
-
867
- </ul>
868
-
869
- <h3>Returns:</h3>
870
- <ul class="return">
871
-
872
- <li>
873
-
874
-
875
- <span class='type'>(<tt>String</tt>)</span>
876
-
877
-
878
-
879
- </li>
880
-
881
- </ul>
882
-
883
- </div><table class="source_code">
884
- <tr>
885
- <td>
886
- <pre class="lines">
887
-
888
-
889
- 45
890
- 46
891
- 47</pre>
892
- </td>
893
- <td>
894
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 45</span>
895
-
896
- <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>
897
- <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'>&gt;</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>
898
- <span class='end end kw'>end</span>
899
- </pre>
900
- </td>
901
- </tr>
902
- </table>
903
- </div>
904
-
905
- </div>
906
-
907
- </div>
908
-
909
- <div id="footer">
910
- Generated on Mon Dec 5 14:21:21 2011 by
911
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
912
- 0.7.3 (ruby-1.8.7).
913
- </div>
914
-
915
- </body>
916
- </html>