axlsx 1.0.8 → 1.0.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (128) hide show
  1. data/CHANGELOG.md +14 -0
  2. data/README.md +22 -21
  3. data/Rakefile +1 -1
  4. data/axlsx.gemspec +36 -0
  5. data/doc/Axlsx.html +373 -559
  6. data/doc/Axlsx/App.html +257 -360
  7. data/doc/Axlsx/Axis.html +113 -144
  8. data/doc/Axlsx/Bar3DChart.html +122 -152
  9. data/doc/Axlsx/BarSeries.html +67 -81
  10. data/doc/Axlsx/Border.html +96 -119
  11. data/doc/Axlsx/BorderPr.html +89 -114
  12. data/doc/Axlsx/CatAxis.html +79 -104
  13. data/doc/Axlsx/CatAxisData.html +40 -54
  14. data/doc/Axlsx/Cell.html +193 -679
  15. data/doc/Axlsx/CellAlignment.html +116 -157
  16. data/doc/Axlsx/CellProtection.html +50 -68
  17. data/doc/Axlsx/CellStyle.html +78 -106
  18. data/doc/Axlsx/Chart.html +361 -432
  19. data/doc/Axlsx/Color.html +56 -78
  20. data/doc/Axlsx/ContentType.html +28 -41
  21. data/doc/Axlsx/Core.html +43 -55
  22. data/doc/Axlsx/DataTypeValidator.html +34 -43
  23. data/doc/Axlsx/Default.html +55 -81
  24. data/doc/Axlsx/Drawing.html +322 -412
  25. data/doc/Axlsx/Fill.html +34 -47
  26. data/doc/Axlsx/Font.html +157 -207
  27. data/doc/Axlsx/GradientFill.html +90 -122
  28. data/doc/Axlsx/GradientStop.html +36 -50
  29. data/doc/Axlsx/GraphicFrame.html +106 -130
  30. data/doc/Axlsx/Line3DChart.html +108 -134
  31. data/doc/Axlsx/LineSeries.html +58 -67
  32. data/doc/Axlsx/Marker.html +84 -111
  33. data/doc/Axlsx/NumFmt.html +83 -102
  34. data/doc/Axlsx/OneCellAnchor.html +158 -196
  35. data/doc/Axlsx/Override.html +60 -92
  36. data/doc/Axlsx/Package.html +190 -759
  37. data/doc/Axlsx/PatternFill.html +78 -99
  38. data/doc/Axlsx/Pic.html +451 -405
  39. data/doc/Axlsx/Pie3DChart.html +33 -42
  40. data/doc/Axlsx/PieSeries.html +68 -80
  41. data/doc/Axlsx/RegexValidator.html +15 -20
  42. data/doc/Axlsx/Relationship.html +49 -66
  43. data/doc/Axlsx/Relationships.html +28 -41
  44. data/doc/Axlsx/RestrictionValidator.html +23 -32
  45. data/doc/Axlsx/Row.html +132 -161
  46. data/doc/Axlsx/Scaling.html +71 -90
  47. data/doc/Axlsx/SerAxis.html +61 -79
  48. data/doc/Axlsx/Series.html +125 -201
  49. data/doc/Axlsx/SeriesTitle.html +26 -31
  50. data/doc/Axlsx/Styles.html +286 -355
  51. data/doc/Axlsx/TableStyle.html +62 -87
  52. data/doc/Axlsx/TableStyleElement.html +84 -104
  53. data/doc/Axlsx/TableStyles.html +59 -82
  54. data/doc/Axlsx/Title.html +58 -155
  55. data/doc/Axlsx/TwoCellAnchor.html +165 -204
  56. data/doc/Axlsx/ValAxis.html +39 -53
  57. data/doc/Axlsx/ValAxisData.html +29 -39
  58. data/doc/Axlsx/View3D.html +93 -122
  59. data/doc/Axlsx/Workbook.html +359 -362
  60. data/doc/Axlsx/Worksheet.html +471 -816
  61. data/doc/Axlsx/Xf.html +341 -296
  62. data/doc/_index.html +7 -11
  63. data/doc/class_list.html +1 -1
  64. data/doc/file.LICENSE.html +86 -0
  65. data/doc/file.README.html +105 -107
  66. data/doc/file_list.html +3 -0
  67. data/doc/frames.html +1 -1
  68. data/doc/index.html +105 -107
  69. data/doc/method_list.html +426 -602
  70. data/doc/top-level-namespace.html +3 -3
  71. data/examples/example.rb +20 -1
  72. data/lib/axlsx.rb +20 -15
  73. data/lib/axlsx/content_type/default.rb +8 -3
  74. data/lib/axlsx/content_type/override.rb +11 -4
  75. data/lib/axlsx/doc_props/app.rb +53 -23
  76. data/lib/axlsx/drawing/axis.rb +16 -5
  77. data/lib/axlsx/drawing/bar_3D_chart.rb +15 -7
  78. data/lib/axlsx/drawing/bar_series.rb +7 -5
  79. data/lib/axlsx/drawing/cat_axis.rb +10 -3
  80. data/lib/axlsx/drawing/chart.rb +21 -15
  81. data/lib/axlsx/drawing/drawing.rb +16 -30
  82. data/lib/axlsx/drawing/graphic_frame.rb +2 -4
  83. data/lib/axlsx/drawing/line_3D_chart.rb +5 -2
  84. data/lib/axlsx/drawing/line_series.rb +6 -5
  85. data/lib/axlsx/drawing/marker.rb +9 -5
  86. data/lib/axlsx/drawing/one_cell_anchor.rb +7 -7
  87. data/lib/axlsx/drawing/pic.rb +29 -37
  88. data/lib/axlsx/drawing/pie_series.rb +7 -5
  89. data/lib/axlsx/drawing/scaling.rb +11 -5
  90. data/lib/axlsx/drawing/ser_axis.rb +6 -2
  91. data/lib/axlsx/drawing/series.rb +11 -11
  92. data/lib/axlsx/drawing/series_title.rb +1 -1
  93. data/lib/axlsx/drawing/title.rb +5 -12
  94. data/lib/axlsx/drawing/two_cell_anchor.rb +2 -3
  95. data/lib/axlsx/drawing/val_axis.rb +2 -2
  96. data/lib/axlsx/drawing/view_3D.rb +16 -9
  97. data/lib/axlsx/package.rb +25 -27
  98. data/lib/axlsx/rels/relationship.rb +4 -2
  99. data/lib/axlsx/stylesheet/border.rb +9 -4
  100. data/lib/axlsx/stylesheet/border_pr.rb +7 -4
  101. data/lib/axlsx/stylesheet/cell_alignment.rb +18 -9
  102. data/lib/axlsx/stylesheet/cell_protection.rb +5 -2
  103. data/lib/axlsx/stylesheet/cell_style.rb +12 -7
  104. data/lib/axlsx/stylesheet/color.rb +8 -6
  105. data/lib/axlsx/stylesheet/fill.rb +2 -1
  106. data/lib/axlsx/stylesheet/font.rb +24 -13
  107. data/lib/axlsx/stylesheet/gradient_fill.rb +16 -10
  108. data/lib/axlsx/stylesheet/gradient_stop.rb +5 -3
  109. data/lib/axlsx/stylesheet/num_fmt.rb +4 -2
  110. data/lib/axlsx/stylesheet/pattern_fill.rb +6 -4
  111. data/lib/axlsx/stylesheet/styles.rb +12 -12
  112. data/lib/axlsx/stylesheet/table_style.rb +6 -3
  113. data/lib/axlsx/stylesheet/table_style_element.rb +9 -4
  114. data/lib/axlsx/stylesheet/table_styles.rb +4 -4
  115. data/lib/axlsx/stylesheet/xf.rb +52 -31
  116. data/lib/axlsx/util/validators.rb +3 -3
  117. data/lib/axlsx/version.rb +1 -1
  118. data/lib/axlsx/workbook/workbook.rb +8 -9
  119. data/lib/axlsx/workbook/worksheet/cell.rb +25 -16
  120. data/lib/axlsx/workbook/worksheet/row.rb +2 -4
  121. data/lib/axlsx/workbook/worksheet/worksheet.rb +23 -32
  122. data/test/drawing/tc_one_cell_anchor.rb +1 -1
  123. metadata +135 -165
  124. data/doc/Axlsx/SimpleTypedList.html +0 -1686
  125. data/lib/schema/dc.xsd~ +0 -118
  126. data/lib/schema/dcterms.xsd~ +0 -331
  127. data/lib/schema/opc-coreProperties.xsd~ +0 -50
  128. data/test/drawing/tc_line_series.tc~ +0 -34
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: Axlsx::RestrictionValidator
8
8
 
