axlsx 1.0.5 → 1.0.6

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -0,0 +1,1026 @@
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::GradientFill
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 (G)</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">GradientFill</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::GradientFill
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::GradientFill</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/gradient_fill.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>
98
+ A GradientFill defines the color and positioning for gradiant cell fill.
99
+ </p>
100
+
101
+
102
+ </div>
103
+ </div>
104
+ <div class="tags">
105
+
106
+
107
+ <h3>See Also:</h3>
108
+ <ul class="see">
109
+
110
+ <li>Office XML Part 1 §18.8.24</li>
111
+
112
+ </ul>
113
+
114
+ </div>
115
+
116
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#bottom-instance_method" title="#bottom (instance method)">- (Float) <strong>bottom</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <span class="summary_desc"><div class='inline'><p>
139
+ Percentage format bottom.
140
+ </p>
141
+ </div></span>
142
+
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#degree-instance_method" title="#degree (instance method)">- (Float) <strong>degree</strong> </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'><p>
166
+ Angle of the linear gradient.
167
+ </p>
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#left-instance_method" title="#left (instance method)">- (Float) <strong>left</strong> </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+ <span class="summary_desc"><div class='inline'><p>
193
+ Percentage format left.
194
+ </p>
195
+ </div></span>
196
+
197
+ </li>
198
+
199
+
200
+ <li class="public ">
201
+ <span class="summary_signature">
202
+
203
+ <a href="#right-instance_method" title="#right (instance method)">- (Float) <strong>right</strong> </a>
204
+
205
+
206
+
207
+ </span>
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'><p>
220
+ Percentage format right.
221
+ </p>
222
+ </div></span>
223
+
224
+ </li>
225
+
226
+
227
+ <li class="public ">
228
+ <span class="summary_signature">
229
+
230
+ <a href="#stop-instance_method" title="#stop (instance method)">- (SimpleTypedList) <strong>stop</strong> </a>
231
+
232
+
233
+
234
+ </span>
235
+
236
+
237
+ <span class="note title readonly">readonly</span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ <span class="summary_desc"><div class='inline'><p>
247
+ Collection of stop objects.
248
+ </p>
249
+ </div></span>
250
+
251
+ </li>
252
+
253
+
254
+ <li class="public ">
255
+ <span class="summary_signature">
256
+
257
+ <a href="#top-instance_method" title="#top (instance method)">- (Float) <strong>top</strong> </a>
258
+
259
+
260
+
261
+ </span>
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+ <span class="summary_desc"><div class='inline'><p>
274
+ Percentage format top.
275
+ </p>
276
+ </div></span>
277
+
278
+ </li>
279
+
280
+
281
+ <li class="public ">
282
+ <span class="summary_signature">
283
+
284
+ <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a>
285
+
286
+
287
+
288
+ </span>
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+ <span class="summary_desc"><div class='inline'><p>
301
+ The type of gradient.
302
+ </p>
303
+ </div></span>
304
+
305
+ </li>
306
+
307
+
308
+ </ul>
309
+
310
+
311
+
312
+
313
+
314
+ <h2>
315
+ Instance Method Summary
316
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
317
+ </h2>
318
+
319
+ <ul class="summary">
320
+
321
+ <li class="public ">
322
+ <span class="summary_signature">
323
+
324
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (GradientFill) <strong>initialize</strong>(options = {}) </a>
325
+
326
+
327
+
328
+ </span>
329
+
330
+ <span class="note title constructor">constructor</span>
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+ <span class="summary_desc"><div class='inline'><p>
340
+ Creates a new GradientFill object.
341
+ </p>
342
+ </div></span>
343
+
344
+ </li>
345
+
346
+
347
+ <li class="public ">
348
+ <span class="summary_signature">
349
+
350
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
351
+
352
+
353
+
354
+ </span>
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+ <span class="summary_desc"><div class='inline'><p>
364
+ Serializes the gradientFill.
365
+ </p>
366
+ </div></span>
367
+
368
+ </li>
369
+
370
+
371
+ </ul>
372
+
373
+
374
+ <div id="constructor_details" class="method_details_list">
375
+ <h2>Constructor Details</h2>
376
+
377
+ <div class="method_details first">
378
+ <p class="signature first" id="initialize-instance_method">
379
+
380
+ - (<tt><span class='object_link'><a href="" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>) <strong>initialize</strong>(options = {})
381
+
382
+
383
+
384
+ </p><div class="docstring">
385
+ <div class="discussion">
386
+ <p>
387
+ Creates a new GradientFill object
388
+ </p>
389
+
390
+
391
+ </div>
392
+ </div>
393
+ <div class="tags">
394
+ <h3>Parameters:</h3>
395
+ <ul class="param">
396
+
397
+ <li>
398
+
399
+ <span class='name'>options</span>
400
+
401
+
402
+ <span class='type'>(<tt>Hash</tt>)</span>
403
+
404
+
405
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
406
+
407
+
408
+ &mdash;
409
+ <div class='inline'><p>
410
+ a customizable set of options
411
+ </p>
412
+ </div>
413
+
414
+ </li>
415
+
416
+ </ul>
417
+
418
+
419
+
420
+
421
+ <h3>Options Hash (<tt>options</tt>):</h3>
422
+ <ul class="option">
423
+
424
+ <li>
425
+ <span class="name">type</span>
426
+ <span class="type">(<tt>Symbol</tt>)</span>
427
+ <span class="default">
428
+
429
+ </span>
430
+
431
+ </li>
432
+
433
+ <li>
434
+ <span class="name">degree</span>
435
+ <span class="type">(<tt>Float</tt>)</span>
436
+ <span class="default">
437
+
438
+ </span>
439
+
440
+ </li>
441
+
442
+ <li>
443
+ <span class="name">left</span>
444
+ <span class="type">(<tt>Float</tt>)</span>
445
+ <span class="default">
446
+
447
+ </span>
448
+
449
+ </li>
450
+
451
+ <li>
452
+ <span class="name">right</span>
453
+ <span class="type">(<tt>Float</tt>)</span>
454
+ <span class="default">
455
+
456
+ </span>
457
+
458
+ </li>
459
+
460
+ <li>
461
+ <span class="name">top</span>
462
+ <span class="type">(<tt>Float</tt>)</span>
463
+ <span class="default">
464
+
465
+ </span>
466
+
467
+ </li>
468
+
469
+ <li>
470
+ <span class="name">bottom</span>
471
+ <span class="type">(<tt>Float</tt>)</span>
472
+ <span class="default">
473
+
474
+ </span>
475
+
476
+ </li>
477
+
478
+ </ul>
479
+
480
+
481
+
482
+ </div><table class="source_code">
483
+ <tr>
484
+ <td>
485
+ <pre class="lines">
486
+
487
+
488
+ 46
489
+ 47
490
+ 48
491
+ 49
492
+ 50
493
+ 51
494
+ 52</pre>
495
+ </td>
496
+ <td>
497
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 46</span>
498
+
499
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
500
+ <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='symbol val'>:linear</span>
501
+ <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span>
502
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>&quot;#{o[0]}=&quot;</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span>
503
+ <span class='end end kw'>end</span>
504
+ <span class='@stop ivar id'>@stop</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='GradientStop constant id'>GradientStop</span>
505
+ <span class='end end kw'>end</span>
506
+ </pre>
507
+ </td>
508
+ </tr>
509
+ </table>
510
+ </div>
511
+
512
+ </div>
513
+
514
+ <div id="instance_attr_details" class="attr_details">
515
+ <h2>Instance Attribute Details</h2>
516
+
517
+
518
+ <span id="bottom=-instance_method"></span>
519
+ <span id="bottom-instance_method"></span>
520
+ <div class="method_details first">
521
+ <p class="signature first" id="bottom-instance_method">
522
+
523
+ - (<tt>Float</tt>) <strong>bottom</strong>
524
+
525
+
526
+
527
+ </p><div class="docstring">
528
+ <div class="discussion">
529
+ <p>
530
+ Percentage format bottom
531
+ </p>
532
+
533
+
534
+ </div>
535
+ </div>
536
+ <div class="tags">
537
+
538
+ <h3>Returns:</h3>
539
+ <ul class="return">
540
+
541
+ <li>
542
+
543
+
544
+ <span class='type'>(<tt>Float</tt>)</span>
545
+
546
+
547
+
548
+ </li>
549
+
550
+ </ul>
551
+
552
+ </div><table class="source_code">
553
+ <tr>
554
+ <td>
555
+ <pre class="lines">
556
+
557
+
558
+ 33
559
+ 34
560
+ 35</pre>
561
+ </td>
562
+ <td>
563
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 33</span>
564
+
565
+ <span class='def def kw'>def</span> <span class='bottom identifier id'>bottom</span>
566
+ <span class='@bottom ivar id'>@bottom</span>
567
+ <span class='end end kw'>end</span>
568
+ </pre>
569
+ </td>
570
+ </tr>
571
+ </table>
572
+ </div>
573
+
574
+
575
+ <span id="degree=-instance_method"></span>
576
+ <span id="degree-instance_method"></span>
577
+ <div class="method_details ">
578
+ <p class="signature " id="degree-instance_method">
579
+
580
+ - (<tt>Float</tt>) <strong>degree</strong>
581
+
582
+
583
+
584
+ </p><div class="docstring">
585
+ <div class="discussion">
586
+ <p>
587
+ Angle of the linear gradient
588
+ </p>
589
+
590
+
591
+ </div>
592
+ </div>
593
+ <div class="tags">
594
+
595
+ <h3>Returns:</h3>
596
+ <ul class="return">
597
+
598
+ <li>
599
+
600
+
601
+ <span class='type'>(<tt>Float</tt>)</span>
602
+
603
+
604
+
605
+ </li>
606
+
607
+ </ul>
608
+
609
+ </div><table class="source_code">
610
+ <tr>
611
+ <td>
612
+ <pre class="lines">
613
+
614
+
615
+ 17
616
+ 18
617
+ 19</pre>
618
+ </td>
619
+ <td>
620
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 17</span>
621
+
622
+ <span class='def def kw'>def</span> <span class='degree identifier id'>degree</span>
623
+ <span class='@degree ivar id'>@degree</span>
624
+ <span class='end end kw'>end</span>
625
+ </pre>
626
+ </td>
627
+ </tr>
628
+ </table>
629
+ </div>
630
+
631
+
632
+ <span id="left=-instance_method"></span>
633
+ <span id="left-instance_method"></span>
634
+ <div class="method_details ">
635
+ <p class="signature " id="left-instance_method">
636
+
637
+ - (<tt>Float</tt>) <strong>left</strong>
638
+
639
+
640
+
641
+ </p><div class="docstring">
642
+ <div class="discussion">
643
+ <p>
644
+ Percentage format left
645
+ </p>
646
+
647
+
648
+ </div>
649
+ </div>
650
+ <div class="tags">
651
+
652
+ <h3>Returns:</h3>
653
+ <ul class="return">
654
+
655
+ <li>
656
+
657
+
658
+ <span class='type'>(<tt>Float</tt>)</span>
659
+
660
+
661
+
662
+ </li>
663
+
664
+ </ul>
665
+
666
+ </div><table class="source_code">
667
+ <tr>
668
+ <td>
669
+ <pre class="lines">
670
+
671
+
672
+ 21
673
+ 22
674
+ 23</pre>
675
+ </td>
676
+ <td>
677
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 21</span>
678
+
679
+ <span class='def def kw'>def</span> <span class='left identifier id'>left</span>
680
+ <span class='@left ivar id'>@left</span>
681
+ <span class='end end kw'>end</span>
682
+ </pre>
683
+ </td>
684
+ </tr>
685
+ </table>
686
+ </div>
687
+
688
+
689
+ <span id="right=-instance_method"></span>
690
+ <span id="right-instance_method"></span>
691
+ <div class="method_details ">
692
+ <p class="signature " id="right-instance_method">
693
+
694
+ - (<tt>Float</tt>) <strong>right</strong>
695
+
696
+
697
+
698
+ </p><div class="docstring">
699
+ <div class="discussion">
700
+ <p>
701
+ Percentage format right
702
+ </p>
703
+
704
+
705
+ </div>
706
+ </div>
707
+ <div class="tags">
708
+
709
+ <h3>Returns:</h3>
710
+ <ul class="return">
711
+
712
+ <li>
713
+
714
+
715
+ <span class='type'>(<tt>Float</tt>)</span>
716
+
717
+
718
+
719
+ </li>
720
+
721
+ </ul>
722
+
723
+ </div><table class="source_code">
724
+ <tr>
725
+ <td>
726
+ <pre class="lines">
727
+
728
+
729
+ 25
730
+ 26
731
+ 27</pre>
732
+ </td>
733
+ <td>
734
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 25</span>
735
+
736
+ <span class='def def kw'>def</span> <span class='right identifier id'>right</span>
737
+ <span class='@right ivar id'>@right</span>
738
+ <span class='end end kw'>end</span>
739
+ </pre>
740
+ </td>
741
+ </tr>
742
+ </table>
743
+ </div>
744
+
745
+
746
+ <span id=""></span>
747
+ <span id="stop-instance_method"></span>
748
+ <div class="method_details ">
749
+ <p class="signature " id="stop-instance_method">
750
+
751
+ - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>stop</strong> <span class="extras">(readonly)</span>
752
+
753
+
754
+
755
+ </p><div class="docstring">
756
+ <div class="discussion">
757
+ <p>
758
+ Collection of stop objects
759
+ </p>
760
+
761
+
762
+ </div>
763
+ </div>
764
+ <div class="tags">
765
+
766
+ <h3>Returns:</h3>
767
+ <ul class="return">
768
+
769
+ <li>
770
+
771
+
772
+ <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
773
+
774
+
775
+
776
+ </li>
777
+
778
+ </ul>
779
+
780
+ </div><table class="source_code">
781
+ <tr>
782
+ <td>
783
+ <pre class="lines">
784
+
785
+
786
+ 37
787
+ 38
788
+ 39</pre>
789
+ </td>
790
+ <td>
791
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 37</span>
792
+
793
+ <span class='def def kw'>def</span> <span class='stop identifier id'>stop</span>
794
+ <span class='@stop ivar id'>@stop</span>
795
+ <span class='end end kw'>end</span>
796
+ </pre>
797
+ </td>
798
+ </tr>
799
+ </table>
800
+ </div>
801
+
802
+
803
+ <span id="top=-instance_method"></span>
804
+ <span id="top-instance_method"></span>
805
+ <div class="method_details ">
806
+ <p class="signature " id="top-instance_method">
807
+
808
+ - (<tt>Float</tt>) <strong>top</strong>
809
+
810
+
811
+
812
+ </p><div class="docstring">
813
+ <div class="discussion">
814
+ <p>
815
+ Percentage format top
816
+ </p>
817
+
818
+
819
+ </div>
820
+ </div>
821
+ <div class="tags">
822
+
823
+ <h3>Returns:</h3>
824
+ <ul class="return">
825
+
826
+ <li>
827
+
828
+
829
+ <span class='type'>(<tt>Float</tt>)</span>
830
+
831
+
832
+
833
+ </li>
834
+
835
+ </ul>
836
+
837
+ </div><table class="source_code">
838
+ <tr>
839
+ <td>
840
+ <pre class="lines">
841
+
842
+
843
+ 29
844
+ 30
845
+ 31</pre>
846
+ </td>
847
+ <td>
848
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 29</span>
849
+
850
+ <span class='def def kw'>def</span> <span class='top identifier id'>top</span>
851
+ <span class='@top ivar id'>@top</span>
852
+ <span class='end end kw'>end</span>
853
+ </pre>
854
+ </td>
855
+ </tr>
856
+ </table>
857
+ </div>
858
+
859
+
860
+ <span id="type=-instance_method"></span>
861
+ <span id="type-instance_method"></span>
862
+ <div class="method_details ">
863
+ <p class="signature " id="type-instance_method">
864
+
865
+ - (<tt>Symbol</tt>) <strong>type</strong>
866
+
867
+
868
+
869
+ </p><div class="docstring">
870
+ <div class="discussion">
871
+
872
+ <div class="note notetag">
873
+ <strong>Note:</strong>
874
+ <div class='inline'><p>
875
+ valid options are
876
+ </p>
877
+ <pre class="code">
878
+ <span class='symbol val'>:linear</span>
879
+ <span class='symbol val'>:path</span>
880
+ </pre>
881
+ </div>
882
+ </div>
883
+
884
+ <p>
885
+ The type of gradient.
886
+ </p>
887
+
888
+
889
+ </div>
890
+ </div>
891
+ <div class="tags">
892
+
893
+ <h3>Returns:</h3>
894
+ <ul class="return">
895
+
896
+ <li>
897
+
898
+
899
+ <span class='type'>(<tt>Symbol</tt>)</span>
900
+
901
+
902
+
903
+ </li>
904
+
905
+ </ul>
906
+
907
+ </div><table class="source_code">
908
+ <tr>
909
+ <td>
910
+ <pre class="lines">
911
+
912
+
913
+ 13
914
+ 14
915
+ 15</pre>
916
+ </td>
917
+ <td>
918
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 13</span>
919
+
920
+ <span class='def def kw'>def</span> <span class='type identifier id'>type</span>
921
+ <span class='@type ivar id'>@type</span>
922
+ <span class='end end kw'>end</span>
923
+ </pre>
924
+ </td>
925
+ </tr>
926
+ </table>
927
+ </div>
928
+
929
+ </div>
930
+
931
+
932
+ <div id="instance_method_details" class="method_details_list">
933
+ <h2>Instance Method Details</h2>
934
+
935
+
936
+ <div class="method_details first">
937
+ <p class="signature first" id="to_xml-instance_method">
938
+
939
+ - (<tt>String</tt>) <strong>to_xml</strong>(xml)
940
+
941
+
942
+
943
+ </p><div class="docstring">
944
+ <div class="discussion">
945
+ <p>
946
+ Serializes the gradientFill
947
+ </p>
948
+
949
+
950
+ </div>
951
+ </div>
952
+ <div class="tags">
953
+ <h3>Parameters:</h3>
954
+ <ul class="param">
955
+
956
+ <li>
957
+
958
+ <span class='name'>xml</span>
959
+
960
+
961
+ <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
962
+
963
+
964
+
965
+ &mdash;
966
+ <div class='inline'><p>
967
+ The document builder instance this objects xml will be added to.
968
+ </p>
969
+ </div>
970
+
971
+ </li>
972
+
973
+ </ul>
974
+
975
+ <h3>Returns:</h3>
976
+ <ul class="return">
977
+
978
+ <li>
979
+
980
+
981
+ <span class='type'>(<tt>String</tt>)</span>
982
+
983
+
984
+
985
+ </li>
986
+
987
+ </ul>
988
+
989
+ </div><table class="source_code">
990
+ <tr>
991
+ <td>
992
+ <pre class="lines">
993
+
994
+
995
+ 64
996
+ 65
997
+ 66
998
+ 67
999
+ 68</pre>
1000
+ </td>
1001
+ <td>
1002
+ <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 64</span>
1003
+
1004
+ <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>
1005
+ <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='gradientFill identifier id'>gradientFill</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:stop</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
1006
+ <span class='@stop ivar id'>@stop</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='s identifier id'>s</span><span class='bitor op'>|</span> <span class='s identifier id'>s</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>
1007
+ <span class='rbrace token'>}</span>
1008
+ <span class='end end kw'>end</span>
1009
+ </pre>
1010
+ </td>
1011
+ </tr>
1012
+ </table>
1013
+ </div>
1014
+
1015
+ </div>
1016
+
1017
+ </div>
1018
+
1019
+ <div id="footer">
1020
+ Generated on Tue Nov 22 00:27:45 2011 by
1021
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1022
+ 0.7.3 (ruby-1.8.7).
1023
+ </div>
1024
+
1025
+ </body>
1026
+ </html>