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.
Files changed (71) hide show
  1. data/README.md +10 -9
  2. data/doc/Axlsx.html +2443 -0
  3. data/doc/Axlsx/App.html +2640 -0
  4. data/doc/Axlsx/Axis.html +1047 -0
  5. data/doc/Axlsx/Bar3DChart.html +1153 -0
  6. data/doc/Axlsx/BarSeries.html +764 -0
  7. data/doc/Axlsx/Border.html +775 -0
  8. data/doc/Axlsx/BorderPr.html +709 -0
  9. data/doc/Axlsx/CatAxis.html +766 -0
  10. data/doc/Axlsx/Cell.html +1623 -0
  11. data/doc/Axlsx/CellAlignment.html +1247 -0
  12. data/doc/Axlsx/CellProtection.html +565 -0
  13. data/doc/Axlsx/CellStyle.html +949 -0
  14. data/doc/Axlsx/Chart.html +1459 -0
  15. data/doc/Axlsx/Color.html +665 -0
  16. data/doc/Axlsx/ContentType.html +340 -0
  17. data/doc/Axlsx/Core.html +465 -0
  18. data/doc/Axlsx/DataTypeValidator.html +324 -0
  19. data/doc/Axlsx/Default.html +575 -0
  20. data/doc/Axlsx/Drawing.html +1154 -0
  21. data/doc/Axlsx/Fill.html +460 -0
  22. data/doc/Axlsx/Font.html +1554 -0
  23. data/doc/Axlsx/GradientFill.html +1026 -0
  24. data/doc/Axlsx/GradientStop.html +526 -0
  25. data/doc/Axlsx/GraphicFrame.html +646 -0
  26. data/doc/Axlsx/Line3DChart.html +921 -0
  27. data/doc/Axlsx/LineSeries.html +656 -0
  28. data/doc/Axlsx/Marker.html +857 -0
  29. data/doc/Axlsx/NumFmt.html +562 -0
  30. data/doc/Axlsx/Override.html +568 -0
  31. data/doc/Axlsx/Package.html +1293 -0
  32. data/doc/Axlsx/PatternFill.html +681 -0
  33. data/doc/Axlsx/Pie3DChart.html +439 -0
  34. data/doc/Axlsx/PieSeries.html +762 -0
  35. data/doc/Axlsx/RegexValidator.html +268 -0
  36. data/doc/Axlsx/Relationship.html +554 -0
  37. data/doc/Axlsx/Relationships.html +343 -0
  38. data/doc/Axlsx/RestrictionValidator.html +300 -0
  39. data/doc/Axlsx/Row.html +771 -0
  40. data/doc/Axlsx/Scaling.html +740 -0
  41. data/doc/Axlsx/SerAxis.html +624 -0
  42. data/doc/Axlsx/Series.html +746 -0
  43. data/doc/Axlsx/SeriesTitle.html +289 -0
  44. data/doc/Axlsx/SimpleTypedList.html +1617 -0
  45. data/doc/Axlsx/Styles.html +1754 -0
  46. data/doc/Axlsx/TableStyle.html +710 -0
  47. data/doc/Axlsx/TableStyleElement.html +677 -0
  48. data/doc/Axlsx/TableStyles.html +599 -0
  49. data/doc/Axlsx/Title.html +625 -0
  50. data/doc/Axlsx/TwoCellAnchor.html +1115 -0
  51. data/doc/Axlsx/ValAxis.html +539 -0
  52. data/doc/Axlsx/View3D.html +971 -0
  53. data/doc/Axlsx/Workbook.html +1347 -0
  54. data/doc/Axlsx/Worksheet.html +1864 -0
  55. data/doc/Axlsx/Xf.html +1681 -0
  56. data/doc/_index.html +611 -0
  57. data/doc/class_list.html +47 -0
  58. data/doc/css/common.css +1 -0
  59. data/doc/css/full_list.css +55 -0
  60. data/doc/css/style.css +322 -0
  61. data/doc/file.README.html +262 -0
  62. data/doc/file_list.html +49 -0
  63. data/doc/frames.html +13 -0
  64. data/doc/index.html +262 -0
  65. data/doc/js/app.js +205 -0
  66. data/doc/js/full_list.js +167 -0
  67. data/doc/js/jquery.js +16 -0
  68. data/doc/method_list.html +3038 -0
  69. data/doc/top-level-namespace.html +103 -0
  70. data/lib/axlsx/util/constants.rb +1 -1
  71. metadata +71 -3