9
- &mdash; Documentation by YARD 0.7.3
9
+ &mdash; AXLSX
10
10
 
11
11
  </title>
12
12
 
@@ -94,9 +94,8 @@
94
94
 
95
95
  <h2>Overview</h2><div class="docstring">
96
96
  <div class="discussion">
97
- <p>
98
- Validate a value against a specific list of allowed values.
99
- </p>
97
+
98
+ <p>Validate a value against a specific list of allowed values.</p>
100
99
 
101
100
 
102
101
  </div>
@@ -133,9 +132,8 @@ Validate a value against a specific list of allowed values.
133
132
 
134
133
 
135
134
 
136
- <span class="summary_desc"><div class='inline'><p>
137
- Perform validation.
138
- </p>
135
+ <span class="summary_desc"><div class='inline'>
136
+ <p>Perform validation.</p>
139
137
  </div></span>
140
138
 
141
139
  </li>
@@ -159,9 +157,8 @@ Perform validation.
159
157
 
160
158
  </p><div class="docstring">
161
159
  <div class="discussion">
162
- <p>
163
- Perform validation
164
- </p>
160
+
161
+ <p>Perform validation</p>
165
162
 
166
163
 
167
164
  </div>
@@ -180,9 +177,8 @@ Perform validation
180
177
 
