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,2682 +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::Worksheet
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 (W)</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">Worksheet</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::Worksheet
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::Worksheet</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/worksheet.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
- The Worksheet class represents a worksheet in the workbook.
99
- </p>
100
-
101
-
102
- </div>
103
- </div>
104
- <div class="tags">
105
-
106
-
107
- </div>
108
-
109
- <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
110
- <ul class="summary">
111
-
112
- <li class="public ">
113
- <span class="summary_signature">
114
-
115
- <a href="#auto_fit_data-instance_method" title="#auto_fit_data (instance method)">- (Array) <strong>auto_fit_data</strong> </a>
116
-
117
-
118
-
119
- </span>
120
-
121
-
122
- <span class="note title readonly">readonly</span>
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
- <span class="summary_desc"><div class='inline'><p>
132
- An array of content based calculated column widths.
133
- </p>
134
- </div></span>
135
-
136
- </li>
137
-
138
-
139
- <li class="public ">
140
- <span class="summary_signature">
141
-
142
- <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
143
-
144
-
145
-
146
- </span>
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
- <span class="summary_desc"><div class='inline'><p>
159
- The name of the worksheet.
160
- </p>
161
- </div></span>
162
-
163
- </li>
164
-
165
-
166
- <li class="public ">
167
- <span class="summary_signature">
168
-
169
- <a href="#rows-instance_method" title="#rows (instance method)">- (SimpleTypedList) <strong>rows</strong> </a>
170
-
171
-
172
-
173
- </span>
174
-
175
-
176
- <span class="note title readonly">readonly</span>
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
- <span class="summary_desc"><div class='inline'><p>
186
- The rows in this worksheet.
187
- </p>
188
- </div></span>
189
-
190
- </li>
191
-
192
-
193
- <li class="public ">
194
- <span class="summary_signature">
195
-
196
- <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a>
197
-
198
-
199
-
200
- </span>
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
- <span class="summary_desc"><div class='inline'><p>
213
- The workbook that owns this worksheet.
214
- </p>
215
- </div></span>
216
-
217
- </li>
218
-
219
-
220
- </ul>
221
-
222
-
223
-
224
-
225
-
226
- <h2>
227
- Instance Method Summary
228
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
229
- </h2>
230
-
231
- <ul class="summary">
232
-
233
- <li class="public ">
234
- <span class="summary_signature">
235
-
236
- <a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Cell, Array) <strong>[]</strong>(cell_def) </a>
237
-
238
-
239
-
240
- </span>
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
- <span class="summary_desc"><div class='inline'><p>
250
- Returns the cell or cells defined using excel style A1:B3 references.
251
- </p>
252
- </div></span>
253
-
254
- </li>
255
-
256
-
257
- <li class="public ">
258
- <span class="summary_signature">
259
-
260
- <a href="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) {|chart| ... }</a>
261
-
262
-
263
-
264
- </span>
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
- <span class="summary_desc"><div class='inline'><p>
274
- Adds a chart to this worksheets drawing.
275
- </p>
276
- </div></span>
277
-
278
- </li>
279
-
280
-
281
- <li class="public ">
282
- <span class="summary_signature">
283
-
284
- <a href="#add_image-instance_method" title="#add_image (instance method)">- (Object) <strong>add_image</strong>(options = {}) {|image| ... }</a>
285
-
286
-
287
-
288
- </span>
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
- <span class="summary_desc"><div class='inline'><p>
298
- Adds a media item to the worksheets drawing.
299
- </p>
300
- </div></span>
301
-
302
- </li>
303
-
304
-
305
- <li class="public ">
306
- <span class="summary_signature">
307
-
308
- <a href="#add_row-instance_method" title="#add_row (instance method)">- (Row) <strong>add_row</strong>(values = [], options = {}) {|@rows.last| ... }</a>
309
-
310
-
311
-
312
- </span>
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
- <span class="summary_desc"><div class='inline'><p>
322
- Adds a row to the worksheet and updates auto fit data.
323
- </p>
324
- </div></span>
325
-
326
- </li>
327
-
328
-
329
- <li class="public ">
330
- <span class="summary_signature">
331
-
332
- <a href="#auto_width-instance_method" title="#auto_width (instance method)">- (Float) <strong>auto_width</strong>(col) </a>
333
-
334
-
335
-
336
- </span>
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
- <span class="summary_desc"><div class='inline'><p>
346
- Determines the proper width for a column based on content.
347
- </p>
348
- </div></span>
349
-
350
- </li>
351
-
352
-
353
- <li class="public ">
354
- <span class="summary_signature">
355
-
356
- <a href="#col_style-instance_method" title="#col_style (instance method)">- (Object) <strong>col_style</strong>(index, style, options = {}) </a>
357
-
358
-
359
-
360
- </span>
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
- <span class="summary_desc"><div class='inline'><p>
370
- Set the style for cells in a specific column.
371
- </p>
372
- </div></span>
373
-
374
- </li>
375
-
376
-
377
- <li class="public ">
378
- <span class="summary_signature">
379
-
380
- <a href="#cols-instance_method" title="#cols (instance method)">- (Object) <strong>cols</strong> </a>
381
-
382
-
383
-
384
- </span>
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
- <span class="summary_desc"><div class='inline'><p>
394
- returns the sheet data as columnw.
395
- </p>
396
- </div></span>
397
-
398
- </li>
399
-
400
-
401
- <li class="public ">
402
- <span class="summary_signature">
403
-
404
- <a href="#drawing-instance_method" title="#drawing (instance method)">- (Drawing) <strong>drawing</strong> </a>
405
-
406
-
407
-
408
- </span>
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
- <span class="summary_desc"><div class='inline'><p>
418
- The drawing associated with this worksheet.
419
- </p>
420
- </div></span>
421
-
422
- </li>
423
-
424
-
425
- <li class="public ">
426
- <span class="summary_signature">
427
-
428
- <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
429
-
430
-
431
-
432
- </span>
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
- <span class="summary_desc"><div class='inline'><p>
442
- The index of this worksheet in the owning Workbook&#8217;s worksheets list.
443
- </p>
444
- </div></span>
445
-
446
- </li>
447
-
448
-
449
- <li class="public ">
450
- <span class="summary_signature">
451
-
452
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Worksheet) <strong>initialize</strong>(wb, options = {}) </a>
453
-
454
-
455
-
456
- </span>
457
-
458
- <span class="note title constructor">constructor</span>
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
- <span class="summary_desc"><div class='inline'><p>
468
- Creates a new worksheet.
469
- </p>
470
- </div></span>
471
-
472
- </li>
473
-
474
-
475
- <li class="public ">
476
- <span class="summary_signature">
477
-
478
- <a href="#name_to_cell-instance_method" title="#name_to_cell (instance method)">- (Cell) <strong>name_to_cell</strong>(name) </a>
479
-
480
-
481
-
482
- </span>
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
- <span class="summary_desc"><div class='inline'><p>
492
- returns the column and row index for a named based cell.
493
- </p>
494
- </div></span>
495
-
496
- </li>
497
-
498
-
499
- <li class="public ">
500
- <span class="summary_signature">
501
-
502
- <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a>
503
-
504
-
505
-
506
- </span>
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
- <span class="summary_desc"><div class='inline'><p>
516
- The part name of this worksheet.
517
- </p>
518
- </div></span>
519
-
520
- </li>
521
-
522
-
523
- <li class="public ">
524
- <span class="summary_signature">
525
-
526
- <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a>
527
-
528
-
529
-
530
- </span>
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
- <span class="summary_desc"><div class='inline'><p>
540
- The worksheet relationships.
541
- </p>
542
- </div></span>
543
-
544
- </li>
545
-
546
-
547
- <li class="public ">
548
- <span class="summary_signature">
549
-
550
- <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a>
551
-
552
-
553
-
554
- </span>
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
- <span class="summary_desc"><div class='inline'><p>
564
- The relationship part name of this worksheet.
565
- </p>
566
- </div></span>
567
-
568
- </li>
569
-
570
-
571
- <li class="public ">
572
- <span class="summary_signature">
573
-
574
- <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a>
575
-
576
-
577
-
578
- </span>
579
-
580
-
581
-
582
-
583
-
584
-
585
-
586
-
587
- <span class="summary_desc"><div class='inline'><p>
588
- The relationship Id of thiw worksheet.
589
- </p>
590
- </div></span>
591
-
592
- </li>
593
-
594
-
595
- <li class="public ">
596
- <span class="summary_signature">
597
-
598
- <a href="#row_style-instance_method" title="#row_style (instance method)">- (Object) <strong>row_style</strong>(index, style, options = {}) </a>
599
-
600
-
601
-
602
- </span>
603
-
604
-
605
-
606
-
607
-
608
-
609
-
610
-
611
- <span class="summary_desc"><div class='inline'><p>
612
- Set the style for cells in a specific row.
613
- </p>
614
- </div></span>
615
-
616
- </li>
617
-
618
-
619
- <li class="public ">
620
- <span class="summary_signature">
621
-
622
- <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
623
-
624
-
625
-
626
- </span>
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
- <span class="summary_desc"><div class='inline'><p>
636
- Serializes the worksheet document.
637
- </p>
638
- </div></span>
639
-
640
- </li>
641
-
642
-
643
- <li class="public ">
644
- <span class="summary_signature">
645
-
646
- <a href="#update_auto_fit_data-instance_method" title="#update_auto_fit_data (instance method)">- (Array) <strong>update_auto_fit_data</strong>(cells) </a>
647
-
648
-
649
-
650
- </span>
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
- <span class="summary_desc"><div class='inline'><p>
660
- Updates auto fit data.
661
- </p>
662
- </div></span>
663
-
664
- </li>
665
-
666
-
667
- </ul>
668
-
669
-
670
- <div id="constructor_details" class="method_details_list">
671
- <h2>Constructor Details</h2>
672
-
673
- <div class="method_details first">
674
- <p class="signature first" id="initialize-instance_method">
675
-
676
- - (<tt><span class='object_link'><a href="" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>initialize</strong>(wb, options = {})
677
-
678
-
679
-
680
- </p><div class="docstring">
681
- <div class="discussion">
682
-
683
- <div class="note notetag">
684
- <strong>Note:</strong>
685
- <div class='inline'><p>
686
- the recommended way to manage worksheets is Workbook#add_worksheet
687
- </p>
688
- </div>
689
- </div>
690
-
691
- <p>
692
- Creates a new worksheet.
693
- </p>
694
-
695
-
696
- </div>
697
- </div>
698
- <div class="tags">
699
- <h3>Parameters:</h3>
700
- <ul class="param">
701
-
702
- <li>
703
-
704
- <span class='name'>options</span>
705
-
706
-
707
- <span class='type'>(<tt>Hash</tt>)</span>
708
-
709
-
710
- <em class="default">(defaults to: <tt>{}</tt>)</em>
711
-
712
-
713
- &mdash;
714
- <div class='inline'><p>
715
- a customizable set of options
716
- </p>
717
- </div>
718
-
719
- </li>
720
-
721
- </ul>
722
-
723
-
724
-
725
-
726
-
727
-
728
- <h3>Options Hash (<tt>options</tt>):</h3>
729
- <ul class="option">
730
-
731
- <li>
732
- <span class="name">name</span>
733
- <span class="type">(<tt>String</tt>)</span>
734
- <span class="default">
735
-
736
- </span>
737
- &mdash; <div class='inline'><p>
738
- The name of this sheet.
739
- </p>
740
- </div>
741
- </li>
742
-
743
- </ul>
744
-
745
-
746
-
747
- <h3>See Also:</h3>
748
- <ul class="see">
749
-
750
- <li><span class='object_link'><a href="Workbook.html#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">Axlsx::Workbook#add_worksheet</a></span></li>
751
-
752
- </ul>
753
-
754
- </div><table class="source_code">
755
- <tr>
756
- <td>
757
- <pre class="lines">
758
-
759
-
760
- 34
761
- 35
762
- 36
763
- 37
764
- 38
765
- 39
766
- 40
767
- 41
768
- 42
769
- 43</pre>
770
- </td>
771
- <td>
772
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 34</span>
773
-
774
- <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='wb identifier id'>wb</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>
775
- <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span>
776
- <span class='@rows ivar id'>@rows</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='Row constant id'>Row</span>
777
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span>
778
- <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span> <span class='lshft op'>&lt;&lt;</span> <span class='self self kw'>self</span>
779
- <span class='@auto_fit_data ivar id'>@auto_fit_data</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
780
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>&quot;Sheet&quot;</span> <span class='plus op'>+</span> <span class='lparen token'>(</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='dot token'>.</span><span class='to_s identifier id'>to_s</span>
781
- <span class='@magick_draw ivar id'>@magick_draw</span> <span class='assign token'>=</span> <span class='Magick constant id'>Magick</span><span class='colon2 op'>::</span><span class='Draw constant id'>Draw</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
782
- <span class='@cols ivar id'>@cols</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>
783
- <span class='end end kw'>end</span>
784
- </pre>
785
- </td>
786
- </tr>
787
- </table>
788
- </div>
789
-
790
- </div>
791
-
792
- <div id="instance_attr_details" class="attr_details">
793
- <h2>Instance Attribute Details</h2>
794
-
795
-
796
- <span id=""></span>
797
- <span id="auto_fit_data-instance_method"></span>
798
- <div class="method_details first">
799
- <p class="signature first" id="auto_fit_data-instance_method">
800
-
801
- - (<tt>Array</tt>) <strong>auto_fit_data</strong> <span class="extras">(readonly)</span>
802
-
803
-
804
-
805
- </p><div class="docstring">
806
- <div class="discussion">
807
-
808
- <div class="note notetag">
809
- <strong>Note:</strong>
810
- <div class='inline'><p>
811
- a single auto fit data item is a hash with :longest =&gt; [String] and
812
- :sz=&gt; [Integer] members.
813
- </p>
814
- </div>
815
- </div>
816
-
817
- <p>
818
- An array of content based calculated column widths.
819
- </p>
820
-
821
-
822
- </div>
823
- </div>
824
- <div class="tags">
825
-
826
- <h3>Returns:</h3>
827
- <ul class="return">
828
-
829
- <li>
830
-
831
-
832
- <span class='type'>(<tt>Array</tt>)</span>
833
-
834
-
835
-
836
- &mdash;
837
- <div class='inline'><p>
838
- of Hash
839
- </p>
840
- </div>
841
-
842
- </li>
843
-
844
- </ul>
845
-
846
- </div><table class="source_code">
847
- <tr>
848
- <td>
849
- <pre class="lines">
850
-
851
-
852
- 25
853
- 26
854
- 27</pre>
855
- </td>
856
- <td>
857
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 25</span>
858
-
859
- <span class='def def kw'>def</span> <span class='auto_fit_data identifier id'>auto_fit_data</span>
860
- <span class='@auto_fit_data ivar id'>@auto_fit_data</span>
861
- <span class='end end kw'>end</span>
862
- </pre>
863
- </td>
864
- </tr>
865
- </table>
866
- </div>
867
-
868
-
869
- <span id="name=-instance_method"></span>
870
- <span id="name-instance_method"></span>
871
- <div class="method_details ">
872
- <p class="signature " id="name-instance_method">
873
-
874
- - (<tt>String</tt>) <strong>name</strong>
875
-
876
-
877
-
878
- </p><div class="docstring">
879
- <div class="discussion">
880
- <p>
881
- The name of the worksheet
882
- </p>
883
-
884
-
885
- </div>
886
- </div>
887
- <div class="tags">
888
-
889
- <h3>Returns:</h3>
890
- <ul class="return">
891
-
892
- <li>
893
-
894
-
895
- <span class='type'>(<tt>String</tt>)</span>
896
-
897
-
898
-
899
- </li>
900
-
901
- </ul>
902
-
903
- </div><table class="source_code">
904
- <tr>
905
- <td>
906
- <pre class="lines">
907
-
908
-
909
- 9
910
- 10
911
- 11</pre>
912
- </td>
913
- <td>
914
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 9</span>
915
-
916
- <span class='def def kw'>def</span> <span class='name identifier id'>name</span>
917
- <span class='@name ivar id'>@name</span>
918
- <span class='end end kw'>end</span>
919
- </pre>
920
- </td>
921
- </tr>
922
- </table>
923
- </div>
924
-
925
-
926
- <span id=""></span>
927
- <span id="rows-instance_method"></span>
928
- <div class="method_details ">
929
- <p class="signature " id="rows-instance_method">
930
-
931
- - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>rows</strong> <span class="extras">(readonly)</span>
932
-
933
-
934
-
935
- </p><div class="docstring">
936
- <div class="discussion">
937
-
938
- <div class="note notetag">
939
- <strong>Note:</strong>
940
- <div class='inline'><p>
941
- The recommended way to manage rows is Worksheet#add_row
942
- </p>
943
- </div>
944
- </div>
945
-
946
- <p>
947
- The rows in this worksheet
948
- </p>
949
-
950
-
951
- </div>
952
- </div>
953
- <div class="tags">
954
-
955
- <h3>Returns:</h3>
956
- <ul class="return">
957
-
958
- <li>
959
-
960
-
961
- <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
962
-
963
-
964
-
965
- </li>
966
-
967
- </ul>
968
-
969
- <h3>See Also:</h3>
970
- <ul class="see">
971
-
972
- <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li>
973
-
974
- </ul>
975
-
976
- </div><table class="source_code">
977
- <tr>
978
- <td>
979
- <pre class="lines">
980
-
981
-
982
- 20
983
- 21
984
- 22</pre>
985
- </td>
986
- <td>
987
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 20</span>
988
-
989
- <span class='def def kw'>def</span> <span class='rows identifier id'>rows</span>
990
- <span class='@rows ivar id'>@rows</span>
991
- <span class='end end kw'>end</span>
992
- </pre>
993
- </td>
994
- </tr>
995
- </table>
996
- </div>
997
-
998
-
999
- <span id="workbook=-instance_method"></span>
1000
- <span id="workbook-instance_method"></span>
1001
- <div class="method_details ">
1002
- <p class="signature " id="workbook-instance_method">
1003
-
1004
- - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong>
1005
-
1006
-
1007
-
1008
- </p><div class="docstring">
1009
- <div class="discussion">
1010
- <p>
1011
- The workbook that owns this worksheet
1012
- </p>
1013
-
1014
-
1015
- </div>
1016
- </div>
1017
- <div class="tags">
1018
-
1019
- <h3>Returns:</h3>
1020
- <ul class="return">
1021
-
1022
- <li>
1023
-
1024
-
1025
- <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span>
1026
-
1027
-
1028
-
1029
- </li>
1030
-
1031
- </ul>
1032
-
1033
- </div><table class="source_code">
1034
- <tr>
1035
- <td>
1036
- <pre class="lines">
1037
-
1038
-
1039
- 13
1040
- 14
1041
- 15</pre>
1042
- </td>
1043
- <td>
1044
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 13</span>
1045
-
1046
- <span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span>
1047
- <span class='@workbook ivar id'>@workbook</span>
1048
- <span class='end end kw'>end</span>
1049
- </pre>
1050
- </td>
1051
- </tr>
1052
- </table>
1053
- </div>
1054
-
1055
- </div>
1056
-
1057
-
1058
- <div id="instance_method_details" class="method_details_list">
1059
- <h2>Instance Method Details</h2>
1060
-
1061
-
1062
- <div class="method_details first">
1063
- <p class="signature first" id="[]-instance_method">
1064
-
1065
- - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>Array</tt>) <strong>[]</strong>(cell_def)
1066
-
1067
-
1068
-
1069
- </p><div class="docstring">
1070
- <div class="discussion">
1071
- <p>
1072
- Returns the cell or cells defined using excel style A1:B3 references.
1073
- </p>
1074
-
1075
-
1076
- </div>
1077
- </div>
1078
- <div class="tags">
1079
- <h3>Parameters:</h3>
1080
- <ul class="param">
1081
-
1082
- <li>
1083
-
1084
- <span class='name'>cell_def</span>
1085
-
1086
-
1087
- <span class='type'>(<tt>String</tt>)</span>
1088
-
1089
-
1090
-
1091
- &mdash;
1092
- <div class='inline'><p>
1093
- the string defining the cell or range of cells
1094
- </p>
1095
- </div>
1096
-
1097
- </li>
1098
-
1099
- </ul>
1100
-
1101
- <h3>Returns:</h3>
1102
- <ul class="return">
1103
-
1104
- <li>
1105
-
1106
-
1107
- <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>Array</tt>)</span>
1108
-
1109
-
1110
-
1111
- </li>
1112
-
1113
- </ul>
1114
-
1115
- </div><table class="source_code">
1116
- <tr>
1117
- <td>
1118
- <pre class="lines">
1119
-
1120
-
1121
- 48
1122
- 49
1123
- 50
1124
- 51
1125
- 52
1126
- 53
1127
- 54
1128
- 55
1129
- 56
1130
- 57
1131
- 58
1132
- 59
1133
- 60
1134
- 61
1135
- 62
1136
- 63
1137
- 64</pre>
1138
- </td>
1139
- <td>
1140
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 48</span>
1141
-
1142
- <span class='def def kw'>def</span> <span class='aref op'>[]</span><span class='lparen token'>(</span><span class='cell_def identifier id'>cell_def</span><span class='rparen token'>)</span>
1143
- <span class='parts identifier id'>parts</span> <span class='assign token'>=</span> <span class='cell_def identifier id'>cell_def</span><span class='dot token'>.</span><span class='split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>':'</span><span class='rparen token'>)</span>
1144
- <span class='first identifier id'>first</span> <span class='assign token'>=</span> <span class='name_to_cell identifier id'>name_to_cell</span> <span class='parts identifier id'>parts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span>
1145
-
1146
- <span class='if if kw'>if</span> <span class='parts identifier id'>parts</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='eq op'>==</span> <span class='integer val'>1</span>
1147
- <span class='first identifier id'>first</span>
1148
- <span class='else else kw'>else</span>
1149
- <span class='cells identifier id'>cells</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
1150
- <span class='last identifier id'>last</span> <span class='assign token'>=</span> <span class='name_to_cell identifier id'>name_to_cell</span><span class='lparen token'>(</span><span class='parts identifier id'>parts</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
1151
- <span class='rows identifier id'>rows</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='row identifier id'>row</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='dot2 op'>..</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='row identifier id'>row</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='rparen token'>)</span><span class='rbrack token'>]</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='r identifier id'>r</span><span class='bitor op'>|</span>
1152
- <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='dot2 op'>..</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='rparen token'>)</span><span class='rbrack token'>]</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='c identifier id'>c</span><span class='bitor op'>|</span>
1153
- <span class='cells identifier id'>cells</span> <span class='lshft op'>&lt;&lt;</span> <span class='c identifier id'>c</span>
1154
- <span class='end end kw'>end</span>
1155
- <span class='end end kw'>end</span>
1156
- <span class='cells identifier id'>cells</span>
1157
- <span class='end end kw'>end</span>
1158
- <span class='end end kw'>end</span>
1159
- </pre>
1160
- </td>
1161
- </tr>
1162
- </table>
1163
- </div>
1164
-
1165
- <div class="method_details ">
1166
- <p class="signature " id="add_chart-instance_method">
1167
-
1168
- - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {}) {|chart| ... }
1169
-
1170
-
1171
-
1172
- </p><div class="docstring">
1173
- <div class="discussion">
1174
-
1175
- <div class="note notetag">
1176
- <strong>Note:</strong>
1177
- <div class='inline'><p>
1178
- each chart type also specifies additional options
1179
- </p>
1180
- </div>
1181
- </div>
1182
-
1183
- <p>
1184
- Adds a chart to this worksheets drawing. This is the recommended way to
1185
- create charts for your worksheet. This method wraps the complexity of
1186
- dealing with ooxml drawing, anchors, markers graphic frames chart objects
1187
- and all the other dirty details.
1188
- </p>
1189
-
1190
-
1191
- </div>
1192
- </div>
1193
- <div class="tags">
1194
- <h3>Parameters:</h3>
1195
- <ul class="param">
1196
-
1197
- <li>
1198
-
1199
- <span class='name'>chart_type</span>
1200
-
1201
-
1202
- <span class='type'>(<tt>Class</tt>)</span>
1203
-
1204
-
1205
-
1206
- </li>
1207
-
1208
- <li>
1209
-
1210
- <span class='name'>options</span>
1211
-
1212
-
1213
- <span class='type'>(<tt>Hash</tt>)</span>
1214
-
1215
-
1216
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1217
-
1218
-
1219
- &mdash;
1220
- <div class='inline'><p>
1221
- a customizable set of options
1222
- </p>
1223
- </div>
1224
-
1225
- </li>
1226
-
1227
- </ul>
1228
-
1229
-
1230
-
1231
-
1232
-
1233
-
1234
- <h3>Options Hash (<tt>options</tt>):</h3>
1235
- <ul class="option">
1236
-
1237
- <li>
1238
- <span class="name">start_at</span>
1239
- <span class="type">(<tt>Array</tt>)</span>
1240
- <span class="default">
1241
-
1242
- </span>
1243
-
1244
- </li>
1245
-
1246
- <li>
1247
- <span class="name">end_at</span>
1248
- <span class="type">(<tt>Array</tt>)</span>
1249
- <span class="default">
1250
-
1251
- </span>
1252
-
1253
- </li>
1254
-
1255
- <li>
1256
- <span class="name">title</span>
1257
- <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span>
1258
- <span class="default">
1259
-
1260
- </span>
1261
-
1262
- </li>
1263
-
1264
- <li>
1265
- <span class="name">show_legend</span>
1266
- <span class="type">(<tt>Boolean</tt>)</span>
1267
- <span class="default">
1268
-
1269
- </span>
1270
-
1271
- </li>
1272
-
1273
- <li>
1274
- <span class="name">style</span>
1275
- <span class="type">(<tt>Integer</tt>)</span>
1276
- <span class="default">
1277
-
1278
- </span>
1279
-
1280
- </li>
1281
-
1282
- </ul>
1283
-
1284
-
1285
- <h3>Yields:</h3>
1286
- <ul class="yield">
1287
-
1288
- <li>
1289
-
1290
-
1291
- <span class='type'>(<tt>chart</tt>)</span>
1292
-
1293
-
1294
-
1295
- </li>
1296
-
1297
- </ul>
1298
-
1299
- <h3>See Also:</h3>
1300
- <ul class="see">
1301
-
1302
- <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li>
1303
-
1304
- <li><span class='object_link'><a href="Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span></li>
1305
-
1306
- <li><span class='object_link'><a href="Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span></li>
1307
-
1308
- <li><span class='object_link'><a href="Line3DChart.html" title="Axlsx::Line3DChart (class)">Line3DChart</a></span></li>
1309
-
1310
- <li>for examples</li>
1311
-
1312
- </ul>
1313
-
1314
- </div><table class="source_code">
1315
- <tr>
1316
- <td>
1317
- <pre class="lines">
1318
-
1319
-
1320
- 183
1321
- 184
1322
- 185
1323
- 186
1324
- 187</pre>
1325
- </td>
1326
- <td>
1327
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 183</span>
1328
-
1329
- <span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</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>
1330
- <span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
1331
- <span class='yield yield kw'>yield</span> <span class='chart identifier id'>chart</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
1332
- <span class='chart identifier id'>chart</span>
1333
- <span class='end end kw'>end</span>
1334
- </pre>
1335
- </td>
1336
- </tr>
1337
- </table>
1338
- </div>
1339
-
1340
- <div class="method_details ">
1341
- <p class="signature " id="add_image-instance_method">
1342
-
1343
- - (<tt>Object</tt>) <strong>add_image</strong>(options = {}) {|image| ... }
1344
-
1345
-
1346
-
1347
- </p><div class="docstring">
1348
- <div class="discussion">
1349
- <p>
1350
- Adds a media item to the worksheets drawing
1351
- </p>
1352
-
1353
-
1354
- </div>
1355
- </div>
1356
- <div class="tags">
1357
- <h3>Parameters:</h3>
1358
- <ul class="param">
1359
-
1360
- <li>
1361
-
1362
- <span class='name'>media_type</span>
1363
-
1364
-
1365
- <span class='type'>(<tt>Class</tt>)</span>
1366
-
1367
-
1368
-
1369
- </li>
1370
-
1371
- <li>
1372
-
1373
- <span class='name'>options</span>
1374
-
1375
-
1376
- <span class='type'>(<tt>Hash</tt>)</span>
1377
-
1378
-
1379
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1380
-
1381
-
1382
- &mdash;
1383
- <div class='inline'><p>
1384
- a customizable set of options
1385
- </p>
1386
- </div>
1387
-
1388
- </li>
1389
-
1390
- </ul>
1391
-
1392
-
1393
-
1394
-
1395
- <h3>Options Hash (<tt>options</tt>):</h3>
1396
- <ul class="option">
1397
-
1398
- <li>
1399
- <span class="name">[]</span>
1400
- <span class="type">(<tt>Object</tt>)</span>
1401
- <span class="default">
1402
-
1403
- </span>
1404
- &mdash; <div class='inline'><p>
1405
- unknown
1406
- </p>
1407
- </div>
1408
- </li>
1409
-
1410
- </ul>
1411
-
1412
-
1413
- <h3>Yields:</h3>
1414
- <ul class="yield">
1415
-
1416
- <li>
1417
-
1418
-
1419
- <span class='type'>(<tt>image</tt>)</span>
1420
-
1421
-
1422
-
1423
- </li>
1424
-
1425
- </ul>
1426
-
1427
- </div><table class="source_code">
1428
- <tr>
1429
- <td>
1430
- <pre class="lines">
1431
-
1432
-
1433
- 192
1434
- 193
1435
- 194
1436
- 195
1437
- 196</pre>
1438
- </td>
1439
- <td>
1440
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 192</span>
1441
-
1442
- <span class='def def kw'>def</span> <span class='add_image identifier id'>add_image</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>
1443
- <span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span>
1444
- <span class='yield yield kw'>yield</span> <span class='image identifier id'>image</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
1445
- <span class='image identifier id'>image</span>
1446
- <span class='end end kw'>end</span>
1447
- </pre>
1448
- </td>
1449
- </tr>
1450
- </table>
1451
- </div>
1452
-
1453
- <div class="method_details ">
1454
- <p class="signature " id="add_row-instance_method">
1455
-
1456
- - (<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>) <strong>add_row</strong>(values = [], options = {}) {|@rows.last| ... }
1457
-
1458
-
1459
-
1460
- </p><div class="docstring">
1461
- <div class="discussion">
1462
- <p>
1463
- Adds a row to the worksheet and updates auto fit data
1464
- </p>
1465
-
1466
-
1467
- </div>
1468
- </div>
1469
- <div class="tags">
1470
- <h3>Parameters:</h3>
1471
- <ul class="param">
1472
-
1473
- <li>
1474
-
1475
- <span class='name'>options</span>
1476
-
1477
-
1478
- <span class='type'>(<tt>Hash</tt>)</span>
1479
-
1480
-
1481
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1482
-
1483
-
1484
- &mdash;
1485
- <div class='inline'><p>
1486
- a customizable set of options
1487
- </p>
1488
- </div>
1489
-
1490
- </li>
1491
-
1492
- </ul>
1493
-
1494
-
1495
-
1496
-
1497
-
1498
-
1499
- <h3>Options Hash (<tt>options</tt>):</h3>
1500
- <ul class="option">
1501
-
1502
- <li>
1503
- <span class="name">values</span>
1504
- <span class="type">(<tt>Array</tt>)</span>
1505
- <span class="default">
1506
-
1507
- </span>
1508
-
1509
- </li>
1510
-
1511
- <li>
1512
- <span class="name">types</span>
1513
- <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span>
1514
- <span class="default">
1515
-
1516
- </span>
1517
-
1518
- </li>
1519
-
1520
- <li>
1521
- <span class="name">style</span>
1522
- <span class="type">(<tt>Array</tt>, <tt>Integer</tt>)</span>
1523
- <span class="default">
1524
-
1525
- </span>
1526
-
1527
- </li>
1528
-
1529
- </ul>
1530
-
1531
-
1532
- <h3>Yields:</h3>
1533
- <ul class="yield">
1534
-
1535
- <li>
1536
-
1537
-
1538
- <span class='type'>(<tt>@rows.last</tt>)</span>
1539
-
1540
-
1541
-
1542
- </li>
1543
-
1544
- </ul>
1545
- <h3>Returns:</h3>
1546
- <ul class="return">
1547
-
1548
- <li>
1549
-
1550
-
1551
- <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>)</span>
1552
-
1553
-
1554
-
1555
- </li>
1556
-
1557
- </ul>
1558
-
1559
- </div><table class="source_code">
1560
- <tr>
1561
- <td>
1562
- <pre class="lines">
1563
-
1564
-
1565
- 121
1566
- 122
1567
- 123
1568
- 124
1569
- 125
1570
- 126</pre>
1571
- </td>
1572
- <td>
1573
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 121</span>
1574
-
1575
- <span class='def def kw'>def</span> <span class='add_row identifier id'>add_row</span><span class='lparen 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>
1576
- <span class='Row constant id'>Row</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='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
1577
- <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span>
1578
- <span class='yield yield kw'>yield</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
1579
- <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span>
1580
- <span class='end end kw'>end</span>
1581
- </pre>
1582
- </td>
1583
- </tr>
1584
- </table>
1585
- </div>
1586
-
1587
- <div class="method_details ">
1588
- <p class="signature " id="auto_width-instance_method">
1589
-
1590
- - (<tt>Float</tt>) <strong>auto_width</strong>(col)
1591
-
1592
-
1593
-
1594
- </p><div class="docstring">
1595
- <div class="discussion">
1596
-
1597
- <div class="note notetag">
1598
- <strong>Note:</strong>
1599
- <div class='inline'><p>
1600
- From ECMA docs
1601
- </p>
1602
- <pre class="code">
1603
- <span class='Column constant id'>Column</span> <span class='width identifier id'>width</span> <span class='measured identifier id'>measured</span> <span class='as identifier id'>as</span> <span class='the identifier id'>the</span> <span class='number identifier id'>number</span> <span class='of identifier id'>of</span> <span class='characters identifier id'>characters</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='maximum identifier id'>maximum</span> <span class='digit identifier id'>digit</span> <span class='width identifier id'>width</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='numbers identifier id'>numbers</span> <span class='integer val'>0</span> <span class='dot2 op'>..</span> <span class='integer val'>9</span> <span class='as identifier id'>as</span>
1604
- <span class='rendered identifier id'>rendered</span> <span class='in in kw'>in</span> <span class='the identifier id'>the</span> <span class='normal identifier id'>normal</span> <span class='style identifier id'>style</span><span class='string val'>'s font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
1605
- width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256
1606
- </span></pre>
1607
- </div>
1608
- </div>
1609
-
1610
- <p>
1611
- Determines the proper width for a column based on content.
1612
- </p>
1613
-
1614
-
1615
- </div>
1616
- </div>
1617
- <div class="tags">
1618
- <h3>Parameters:</h3>
1619
- <ul class="param">
1620
-
1621
- <li>
1622
-
1623
- <span class='name'>A</span>
1624
-
1625
-
1626
- <span class='type'>(<tt>Hash</tt>)</span>
1627
-
1628
-
1629
-
1630
- &mdash;
1631
- <div class='inline'><p>
1632
- hash of auto_fit_data
1633
- </p>
1634
- </div>
1635
-
1636
- </li>
1637
-
1638
- </ul>
1639
-
1640
- <h3>Returns:</h3>
1641
- <ul class="return">
1642
-
1643
- <li>
1644
-
1645
-
1646
- <span class='type'>(<tt>Float</tt>)</span>
1647
-
1648
-
1649
-
1650
- </li>
1651
-
1652
- </ul>
1653
-
1654
- </div><table class="source_code">
1655
- <tr>
1656
- <td>
1657
- <pre class="lines">
1658
-
1659
-
1660
- 266
1661
- 267
1662
- 268
1663
- 269
1664
- 270
1665
- 271
1666
- 272
1667
- 273
1668
- 274
1669
- 275
1670
- 276</pre>
1671
- </td>
1672
- <td>
1673
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 266</span>
1674
-
1675
- <span class='def def kw'>def</span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span>
1676
- <span class='mdw identifier id'>mdw</span> <span class='assign token'>=</span> <span class='float val'>6.0</span> <span class='comment val'># maximum digit with is always 6.0 with RMagick's default font</span>
1677
- <span class='mdw_count identifier id'>mdw_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
1678
- <span class='best_guess identifier id'>best_guess</span> <span class='assign token'>=</span> <span class='float val'>1.5</span> <span class='comment val'>#direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling</span>
1679
- <span class='font_scale identifier id'>font_scale</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='orop op'>||</span> <span class='float val'>11.0</span><span class='rparen token'>)</span>
1680
-
1681
- <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</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='i identifier id'>i</span><span class='bitor op'>|</span>
1682
- <span class='mdw_count identifier id'>mdw_count</span> <span class='opasgn op'>+=</span><span class='integer val'>1</span> <span class='if if_mod kw'>if</span> <span class='@magick_draw ivar id'>@magick_draw</span><span class='dot token'>.</span><span class='get_type_metrics identifier id'>get_type_metrics</span><span class='lparen token'>(</span><span class='i identifier id'>i</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='geq op'>&gt;=</span> <span class='mdw identifier id'>mdw</span>
1683
- <span class='end end kw'>end</span>
1684
- <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='mdw_count identifier id'>mdw_count</span> <span class='mult op'>*</span> <span class='mdw identifier id'>mdw</span> <span class='plus op'>+</span> <span class='integer val'>5</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='mdw identifier id'>mdw</span> <span class='mult op'>*</span> <span class='integer val'>256</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='float val'>256.0</span> <span class='mult op'>*</span> <span class='best_guess identifier id'>best_guess</span> <span class='mult op'>*</span> <span class='font_scale identifier id'>font_scale</span>
1685
- <span class='end end kw'>end</span>
1686
- </pre>
1687
- </td>
1688
- </tr>
1689
- </table>
1690
- </div>
1691
-
1692
- <div class="method_details ">
1693
- <p class="signature " id="col_style-instance_method">
1694
-
1695
- - (<tt>Object</tt>) <strong>col_style</strong>(index, style, options = {})
1696
-
1697
-
1698
-
1699
- </p><div class="docstring">
1700
- <div class="discussion">
1701
-
1702
- <div class="note notetag">
1703
- <strong>Note:</strong>
1704
- <div class='inline'><p>
1705
- You can also specify the style for specific columns in the call to add_row
1706
- by using an array for the :styles option
1707
- </p>
1708
- </div>
1709
- </div>
1710
-
1711
- <p>
1712
- Set the style for cells in a specific column
1713
- </p>
1714
-
1715
-
1716
- </div>
1717
- </div>
1718
- <div class="tags">
1719
- <h3>Parameters:</h3>
1720
- <ul class="param">
1721
-
1722
- <li>
1723
-
1724
- <span class='name'>index</span>
1725
-
1726
-
1727
- <span class='type'>(<tt>Integer</tt>)</span>
1728
-
1729
-
1730
-
1731
- &mdash;
1732
- <div class='inline'><p>
1733
- the index of the column
1734
- </p>
1735
- </div>
1736
-
1737
- </li>
1738
-
1739
- <li>
1740
-
1741
- <span class='name'>the</span>
1742
-
1743
-
1744
- <span class='type'>(<tt>Integer</tt>)</span>
1745
-
1746
-
1747
-
1748
- &mdash;
1749
- <div class='inline'><p>
1750
- cellXfs index
1751
- </p>
1752
- </div>
1753
-
1754
- </li>
1755
-
1756
- <li>
1757
-
1758
- <span class='name'>options</span>
1759
-
1760
-
1761
- <span class='type'>(<tt>Hash</tt>)</span>
1762
-
1763
-
1764
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1765
-
1766
-
1767
- &mdash;
1768
- <div class='inline'><p>
1769
- a customizable set of options
1770
- </p>
1771
- </div>
1772
-
1773
- </li>
1774
-
1775
- </ul>
1776
-
1777
-
1778
-
1779
-
1780
-
1781
-
1782
-
1783
-
1784
- <h3>Options Hash (<tt>options</tt>):</h3>
1785
- <ul class="option">
1786
-
1787
- <li>
1788
- <span class="name">row_offset</span>
1789
- <span class="type">(<tt>Integer</tt>)</span>
1790
- <span class="default">
1791
-
1792
- </span>
1793
- &mdash; <div class='inline'><p>
1794
- only cells after this column will be updated.
1795
- </p>
1796
- </div>
1797
- </li>
1798
-
1799
- </ul>
1800
-
1801
-
1802
-
1803
- <h3>See Also:</h3>
1804
- <ul class="see">
1805
-
1806
- <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li>
1807
-
1808
- <li>for an example</li>
1809
-
1810
- </ul>
1811
-
1812
- </div><table class="source_code">
1813
- <tr>
1814
- <td>
1815
- <pre class="lines">
1816
-
1817
-
1818
- 158
1819
- 159
1820
- 160
1821
- 161
1822
- 162
1823
- 163
1824
- 164
1825
- 165
1826
- 166
1827
- 167
1828
- 168</pre>
1829
- </td>
1830
- <td>
1831
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 158</span>
1832
-
1833
- <span class='def def kw'>def</span> <span class='col_style identifier id'>col_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</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>
1834
- <span class='offset identifier id'>offset</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:row_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span>
1835
- <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</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='r identifier id'>r</span><span class='bitor op'>|</span>
1836
- <span class='cells identifier id'>cells</span> <span class='assign token'>=</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span>
1837
- <span class='if if kw'>if</span> <span class='cells identifier id'>cells</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>
1838
- <span class='cells identifier 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='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span>
1839
- <span class='else else kw'>else</span>
1840
- <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span>
1841
- <span class='end end kw'>end</span>
1842
- <span class='end end kw'>end</span>
1843
- <span class='end end kw'>end</span>
1844
- </pre>
1845
- </td>
1846
- </tr>
1847
- </table>
1848
- </div>
1849
-
1850
- <div class="method_details ">
1851
- <p class="signature " id="cols-instance_method">
1852
-
1853
- - (<tt>Object</tt>) <strong>cols</strong>
1854
-
1855
-
1856
-
1857
- </p><div class="docstring">
1858
- <div class="discussion">
1859
- <p>
1860
- returns the sheet data as columnw
1861
- </p>
1862
-
1863
-
1864
- </div>
1865
- </div>
1866
- <div class="tags">
1867
-
1868
-
1869
- </div><table class="source_code">
1870
- <tr>
1871
- <td>
1872
- <pre class="lines">
1873
-
1874
-
1875
- 146
1876
- 147
1877
- 148</pre>
1878
- </td>
1879
- <td>
1880
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 146</span>
1881
-
1882
- <span class='def def kw'>def</span> <span class='cols identifier id'>cols</span>
1883
- <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='transpose identifier id'>transpose</span>
1884
- <span class='end end kw'>end</span>
1885
- </pre>
1886
- </td>
1887
- </tr>
1888
- </table>
1889
- </div>
1890
-
1891
- <div class="method_details ">
1892
- <p class="signature " id="drawing-instance_method">
1893
-
1894
- - (<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>) <strong>drawing</strong>
1895
-
1896
-
1897
-
1898
- </p><div class="docstring">
1899
- <div class="discussion">
1900
-
1901
- <div class="note notetag">
1902
- <strong>Note:</strong>
1903
- <div class='inline'><p>
1904
- the recommended way to work with drawings and charts is Worksheet#add_chart
1905
- </p>
1906
- </div>
1907
- </div>
1908
-
1909
- <p>
1910
- The drawing associated with this worksheet.
1911
- </p>
1912
-
1913
-
1914
- </div>
1915
- </div>
1916
- <div class="tags">
1917
-
1918
- <h3>Returns:</h3>
1919
- <ul class="return">
1920
-
1921
- <li>
1922
-
1923
-
1924
- <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span>
1925
-
1926
-
1927
-
1928
- </li>
1929
-
1930
- </ul>
1931
-
1932
- <h3>See Also:</h3>
1933
- <ul class="see">
1934
-
1935
- <li><span class='object_link'><a href="#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">#add_chart</a></span></li>
1936
-
1937
- </ul>
1938
-
1939
- </div><table class="source_code">
1940
- <tr>
1941
- <td>
1942
- <pre class="lines">
1943
-
1944
-
1945
- 112
1946
- 113
1947
- 114</pre>
1948
- </td>
1949
- <td>
1950
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 112</span>
1951
-
1952
- <span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span>
1953
- <span class='@drawing ivar id'>@drawing</span> <span class='orop op'>||</span> <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Drawing constant id'>Drawing</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='rparen token'>)</span>
1954
- <span class='end end kw'>end</span>
1955
- </pre>
1956
- </td>
1957
- </tr>
1958
- </table>
1959
- </div>
1960
-
1961
- <div class="method_details ">
1962
- <p class="signature " id="index-instance_method">
1963
-
1964
- - (<tt>Integer</tt>) <strong>index</strong>
1965
-
1966
-
1967
-
1968
- </p><div class="docstring">
1969
- <div class="discussion">
1970
- <p>
1971
- The index of this worksheet in the owning Workbook&#8217;s worksheets list.
1972
- </p>
1973
-
1974
-
1975
- </div>
1976
- </div>
1977
- <div class="tags">
1978
-
1979
- <h3>Returns:</h3>
1980
- <ul class="return">
1981
-
1982
- <li>
1983
-
1984
-
1985
- <span class='type'>(<tt>Integer</tt>)</span>
1986
-
1987
-
1988
-
1989
- </li>
1990
-
1991
- </ul>
1992
-
1993
- </div><table class="source_code">
1994
- <tr>
1995
- <td>
1996
- <pre class="lines">
1997
-
1998
-
1999
- 104
2000
- 105
2001
- 106</pre>
2002
- </td>
2003
- <td>
2004
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 104</span>
2005
-
2006
- <span class='def def kw'>def</span> <span class='index identifier id'>index</span>
2007
- <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</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>
2008
- <span class='end end kw'>end</span>
2009
- </pre>
2010
- </td>
2011
- </tr>
2012
- </table>
2013
- </div>
2014
-
2015
- <div class="method_details ">
2016
- <p class="signature " id="name_to_cell-instance_method">
2017
-
2018
- - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>name_to_cell</strong>(name)
2019
-
2020
-
2021
-
2022
- </p><div class="docstring">
2023
- <div class="discussion">
2024
- <p>
2025
- returns the column and row index for a named based cell
2026
- </p>
2027
-
2028
-
2029
- </div>
2030
- </div>
2031
- <div class="tags">
2032
- <h3>Parameters:</h3>
2033
- <ul class="param">
2034
-
2035
- <li>
2036
-
2037
- <span class='name'>name</span>
2038
-
2039
-
2040
- <span class='type'>(<tt>String</tt>)</span>
2041
-
2042
-
2043
-
2044
- &mdash;
2045
- <div class='inline'><p>
2046
- The cell or cell range to return. &quot;A1&quot; will return the first cell
2047
- of the first row.
2048
- </p>
2049
- </div>
2050
-
2051
- </li>
2052
-
2053
- </ul>
2054
-
2055
- <h3>Returns:</h3>
2056
- <ul class="return">
2057
-
2058
- <li>
2059
-
2060
-
2061
- <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span>
2062
-
2063
-
2064
-
2065
- </li>
2066
-
2067
- </ul>
2068
-
2069
- </div><table class="source_code">
2070
- <tr>
2071
- <td>
2072
- <pre class="lines">
2073
-
2074
-
2075
- 69
2076
- 70
2077
- 71
2078
- 72
2079
- 73</pre>
2080
- </td>
2081
- <td>
2082
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 69</span>
2083
-
2084
- <span class='def def kw'>def</span> <span class='name_to_cell identifier id'>name_to_cell</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
2085
- <span class='col_index identifier id'>col_index</span><span class='comma token'>,</span> <span class='row_index identifier id'>row_index</span> <span class='assign token'>=</span> <span class='mult op'>*</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='name_to_indices identifier id'>name_to_indices</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
2086
- <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='rows identifier id'>rows</span><span class='lbrack token'>[</span><span class='row_index identifier id'>row_index</span><span class='rbrack token'>]</span>
2087
- <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='col_index identifier id'>col_index</span><span class='rbrack token'>]</span> <span class='if if_mod kw'>if</span> <span class='r identifier id'>r</span>
2088
- <span class='end end kw'>end</span>
2089
- </pre>
2090
- </td>
2091
- </tr>
2092
- </table>
2093
- </div>
2094
-
2095
- <div class="method_details ">
2096
- <p class="signature " id="pn-instance_method">
2097
-
2098
- - (<tt>String</tt>) <strong>pn</strong>
2099
-
2100
-
2101
-
2102
- </p><div class="docstring">
2103
- <div class="discussion">
2104
- <p>
2105
- The part name of this worksheet
2106
- </p>
2107
-
2108
-
2109
- </div>
2110
- </div>
2111
- <div class="tags">
2112
-
2113
- <h3>Returns:</h3>
2114
- <ul class="return">
2115
-
2116
- <li>
2117
-
2118
-
2119
- <span class='type'>(<tt>String</tt>)</span>
2120
-
2121
-
2122
-
2123
- </li>
2124
-
2125
- </ul>
2126
-
2127
- </div><table class="source_code">
2128
- <tr>
2129
- <td>
2130
- <pre class="lines">
2131
-
2132
-
2133
- 86
2134
- 87
2135
- 88</pre>
2136
- </td>
2137
- <td>
2138
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 86</span>
2139
-
2140
- <span class='def def kw'>def</span> <span class='pn identifier id'>pn</span>
2141
- <span class='dstring node'>&quot;#{WORKSHEET_PN % (index+1)}&quot;</span>
2142
- <span class='end end kw'>end</span>
2143
- </pre>
2144
- </td>
2145
- </tr>
2146
- </table>
2147
- </div>
2148
-
2149
- <div class="method_details ">
2150
- <p class="signature " id="relationships-instance_method">
2151
-
2152
- - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong>
2153
-
2154
-
2155
-
2156
- </p><div class="docstring">
2157
- <div class="discussion">
2158
- <p>
2159
- The worksheet relationships. This is managed automatically by the worksheet
2160
- </p>
2161
-
2162
-
2163
- </div>
2164
- </div>
2165
- <div class="tags">
2166
-
2167
- <h3>Returns:</h3>
2168
- <ul class="return">
2169
-
2170
- <li>
2171
-
2172
-
2173
- <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span>
2174
-
2175
-
2176
-
2177
- </li>
2178
-
2179
- </ul>
2180
-
2181
- </div><table class="source_code">
2182
- <tr>
2183
- <td>
2184
- <pre class="lines">
2185
-
2186
-
2187
- 224
2188
- 225
2189
- 226
2190
- 227
2191
- 228</pre>
2192
- </td>
2193
- <td>
2194
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 224</span>
2195
-
2196
- <span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span>
2197
- <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
2198
- <span class='r identifier id'>r</span> <span class='lshft op'>&lt;&lt;</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='DRAWING_R constant id'>DRAWING_R</span><span class='comma token'>,</span> <span class='dstring node'>&quot;../#{@drawing.pn}&quot;</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span>
2199
- <span class='r identifier id'>r</span>
2200
- <span class='end end kw'>end</span>
2201
- </pre>
2202
- </td>
2203
- </tr>
2204
- </table>
2205
- </div>
2206
-
2207
- <div class="method_details ">
2208
- <p class="signature " id="rels_pn-instance_method">
2209
-
2210
- - (<tt>String</tt>) <strong>rels_pn</strong>
2211
-
2212
-
2213
-
2214
- </p><div class="docstring">
2215
- <div class="discussion">
2216
- <p>
2217
- The relationship part name of this worksheet
2218
- </p>
2219
-
2220
-
2221
- </div>
2222
- </div>
2223
- <div class="tags">
2224
-
2225
- <h3>Returns:</h3>
2226
- <ul class="return">
2227
-
2228
- <li>
2229
-
2230
-
2231
- <span class='type'>(<tt>String</tt>)</span>
2232
-
2233
-
2234
-
2235
- </li>
2236
-
2237
- </ul>
2238
-
2239
- </div><table class="source_code">
2240
- <tr>
2241
- <td>
2242
- <pre class="lines">
2243
-
2244
-
2245
- 92
2246
- 93
2247
- 94</pre>
2248
- </td>
2249
- <td>
2250
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 92</span>
2251
-
2252
- <span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span>
2253
- <span class='dstring node'>&quot;#{WORKSHEET_RELS_PN % (index+1)}&quot;</span>
2254
- <span class='end end kw'>end</span>
2255
- </pre>
2256
- </td>
2257
- </tr>
2258
- </table>
2259
- </div>
2260
-
2261
- <div class="method_details ">
2262
- <p class="signature " id="rId-instance_method">
2263
-
2264
- - (<tt>String</tt>) <strong>rId</strong>
2265
-
2266
-
2267
-
2268
- </p><div class="docstring">
2269
- <div class="discussion">
2270
- <p>
2271
- The relationship Id of thiw worksheet
2272
- </p>
2273
-
2274
-
2275
- </div>
2276
- </div>
2277
- <div class="tags">
2278
-
2279
- <h3>Returns:</h3>
2280
- <ul class="return">
2281
-
2282
- <li>
2283
-
2284
-
2285
- <span class='type'>(<tt>String</tt>)</span>
2286
-
2287
-
2288
-
2289
- </li>
2290
-
2291
- </ul>
2292
-
2293
- </div><table class="source_code">
2294
- <tr>
2295
- <td>
2296
- <pre class="lines">
2297
-
2298
-
2299
- 98
2300
- 99
2301
- 100</pre>
2302
- </td>
2303
- <td>
2304
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 98</span>
2305
-
2306
- <span class='def def kw'>def</span> <span class='rId identifier id'>rId</span>
2307
- <span class='dstring node'>&quot;rId#{index+1}&quot;</span>
2308
- <span class='end end kw'>end</span>
2309
- </pre>
2310
- </td>
2311
- </tr>
2312
- </table>
2313
- </div>
2314
-
2315
- <div class="method_details ">
2316
- <p class="signature " id="row_style-instance_method">
2317
-
2318
- - (<tt>Object</tt>) <strong>row_style</strong>(index, style, options = {})
2319
-
2320
-
2321
-
2322
- </p><div class="docstring">
2323
- <div class="discussion">
2324
-
2325
- <div class="note notetag">
2326
- <strong>Note:</strong>
2327
- <div class='inline'><p>
2328
- You can also specify the style in the add_row call
2329
- </p>
2330
- </div>
2331
- </div>
2332
-
2333
- <p>
2334
- Set the style for cells in a specific row
2335
- </p>
2336
-
2337
-
2338
- </div>
2339
- </div>
2340
- <div class="tags">
2341
- <h3>Parameters:</h3>
2342
- <ul class="param">
2343
-
2344
- <li>
2345
-
2346
- <span class='name'>index</span>
2347
-
2348
-
2349
- <span class='type'>(<tt>Integer</tt>)</span>
2350
-
2351
-
2352
-
2353
- &mdash;
2354
- <div class='inline'><p>
2355
- or range of indexes in the table
2356
- </p>
2357
- </div>
2358
-
2359
- </li>
2360
-
2361
- <li>
2362
-
2363
- <span class='name'>the</span>
2364
-
2365
-
2366
- <span class='type'>(<tt>Integer</tt>)</span>
2367
-
2368
-
2369
-
2370
- &mdash;
2371
- <div class='inline'><p>
2372
- cellXfs index
2373
- </p>
2374
- </div>
2375
-
2376
- </li>
2377
-
2378
- <li>
2379
-
2380
- <span class='name'>options</span>
2381
-
2382
-
2383
- <span class='type'>(<tt>Hash</tt>)</span>
2384
-
2385
-
2386
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2387
-
2388
-
2389
- &mdash;
2390
- <div class='inline'><p>
2391
- a customizable set of options
2392
- </p>
2393
- </div>
2394
-
2395
- </li>
2396
-
2397
- </ul>
2398
-
2399
-
2400
-
2401
-
2402
-
2403
-
2404
-
2405
-
2406
- <h3>Options Hash (<tt>options</tt>):</h3>
2407
- <ul class="option">
2408
-
2409
- <li>
2410
- <span class="name">col_offset</span>
2411
- <span class="type">(<tt>Integer</tt>)</span>
2412
- <span class="default">
2413
-
2414
- </span>
2415
- &mdash; <div class='inline'><p>
2416
- only cells after this column will be updated.
2417
- </p>
2418
- </div>
2419
- </li>
2420
-
2421
- </ul>
2422
-
2423
-
2424
-
2425
- <h3>See Also:</h3>
2426
- <ul class="see">
2427
-
2428
- <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li>
2429
-
2430
- <li>for an example</li>
2431
-
2432
- </ul>
2433
-
2434
- </div><table class="source_code">
2435
- <tr>
2436
- <td>
2437
- <pre class="lines">
2438
-
2439
-
2440
- 135
2441
- 136
2442
- 137
2443
- 138
2444
- 139
2445
- 140
2446
- 141
2447
- 142
2448
- 143</pre>
2449
- </td>
2450
- <td>
2451
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 135</span>
2452
-
2453
- <span class='def def kw'>def</span> <span class='row_style identifier id'>row_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</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>
2454
- <span class='offset identifier id'>offset</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:col_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span>
2455
- <span class='rs identifier id'>rs</span> <span class='assign token'>=</span> <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span>
2456
- <span class='if if kw'>if</span> <span class='rs identifier id'>rs</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>
2457
- <span class='rs identifier id'>rs</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='r identifier id'>r</span><span class='bitor op'>|</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</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='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span>
2458
- <span class='else else kw'>else</span>
2459
- <span class='rs identifier id'>rs</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</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='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span>
2460
- <span class='end end kw'>end</span>
2461
- <span class='end end kw'>end</span>
2462
- </pre>
2463
- </td>
2464
- </tr>
2465
- </table>
2466
- </div>
2467
-
2468
- <div class="method_details ">
2469
- <p class="signature " id="to_xml-instance_method">
2470
-
2471
- - (<tt>String</tt>) <strong>to_xml</strong>
2472
-
2473
-
2474
-
2475
- </p><div class="docstring">
2476
- <div class="discussion">
2477
- <p>
2478
- Serializes the worksheet document
2479
- </p>
2480
-
2481
-
2482
- </div>
2483
- </div>
2484
- <div class="tags">
2485
-
2486
- <h3>Returns:</h3>
2487
- <ul class="return">
2488
-
2489
- <li>
2490
-
2491
-
2492
- <span class='type'>(<tt>String</tt>)</span>
2493
-
2494
-
2495
-
2496
- </li>
2497
-
2498
- </ul>
2499
-
2500
- </div><table class="source_code">
2501
- <tr>
2502
- <td>
2503
- <pre class="lines">
2504
-
2505
-
2506
- 200
2507
- 201
2508
- 202
2509
- 203
2510
- 204
2511
- 205
2512
- 206
2513
- 207
2514
- 208
2515
- 209
2516
- 210
2517
- 211
2518
- 212
2519
- 213
2520
- 214
2521
- 215
2522
- 216
2523
- 217
2524
- 218
2525
- 219
2526
- 220</pre>
2527
- </td>
2528
- <td>
2529
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 200</span>
2530
-
2531
- <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span>
2532
- <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
2533
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
2534
- <span class='if if kw'>if</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span>
2535
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='cols identifier id'>cols</span> <span class='lbrace token'>{</span>
2536
- <span class='@auto_fit_data ivar id'>@auto_fit_data</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='col identifier id'>col</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span>
2537
- <span class='min_max identifier id'>min_max</span> <span class='assign token'>=</span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span>
2538
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='col identifier id'>col</span><span class='lparen token'>(</span><span class='symbol val'>:min=</span><span class='gt op'>&gt;</span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:max=</span><span class='gt op'>&gt;</span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:width</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:customWidth=</span><span class='gt op'>&gt;</span><span class='string val'>&quot;true&quot;</span><span class='rparen token'>)</span>
2539
- <span class='end end kw'>end</span>
2540
- <span class='rbrace token'>}</span>
2541
- <span class='end end kw'>end</span>
2542
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheetData identifier id'>sheetData</span> <span class='lbrace token'>{</span>
2543
- <span class='@rows ivar id'>@rows</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='row identifier id'>row</span><span class='bitor op'>|</span>
2544
- <span class='row identifier id'>row</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>
2545
- <span class='end end kw'>end</span>
2546
- <span class='rbrace token'>}</span>
2547
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span> <span class='symbol val'>:&quot;r:id&quot;</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='string val'>&quot;rId1&quot;</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span>
2548
- <span class='rbrace token'>}</span>
2549
- <span class='end end kw'>end</span>
2550
- <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
2551
- <span class='end end kw'>end</span>
2552
- </pre>
2553
- </td>
2554
- </tr>
2555
- </table>
2556
- </div>
2557
-
2558
- <div class="method_details ">
2559
- <p class="signature " id="update_auto_fit_data-instance_method">
2560
-
2561
- - (<tt>Array</tt>) <strong>update_auto_fit_data</strong>(cells)
2562
-
2563
-
2564
-
2565
- </p><div class="docstring">
2566
- <div class="discussion">
2567
- <p>
2568
- Updates auto fit data. Autofit data attempts to determine the cell in a
2569
- column that has the greatest width by comparing the length of the text
2570
- multiplied by the size of the font.
2571
- </p>
2572
-
2573
-
2574
- </div>
2575
- </div>
2576
- <div class="tags">
2577
- <h3>Parameters:</h3>
2578
- <ul class="param">
2579
-
2580
- <li>
2581
-
2582
- <span class='name'>cells</span>
2583
-
2584
-
2585
- <span class='type'>(<tt>Array</tt>)</span>
2586
-
2587
-
2588
-
2589
- &mdash;
2590
- <div class='inline'><p>
2591
- an array of cells
2592
- </p>
2593
- </div>
2594
-
2595
- </li>
2596
-
2597
- </ul>
2598
-
2599
- <h3>Returns:</h3>
2600
- <ul class="return">
2601
-
2602
- <li>
2603
-
2604
-
2605
- <span class='type'>(<tt>Array</tt>)</span>
2606
-
2607
-
2608
-
2609
- &mdash;
2610
- <div class='inline'><p>
2611
- of Cell objects
2612
- </p>
2613
- </div>
2614
-
2615
- </li>
2616
-
2617
- </ul>
2618
-
2619
- </div><table class="source_code">
2620
- <tr>
2621
- <td>
2622
- <pre class="lines">
2623
-
2624
-
2625
- 239
2626
- 240
2627
- 241
2628
- 242
2629
- 243
2630
- 244
2631
- 245
2632
- 246
2633
- 247
2634
- 248
2635
- 249
2636
- 250
2637
- 251
2638
- 252
2639
- 253
2640
- 254
2641
- 255
2642
- 256</pre>
2643
- </td>
2644
- <td>
2645
- <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 239</span>
2646
-
2647
- <span class='def def kw'>def</span> <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span><span class='lparen token'>(</span><span class='cells identifier id'>cells</span><span class='rparen token'>)</span>
2648
- <span class='styles identifier id'>styles</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span>
2649
- <span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='fonts identifier id'>fonts</span> <span class='assign token'>=</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span>
2650
- <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span>
2651
- <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='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span>
2652
- <span class='next next kw'>next</span> <span class='if if_mod kw'>if</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='String constant id'>String</span><span class='rparen token'>)</span> <span class='andop op'>&amp;&amp;</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='start_with? fid id'>start_with?</span><span class='lparen token'>(</span><span class='string val'>'='</span><span class='rparen token'>)</span>
2653
- <span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrace token'>{</span><span class='symbol val'>:longest=</span><span class='gt op'>&gt;</span><span class='string val'>&quot;&quot;</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>&gt;</span><span class='sz identifier id'>sz</span><span class='rbrace token'>}</span>
2654
- <span class='cell_xf identifier id'>cell_xf</span> <span class='assign token'>=</span> <span class='cellXfs identifier id'>cellXfs</span><span class='lbrack token'>[</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='rbrack token'>]</span>
2655
- <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='cell_xf identifier id'>cell_xf</span><span class='dot token'>.</span><span class='fontId identifier id'>fontId</span> <span class='orop op'>||</span> <span class='integer val'>0</span><span class='rbrack token'>]</span>
2656
- <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> <span class='orop op'>||</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> <span class='orop op'>||</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span>
2657
- <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='lt op'>&lt;</span> <span class='lparen token'>(</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='sz identifier id'>sz</span><span class='rparen token'>)</span>
2658
- <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='sz identifier id'>sz</span>
2659
- <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span>
2660
- <span class='end end kw'>end</span>
2661
- <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span>
2662
- <span class='end end kw'>end</span>
2663
- <span class='cells identifier id'>cells</span>
2664
- <span class='end end kw'>end</span>
2665
- </pre>
2666
- </td>
2667
- </tr>
2668
- </table>
2669
- </div>
2670
-
2671
- </div>
2672
-
2673
- </div>
2674
-
2675
- <div id="footer">
2676
- Generated on Mon Dec 5 14:21:17 2011 by
2677
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2678
- 0.7.3 (ruby-1.8.7).
2679
- </div>
2680
-
2681
- </body>
2682
- </html>