data/doc/Axlsx/Fill.html ADDED
@@ -0,0 +1,460 @@
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::Fill
8
+
9
+ &mdash; 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 (F)</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">Fill</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::Fill
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::Fill</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/stylesheet/fill.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 styles in your workbook is to use
102
+ Styles#add_style.
103
+ </p>
104
+ </div>
105
+ </div>
106
+
107
+ <p>
108
+ The Fill is a formatting object that manages the background color, and
109
+ pattern for cells.
110
+ </p>
111
+
112
+
113
+ </div>
114
+ </div>
115
+ <div class="tags">
116
+
117
+
118
+ <h3>See Also:</h3>
119
+ <ul class="see">
120
+
121
+ <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</a></span></li>
122
+
123
+ <li><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></li>
124
+
125
+ <li><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></li>
126
+
127
+ </ul>
128
+
129
+ </div>
130
+
131
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
132
+ <ul class="summary">
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#fill_type-instance_method" title="#fill_type (instance method)">- (PatternFill, GradientFill) <strong>fill_type</strong> </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+ <span class="summary_desc"><div class='inline'><p>
154
+ The type of fill.
155
+ </p>
156
+ </div></span>
157
+
158
+ </li>
159
+
160
+
161
+ </ul>
162
+
163
+
164
+
165
+
166
+
167
+ <h2>
168
+ Instance Method Summary
169
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
170
+ </h2>
171
+
172
+ <ul class="summary">
173
+
174
+ <li class="public ">
175
+ <span class="summary_signature">
176
+
177
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Fill) <strong>initialize</strong>(fill_type) </a>
178
+
179
+
180
+
181
+ </span>
182
+
183
+ <span class="note title constructor">constructor</span>
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+ <span class="summary_desc"><div class='inline'><p>
193
+ Creates a new Fill object.
194
+ </p>
195
+ </div></span>
196
+
197
+ </li>
198
+
199
+
200
+ <li class="public ">
201
+ <span class="summary_signature">
202
+
203
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
204
+
205
+
206
+
207
+ </span>
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'><p>
217
+ Serializes the fill.
218
+ </p>
219
+ </div></span>
220
+
221
+ </li>
222
+
223
+
224
+ </ul>
225
+
226
+
227
+ <div id="constructor_details" class="method_details_list">
228
+ <h2>Constructor Details</h2>
229
+
230
+ <div class="method_details first">
231
+ <p class="signature first" id="initialize-instance_method">
232
+
233
+ - (<tt><span class='object_link'><a href="" title="Axlsx::Fill (class)">Fill</a></span></tt>) <strong>initialize</strong>(fill_type)
234
+
235
+
236
+
237
+ </p><div class="docstring">
238
+ <div class="discussion">
239
+ <p>
240
+ Creates a new Fill object
241
+ </p>
242
+
243
+
244
+ </div>
245
+ </div>
246
+ <div class="tags">
247
+ <h3>Parameters:</h3>
248
+ <ul class="param">
249
+
250
+ <li>
251
+
252
+ <span class='name'>fill_type</span>
253
+
254
+
255
+ <span class='type'>(<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>)</span>
256
+
257
+
258
+
259
+ </li>
260
+
261
+ </ul>
262
+
263
+ <h3>Raises:</h3>
264
+ <ul class="raise">
265
+
266
+ <li>
267
+
268
+
269
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
270
+
271
+
272
+
273
+ &mdash;
274
+ <div class='inline'><p>
275
+ if the fill_type parameter is not a PatternFill or a GradientFill instance
276
+ </p>
277
+ </div>
278
+
279
+ </li>
280
+
281
+ </ul>
282
+
283
+ </div><table class="source_code">
284
+ <tr>
285
+ <td>
286
+ <pre class="lines">
287
+
288
+
289
+ 16
290
+ 17
291
+ 18</pre>
292
+ </td>
293
+ <td>
294
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 16</span>
295
+
296
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='fill_type identifier id'>fill_type</span><span class='rparen token'>)</span>
297
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='fill_type identifier id'>fill_type</span> <span class='assign token'>=</span> <span class='fill_type identifier id'>fill_type</span>
298
+ <span class='end end kw'>end</span>
299
+ </pre>
300
+ </td>
301
+ </tr>
302
+ </table>
303
+ </div>
304
+
305
+ </div>
306
+
307
+ <div id="instance_attr_details" class="attr_details">
308
+ <h2>Instance Attribute Details</h2>
309
+
310
+
311
+ <span id="fill_type=-instance_method"></span>
312
+ <span id="fill_type-instance_method"></span>
313
+ <div class="method_details first">
314
+ <p class="signature first" id="fill_type-instance_method">
315
+
316
+ - (<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>) <strong>fill_type</strong>
317
+
318
+
319
+
320
+ </p><div class="docstring">
321
+ <div class="discussion">
322
+ <p>
323
+ The type of fill
324
+ </p>
325
+
326
+
327
+ </div>
328
+ </div>
329
+ <div class="tags">
330
+
331
+ <h3>Returns:</h3>
332
+ <ul class="return">
333
+
334
+ <li>
335
+
336
+
337
+ <span class='type'>(<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>)</span>
338
+
339
+
340
+
341
+ </li>
342
+
343
+ </ul>
344
+
345
+ </div><table class="source_code">
346
+ <tr>
347
+ <td>
348
+ <pre class="lines">
349
+
350
+
351
+ 11
352
+ 12
353
+ 13</pre>
354
+ </td>
355
+ <td>
356
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 11</span>
357
+
358
+ <span class='def def kw'>def</span> <span class='fill_type identifier id'>fill_type</span>
359
+ <span class='@fill_type ivar id'>@fill_type</span>
360
+ <span class='end end kw'>end</span>
361
+ </pre>
362
+ </td>
363
+ </tr>
364
+ </table>
365
+ </div>
366
+
367
+ </div>
368
+
369
+
370
+ <div id="instance_method_details" class="method_details_list">
371
+ <h2>Instance Method Details</h2>
372
+
373
+
374
+ <div class="method_details first">
375
+ <p class="signature first" id="to_xml-instance_method">
376
+
377
+ - (<tt>String</tt>) <strong>to_xml</strong>(xml)
378
+
379
+
380
+
381
+ </p><div class="docstring">
382
+ <div class="discussion">
383
+ <p>
384
+ Serializes the fill
385
+ </p>
386
+
387
+
388
+ </div>
389
+ </div>
390
+ <div class="tags">
391
+ <h3>Parameters:</h3>
392
+ <ul class="param">
393
+
394
+ <li>
395
+
396
+ <span class='name'>xml</span>
397
+
398
+
399
+ <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
400
+
401
+
402
+
403
+ &mdash;
404
+ <div class='inline'><p>
405
+ The document builder instance this objects xml will be added to.
406
+ </p>
407
+ </div>
408
+
409
+ </li>
410
+
411
+ </ul>
412
+
413
+ <h3>Returns:</h3>
414
+ <ul class="return">
415
+
416
+ <li>
417
+
418
+
419
+ <span class='type'>(<tt>String</tt>)</span>
420
+
421
+
422
+
423
+ </li>
424
+
425
+ </ul>
426
+
427
+ </div><table class="source_code">
428
+ <tr>
429
+ <td>
430
+ <pre class="lines">
431
+
432
+
433
+ 23
434
+ 24
435
+ 25</pre>
436
+ </td>
437
+ <td>
438
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 23</span>
439
+
440
+ <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>
441
+ <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='fill identifier id'>fill</span> <span class='lbrace token'>{</span> <span class='@fill_type ivar id'>@fill_type</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>
442
+ <span class='end end kw'>end</span>
443
+ </pre>
444
+ </td>
445
+ </tr>
446
+ </table>
447
+ </div>
448
+
449
+ </div>
450
+
451
+ </div>
452
+
453
+ <div id="footer">
454
+ Generated on Tue Nov 22 00:27:48 2011 by
455
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
456
+ 0.7.3 (ruby-1.8.7).
457
+ </div>
458
+
459
+ </body>
460
+ </html>