181
178
 
182
179
  &mdash;
183
- <div class='inline'><p>
184
- The name of what is being validatied. This is included in the error message
185
- </p>
180
+ <div class='inline'>
181
+ <p>The name of what is being validatied. This is included in the error message</p>
186
182
  </div>
187
183
 
188
184
  </li>
@@ -197,9 +193,8 @@ The name of what is being validatied. This is included in the error message
197
193
 
198
194
 
199
195
  &mdash;
200
- <div class='inline'><p>
201
- The list of choices to validate against
202
- </p>
196
+ <div class='inline'>
197
+ <p>The list of choices to validate against</p>
203
198
  </div>
204
199
 
205
200
  </li>
@@ -214,9 +209,8 @@ The list of choices to validate against
214
209
 
215
210
 
216
211
  &mdash;
217
- <div class='inline'><p>
218
- The value to be validated
219
- </p>
212
+ <div class='inline'>
213
+ <p>The value to be validated</p>
220
214
  </div>
221
215
 
222
216
  </li>
@@ -234,9 +228,8 @@ The value to be validated
234
228
 
235
229
 
236
230
  &mdash;
237
- <div class='inline'><p>
238
- true if validation succeeds.
239
- </p>
231
+ <div class='inline'>
232
+ <p>true if validation succeeds.</p>
240
233
  </div>
241
234
 
242
235
  </li>
@@ -253,9 +246,8 @@ true if validation succeeds.
253
246
 
254
247
 
255
248
  &mdash;
256
- <div class='inline'><p>
257
- Raised if the value provided is not in the list of choices.
258
- </p>
249
+ <div class='inline'>
250
+ <p>Raised if the value provided is not in the list of choices.</p>
259
251
  </div>
260
252
 
261
253
  </li>
@@ -276,11 +268,10 @@ Raised if the value provided is not in the list of choices.
276
268
  <td>
277
269
  <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 10</span>
278
270
 
279
- <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span>
280
- <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_RESTRICTION constant id'>ERR_RESTRICTION</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span>
281
- <span class='true true kw'>true</span>
282
- <span class='end end kw'>end</span>
283
- </pre>
271
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id choices'>choices</span><span class='comma'>,</span> <span class='id v'>v</span><span class='rparen'>)</span>
272
+ <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='const'>ERR_RESTRICTION</span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='id v'>v</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='comma'>,</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id choices'>choices</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id choices'>choices</span><span class='period'>.</span><span class='id include?'>include?</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span>
273
+ <span class='kw'>true</span>
274
+ <span class='kw'>end</span></pre>
284
275
  </td>
285
276
  </tr>
286
277
  </table>
@@ -291,9 +282,9 @@ Raised if the value provided is not in the list of choices.
291
282
  </div>
292
283
 
293
284
  <div id="footer">
294
- Generated on Wed Nov 23 21:47:55 2011 by
285
+ Generated on Sat Nov 26 13:16:37 2011 by
295
286
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
296
- 0.7.3 (ruby-1.8.7).
287
+ 0.7.3 (ruby-1.9.3).
297
288
  </div>
298
289
 
299
290
  </body>
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: Axlsx::Row
8
8
 
9
- &mdash; Documentation by YARD 0.7.3
9
+ &mdash; AXLSX
10
10
 
11
11
  </title>
12
12
 
@@ -97,15 +97,13 @@
97
97
 
98
98
  <div class="note notetag">
99
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>
100
+ <div class='inline'>
101
+ <p>The recommended way to manage rows and cells is to use Worksheet#add_row</p>
103
102
  </div>
104
103
  </div>
105
104
 
106
- <p>
107
- A Row is a single row in a worksheet.
108
- </p>
105
+
106
+ <p>A Row is a single row in a worksheet.</p>
109
107
 
110
108
 
111
109
  </div>
@@ -144,9 +142,8 @@ A Row is a single row in a worksheet.
144
142
 
145
143
 
146
144
 
147
- <span class="summary_desc"><div class='inline'><p>
148
- The cells this row holds.
149
- </p>
145
+ <span class="summary_desc"><div class='inline'>
146
+ <p>The cells this row holds.</p>
150
147
  </div></span>
151
148
 
152
149
  </li>
@@ -155,14 +152,14 @@ The cells this row holds.
155
152
  <li class="public ">
156
153
  <span class="summary_signature">
157
154
 
158
- <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
155
+ <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a>
159
156
 
160
157
 
161
158
 
162
159
  </span>
163
160
 
164
161
 
165
- <span class="note title readonly">readonly</span>
162
+
166
163
 
167
164
 
168
165
 
@@ -171,58 +168,54 @@ The cells this row holds.
171
168
 
172
169
 
173
170
 
174
- <span class="summary_desc"><div class='inline'><p>
175
- The index of this row in the worksheet.
176
- </p>
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>The worksheet this row belongs to.</p>
177
173
  </div></span>
178
174
 
179
175
  </li>
180
176
 
181
177
 
182
- <li class="public ">
178
+ </ul>
179
+
180
+
181
+
182
+
183
+
184
+ <h2>
185
+ Instance Method Summary
186
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
187
+ </h2>
188
+
189
+ <ul class="summary">
190
+
191
+ <li class="public ">
183
192
  <span class="summary_signature">
184
193
 
185
- <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a>
194
+ <a href="#add_cell-instance_method" title="#add_cell (instance method)">- (Cell) <strong>add_cell</strong>(value = &quot;&quot;, options = {}) </a>
186
195
 
187
196
 
188
197
 
189
198
  </span>
190
199
 
191
200
 
192
-
193
-
194
-
195
201
 
196
202
 
197
203
 
198
204
 
199
205
 
200
206
 
201
- <span class="summary_desc"><div class='inline'><p>
202
- The worksheet this row belongs to.
203
- </p>
207
+ <span class="summary_desc"><div class='inline'>
208
+ <p>Adds a singel sell to the row based on the data provided and updates the
209
+ worksheet's autofit data.</p>
204
210
  </div></span>
205
211
 
206
212
  </li>
207
213
 
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
214
 
222
215
  <li class="public ">
223
216
  <span class="summary_signature">
224
217
 
225
- <a href="#add_cell-instance_method" title="#add_cell (instance method)">- (Cell) <strong>add_cell</strong>(value = &quot;&quot;, options = {}) </a>
218
+ <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
226
219
 
227
220
 
228
221
 
@@ -235,10 +228,8 @@ The worksheet this row belongs to.
235
228
 
236
229
 
237
230
 
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&#8217;s autofit data.
241
- </p>
231
+ <span class="summary_desc"><div class='inline'>
232
+ <p>The index of this row in the worksheet.</p>
242
233
  </div></span>
243
234
 
244
235
  </li>
@@ -262,9 +253,8 @@ worksheet&#8217;s autofit data.
262
253
 
263
254
 
264
255
 
265
- <span class="summary_desc"><div class='inline'><p>
266
- Creates a new row.
267
- </p>
256
+ <span class="summary_desc"><div class='inline'>
257
+ <p>Creates a new row.</p>
268
258
  </div></span>
269
259
 
270
260
  </li>
@@ -286,9 +276,8 @@ Creates a new row.
286
276
 
287
277
 
288
278
 
289
- <span class="summary_desc"><div class='inline'><p>
290
- Serializes the row.
291
- </p>
279
+ <span class="summary_desc"><div class='inline'>
280
+ <p>Serializes the row.</p>
292
281
  </div></span>
293
282
 
294
283
  </li>
@@ -309,19 +298,17 @@ Serializes the row.
309
298
 
310
299
  </p><div class="docstring">
311
300
  <div class="discussion">
312
- <p>
313
- Creates a new row. New Cell objects are created based on the values, types
301
+
302
+ <p>Creates a new row. New Cell objects are created based on the values, types
314
303
  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>
304
+ style and types options are applied as follows:</p>
305
+
306
+ <pre class="code">If the types option is defined and is a symbol it is applied to all the cells created.
307
+ If the types option is an array, cell types are applied by index for each cell
308
+ If the types option is not set, the cell will automatically determine its type.
309
+ If the style option is defined and is an Integer, it is applied to all cells created.
310
+ If the style option is an array, style is applied by index for each cell.
311
+ If the style option is not defined, the default style (0) is applied to each cell.</pre>
325
312
 
326
313
 
327
314
  </div>
@@ -353,9 +340,8 @@ style and types options are applied as follows:
353
340
 
354
341
 
355
342
  &mdash;
356
- <div class='inline'><p>
357
- a customizable set of options
358
- </p>
343
+ <div class='inline'>
344
+ <p>a customizable set of options</p>
359
345
  </div>
360
346
 
361
347
  </li>
@@ -418,23 +404,22 @@ a customizable set of options
418
404
  <pre class="lines">
419
405
 
420
406
 
407
+ 29
408
+ 30
409
+ 31
410
+ 32
421
411
  33
422
- 34
423
- 35
424
- 36
425
- 37
426
- 38</pre>
412
+ 34</pre>
427
413
  </td>
428
414
  <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'>&lt;&lt;</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>
415
+ <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 29</span>
416
+
417
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id worksheet'>worksheet</span><span class='comma'>,</span> <span class='id values'>values</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
418
+ <span class='kw'>self</span><span class='period'>.</span><span class='id worksheet'>worksheet</span> <span class='op'>=</span> <span class='id worksheet'>worksheet</span>
419
+ <span class='ivar'>@cells</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Cell</span>
420
+ <span class='ivar'>@worksheet</span><span class='period'>.</span><span class='id rows'>rows</span> <span class='op'>&lt;&lt;</span> <span class='kw'>self</span>
421
+ <span class='id array_to_cells'>array_to_cells</span><span class='lparen'>(</span><span class='id values'>values</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span>
422
+ <span class='kw'>end</span></pre>
438
423
  </td>
439
424
  </tr>
440
425
  </table>
@@ -457,9 +442,8 @@ a customizable set of options
457
442
 
458
443
  </p><div class="docstring">
459
444
  <div class="discussion">
460
- <p>
461
- The cells this row holds
462
- </p>
445
+
446
+ <p>The cells this row holds</p>
463
447
 
464
448
 
465
449
  </div>
@@ -493,30 +477,28 @@ The cells this row holds
493
477
  <td>
494
478
  <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 13</span>
495
479
 
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>
480
+ <span class='kw'>def</span> <span class='id cells'>cells</span>
481
+ <span class='ivar'>@cells</span>
482
+ <span class='kw'>end</span></pre>
500
483
  </td>
501
484
  </tr>
502
485
  </table>
503
486
  </div>
504
487
 
505
488
 
506
- <span id=""></span>
507
- <span id="index-instance_method"></span>
489
+ <span id="worksheet=-instance_method"></span>
490
+ <span id="worksheet-instance_method"></span>
508
491
  <div class="method_details ">
509
- <p class="signature " id="index-instance_method">
492
+ <p class="signature " id="worksheet-instance_method">
510
493
 
511
- - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span>
494
+ - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong>
512
495
 
513
496
 
514
497
 
515
498
  </p><div class="docstring">
516
499
  <div class="discussion">
517
- <p>
518
- The index of this row in the worksheet
519
- </p>
500
+
501
+ <p>The worksheet this row belongs to</p>
520
502
 
521
503
 
522
504
  </div>
@@ -529,7 +511,7 @@ The index of this row in the worksheet
529
511
  <li>
530
512
 
531
513
 
532
- <span class='type'>(<tt>Integer</tt>)</span>
514
+ <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
533
515
 
534
516
 
535
517
 
@@ -543,37 +525,40 @@ The index of this row in the worksheet
543
525
  <pre class="lines">
544
526
 
545
527
 
546
- 17
547
- 18
548
- 19</pre>
528
+ 9
529
+ 10
530
+ 11</pre>
549
531
  </td>
550
532
  <td>
551
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 17</span>
533
+ <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 9</span>
552
534
 
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>
535
+ <span class='kw'>def</span> <span class='id worksheet'>worksheet</span>
536
+ <span class='ivar'>@worksheet</span>
537
+ <span class='kw'>end</span></pre>
557
538
  </td>
558
539
  </tr>
559
540
  </table>
560
541
  </div>
561
542
 
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">
543
+ </div>
544
+
545
+
546
+ <div id="instance_method_details" class="method_details_list">
547
+ <h2>Instance Method Details</h2>
548
+
549
+
550
+ <div class="method_details first">
551
+ <p class="signature first" id="add_cell-instance_method">
567
552
 
568
- - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong>
553
+ - (<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 = {})
569
554
 
570
555
 
571
556
 
572
557
  </p><div class="docstring">
573
558
  <div class="discussion">
574
- <p>
575
- The worksheet this row belongs to
576
- </p>
559
+
560
+ <p>Adds a singel sell to the row based on the data provided and updates the
561
+ worksheet's autofit data.</p>
577
562
 
578
563
 
579
564
  </div>
@@ -586,7 +571,7 @@ The worksheet this row belongs to
586
571
  <li>
587
572
 
588
573
 
589
- <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
574
+ <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span>
590
575
 
591
576
 
592
577
 
@@ -600,42 +585,36 @@ The worksheet this row belongs to
600
585
  <pre class="lines">
601
586
 
602
587
 
603
- 9
604
- 10
605
- 11</pre>
588
+ 51
589
+ 52
590
+ 53
591
+ 54
592
+ 55</pre>
606
593
  </td>
607
594
  <td>
608
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 9</span>
595
+ <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 51</span>
609
596
 
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>
597
+ <span class='kw'>def</span> <span class='id add_cell'>add_cell</span><span class='lparen'>(</span><span class='id value'>value</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
598
+ <span class='id c'>c</span> <span class='op'>=</span> <span class='const'>Cell</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id value'>value</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span>
599
+ <span class='id update_auto_fit_data'>update_auto_fit_data</span>
600
+ <span class='id c'>c</span>
601
+ <span class='kw'>end</span></pre>
614
602
  </td>
615
603
  </tr>
616
604
  </table>
617
605
  </div>
618
606
 
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">
607
+ <div class="method_details ">
608
+ <p class="signature " id="index-instance_method">
628
609
 
629
- - (<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 = {})
610
+ - (<tt>Integer</tt>) <strong>index</strong>
630
611
 
631
612
 
632
613
 
633
614
  </p><div class="docstring">
634
615
  <div class="discussion">
635
- <p>
636
- Adds a singel sell to the row based on the data provided and updates the
637
- worksheet&#8217;s autofit data.
638
- </p>
616
+
617
+ <p>The index of this row in the worksheet</p>
639
618
 
640
619
 
641
620
  </div>
@@ -648,7 +627,7 @@ worksheet&#8217;s autofit data.
648
627
  <li>
649
628
 
650
629
 
651
- <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span>
630
+ <span class='type'>(<tt>Integer</tt>)</span>
652
631
 
653
632
 
654
633
 
@@ -662,21 +641,16 @@ worksheet&#8217;s autofit data.
662
641
  <pre class="lines">
663
642
 
664
643
 
665
- 53
666
- 54
667
- 55
668
- 56
669
- 57</pre>
644
+ 38
645
+ 39
646
+ 40</pre>
670
647
  </td>
671
648
  <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'>&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>
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>
649
+ <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 38</span>
650
+
651
+ <span class='kw'>def</span> <span class='id index'>index</span>
652
+ <span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
653
+ <span class='kw'>end</span></pre>
680
654
  </td>
681
655
  </tr>
682
656
  </table>
@@ -691,9 +665,8 @@ worksheet&#8217;s autofit data.
691
665
 
692
666
  </p><div class="docstring">
693
667
  <div class="discussion">
694
- <p>
695
- Serializes the row
696
- </p>
668
+
669
+ <p>Serializes the row</p>
697
670
 
698
671
 
699
672
  </div>
@@ -712,9 +685,8 @@ Serializes the row
712
685
 
713
686
 
714
687
  &mdash;
715
- <div class='inline'><p>
716
- The document builder instance this objects xml will be added to.
717
- </p>
688
+ <div class='inline'>
689
+ <p>The document builder instance this objects xml will be added to.</p>
718
690
  </div>
719
691
 
720
692
  </li>
@@ -741,17 +713,16 @@ The document builder instance this objects xml will be added to.
741
713
  <pre class="lines">
742
714
 
743
715
 
744
- 47
745
- 48
746
- 49</pre>
716
+ 45
717
+ 46
718
+ 47</pre>
747
719
  </td>
748
720
  <td>
749
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 47</span>
721
+ <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 45</span>
750
722
 
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'>&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>
753
- <span class='end end kw'>end</span>
754
- </pre>
723
+ <span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span>
724
+ <span class='id xml'>xml</span><span class='period'>.</span><span class='id row'>row</span><span class='lparen'>(</span><span class='symbol'>:r</span> <span class='op'>=&gt;</span> <span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='ivar'>@cells</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id cell'>cell</span><span class='op'>|</span> <span class='id cell'>cell</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
725
+ <span class='kw'>end</span></pre>
755
726
  </td>
756
727
  </tr>
757
728
  </table>
@@ -762,9 +733,9 @@ The document builder instance this objects xml will be added to.
762
733
  </div>
763
734
 
764
735
  <div id="footer">
765
- Generated on Wed Nov 23 21:47:51 2011 by
736
+ Generated on Sat Nov 26 13:16:39 2011 by
766
737
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
767
- 0.7.3 (ruby-1.8.7).
738
+ 0.7.3 (ruby-1.9.3).
768
739
  </div>
769
740
 
770
741
  </body>