axlsx 1.0.10 → 1.0.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (102) hide show
  1. data/CHANGELOG.md +14 -0
  2. data/Gemfile +3 -7
  3. data/Gemfile.lock +17 -8
  4. data/README.md +88 -59
  5. data/axlsx.gemspec +9 -3
  6. data/doc/Axlsx.html +482 -248
  7. data/doc/Axlsx/App.html +237 -159
  8. data/doc/Axlsx/Axis.html +75 -51
  9. data/doc/Axlsx/Bar3DChart.html +75 -53
  10. data/doc/Axlsx/BarSeries.html +45 -31
  11. data/doc/Axlsx/Border.html +70 -50
  12. data/doc/Axlsx/BorderPr.html +80 -62
  13. data/doc/Axlsx/CatAxis.html +62 -43
  14. data/doc/Axlsx/CatAxisData.html +23 -16
  15. data/doc/Axlsx/Cell.html +2022 -393
  16. data/doc/Axlsx/CellAlignment.html +103 -75
  17. data/doc/Axlsx/CellProtection.html +44 -30
  18. data/doc/Axlsx/CellStyle.html +66 -46
  19. data/doc/Axlsx/Chart.html +159 -108
  20. data/doc/Axlsx/Color.html +73 -52
  21. data/doc/Axlsx/ContentType.html +20 -14
  22. data/doc/Axlsx/Core.html +29 -20
  23. data/doc/Axlsx/DataTypeValidator.html +27 -19
  24. data/doc/Axlsx/Default.html +39 -27
  25. data/doc/Axlsx/Drawing.html +104 -70
  26. data/doc/Axlsx/Fill.html +33 -23
  27. data/doc/Axlsx/Font.html +132 -98
  28. data/doc/Axlsx/GradientFill.html +70 -48
  29. data/doc/Axlsx/GradientStop.html +31 -21
  30. data/doc/Axlsx/GraphicFrame.html +40 -27
  31. data/doc/Axlsx/Line3DChart.html +62 -43
  32. data/doc/Axlsx/LineSeries.html +37 -25
  33. data/doc/Axlsx/Marker.html +63 -43
  34. data/doc/Axlsx/NumFmt.html +79 -65
  35. data/doc/Axlsx/OneCellAnchor.html +78 -54
  36. data/doc/Axlsx/Override.html +39 -27
  37. data/doc/Axlsx/Package.html +103 -163
  38. data/doc/Axlsx/Parser.html +549 -0
  39. data/doc/Axlsx/PatternFill.html +66 -51
  40. data/doc/Axlsx/Pic.html +230 -123
  41. data/doc/Axlsx/PictureLocking.html +1159 -0
  42. data/doc/Axlsx/Pie3DChart.html +23 -16
  43. data/doc/Axlsx/PieSeries.html +44 -30
  44. data/doc/Axlsx/RegexValidator.html +14 -10
  45. data/doc/Axlsx/Relationship.html +40 -27
  46. data/doc/Axlsx/Relationships.html +20 -14
  47. data/doc/Axlsx/RestrictionValidator.html +25 -17
  48. data/doc/Axlsx/Row.html +73 -53
  49. data/doc/Axlsx/Scaling.html +46 -31
  50. data/doc/Axlsx/SerAxis.html +49 -33
  51. data/doc/Axlsx/Series.html +51 -35
  52. data/doc/Axlsx/SeriesTitle.html +14 -10
  53. data/doc/Axlsx/Styles.html +210 -156
  54. data/doc/Axlsx/TableStyle.html +47 -32
  55. data/doc/Axlsx/TableStyleElement.html +75 -61
  56. data/doc/Axlsx/TableStyles.html +42 -28
  57. data/doc/Axlsx/Title.html +36 -25
  58. data/doc/Axlsx/TwoCellAnchor.html +83 -58
  59. data/doc/Axlsx/ValAxis.html +35 -24
  60. data/doc/Axlsx/ValAxisData.html +13 -9
  61. data/doc/Axlsx/View3D.html +64 -43
  62. data/doc/Axlsx/Workbook.html +305 -147
  63. data/doc/Axlsx/Worksheet.html +567 -271
  64. data/doc/Axlsx/Xf.html +114 -77
  65. data/doc/_index.html +15 -1
  66. data/doc/class_list.html +1 -1
  67. data/doc/css/style.css +1 -1
  68. data/doc/file.LICENSE.html +25 -21
  69. data/doc/file.README.html +89 -66
  70. data/doc/index.html +89 -66
  71. data/doc/js/app.js +4 -4
  72. data/doc/method_list.html +717 -413
  73. data/doc/top-level-namespace.html +1 -1
  74. data/examples/example.rb +52 -25
  75. data/examples/follow_20111202.xlsx +0 -0
  76. data/lib/axlsx.rb +14 -1
  77. data/lib/axlsx/drawing/chart.rb +20 -4
  78. data/lib/axlsx/drawing/drawing.rb +1 -1
  79. data/lib/axlsx/drawing/pic.rb +5 -2
  80. data/lib/axlsx/drawing/picture_locking.rb +72 -0
  81. data/lib/axlsx/package.rb +9 -7
  82. data/lib/axlsx/stylesheet/color.rb +19 -9
  83. data/lib/axlsx/stylesheet/styles.rb +2 -0
  84. data/lib/axlsx/util/constants.rb +6 -0
  85. data/lib/axlsx/util/parser.rb +43 -0
  86. data/lib/axlsx/version.rb +1 -1
  87. data/lib/axlsx/workbook/workbook.rb +21 -1
  88. data/lib/axlsx/workbook/worksheet/cell.rb +159 -7
  89. data/lib/axlsx/workbook/worksheet/row.rb +4 -2
  90. data/lib/axlsx/workbook/worksheet/worksheet.rb +38 -4
  91. data/test/drawing/tc_picture_locking.rb +73 -0
  92. data/test/rels/tc_relationships.rb +0 -1
  93. data/test/stylesheet/tc_styles.rb +0 -12
  94. data/test/tc_package.rb +5 -3
  95. data/test/workbook/tc_workbook.rb +7 -0
  96. data/test/workbook/worksheet/tc_cell.rb +102 -1
  97. data/test/workbook/worksheet/tc_worksheet.rb +17 -0
  98. metadata +79 -19
  99. data/doc/Axlsx/Ar.html +0 -196
  100. data/doc/Axlsx/Ar/ClassMethods.html +0 -188
  101. data/doc/Axlsx/Ar/InstanceMethods.html +0 -108
  102. data/doc/Axlsx/Ar/SingletonMethods.html +0 -312
data/doc/Axlsx/Xf.html CHANGED
@@ -94,9 +94,10 @@
94
94
 
95
95
  <h2>Overview</h2><div class="docstring">
96
96
  <div class="discussion">
97
-
98
- <p>The Xf class defines a formatting record for use in Styles. The recommended
99
- way to manage styles for your workbook is with Styles#add_style</p>
97
+ <p>
98
+ The Xf class defines a formatting record for use in Styles. The recommended
99
+ way to manage styles for your workbook is with Styles#add_style
100
+ </p>
100
101
 
101
102
 
102
103
  </div>
@@ -135,8 +136,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
135
136
 
136
137
 
137
138
 
138
- <span class="summary_desc"><div class='inline'>
139
- <p>The cell alignment for this style.</p>
139
+ <span class="summary_desc"><div class='inline'><p>
140
+ The cell alignment for this style.
141
+ </p>
140
142
  </div></span>
141
143
 
142
144
  </li>
@@ -161,8 +163,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
161
163
 
162
164
 
163
165
 
164
- <span class="summary_desc"><div class='inline'>
165
- <p>Indicates if the alignment options should be applied.</p>
166
+ <span class="summary_desc"><div class='inline'><p>
167
+ Indicates if the alignment options should be applied.
168
+ </p>
166
169
  </div></span>
167
170
 
168
171
  </li>
@@ -187,8 +190,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
187
190
 
188
191
 
189
192
 
190
- <span class="summary_desc"><div class='inline'>
191
- <p>indicates if the borderId should be applied.</p>
193
+ <span class="summary_desc"><div class='inline'><p>
194
+ indicates if the borderId should be applied.
195
+ </p>
192
196
  </div></span>
193
197
 
194
198
  </li>
@@ -213,8 +217,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
213
217
 
214
218
 
215
219
 
216
- <span class="summary_desc"><div class='inline'>
217
- <p>indicates if the fillId should be applied.</p>
220
+ <span class="summary_desc"><div class='inline'><p>
221
+ indicates if the fillId should be applied.
222
+ </p>
218
223
  </div></span>
219
224
 
220
225
  </li>
@@ -239,8 +244,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
239
244
 
240
245
 
241
246
 
242
- <span class="summary_desc"><div class='inline'>
243
- <p>indicates if the fontId should be applied.</p>
247
+ <span class="summary_desc"><div class='inline'><p>
248
+ indicates if the fontId should be applied.
249
+ </p>
244
250
  </div></span>
245
251
 
246
252
  </li>
@@ -265,8 +271,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
265
271
 
266
272
 
267
273
 
268
- <span class="summary_desc"><div class='inline'>
269
- <p>indicates if the numFmtId should be applied.</p>
274
+ <span class="summary_desc"><div class='inline'><p>
275
+ indicates if the numFmtId should be applied.
276
+ </p>
270
277
  </div></span>
271
278
 
272
279
  </li>
@@ -291,8 +298,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
291
298
 
292
299
 
293
300
 
294
- <span class="summary_desc"><div class='inline'>
295
- <p>Indicates if the protection options should be applied.</p>
301
+ <span class="summary_desc"><div class='inline'><p>
302
+ Indicates if the protection options should be applied.
303
+ </p>
296
304
  </div></span>
297
305
 
298
306
  </li>
@@ -317,8 +325,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
317
325
 
318
326
 
319
327
 
320
- <span class="summary_desc"><div class='inline'>
321
- <p>index (0 based) of the border to be used in this style.</p>
328
+ <span class="summary_desc"><div class='inline'><p>
329
+ index (0 based) of the border to be used in this style.
330
+ </p>
322
331
  </div></span>
323
332
 
324
333
  </li>
@@ -343,8 +352,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
343
352
 
344
353
 
345
354
 
346
- <span class="summary_desc"><div class='inline'>
347
- <p>index (0 based) of the fill to be used in this style.</p>
355
+ <span class="summary_desc"><div class='inline'><p>
356
+ index (0 based) of the fill to be used in this style.
357
+ </p>
348
358
  </div></span>
349
359
 
350
360
  </li>
@@ -369,8 +379,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
369
379
 
370
380
 
371
381
 
372
- <span class="summary_desc"><div class='inline'>
373
- <p>index (0 based) of the font to be used in this style.</p>
382
+ <span class="summary_desc"><div class='inline'><p>
383
+ index (0 based) of the font to be used in this style.
384
+ </p>
374
385
  </div></span>
375
386
 
376
387
  </li>
@@ -395,8 +406,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
395
406
 
396
407
 
397
408
 
398
- <span class="summary_desc"><div class='inline'>
399
- <p>id of the numFmt to apply to this style.</p>
409
+ <span class="summary_desc"><div class='inline'><p>
410
+ id of the numFmt to apply to this style.
411
+ </p>
400
412
  </div></span>
401
413
 
402
414
  </li>
@@ -421,8 +433,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
421
433
 
422
434
 
423
435
 
424
- <span class="summary_desc"><div class='inline'>
425
- <p>indicates if the cell has a pivot table drop down button.</p>
436
+ <span class="summary_desc"><div class='inline'><p>
437
+ indicates if the cell has a pivot table drop down button.
438
+ </p>
426
439
  </div></span>
427
440
 
428
441
  </li>
@@ -447,8 +460,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
447
460
 
448
461
 
449
462
 
450
- <span class="summary_desc"><div class='inline'>
451
- <p>The cell protection for this style.</p>
463
+ <span class="summary_desc"><div class='inline'><p>
464
+ The cell protection for this style.
465
+ </p>
452
466
  </div></span>
453
467
 
454
468
  </li>
@@ -473,8 +487,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
473
487
 
474
488
 
475
489
 
476
- <span class="summary_desc"><div class='inline'>
477
- <p>indecates if text should be prefixed by a single quote in the cell.</p>
490
+ <span class="summary_desc"><div class='inline'><p>
491
+ indecates if text should be prefixed by a single quote in the cell.
492
+ </p>
478
493
  </div></span>
479
494
 
480
495
  </li>
@@ -499,8 +514,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
499
514
 
500
515
 
501
516
 
502
- <span class="summary_desc"><div class='inline'>
503
- <p>index (0 based) of cellStylesXfs item to be used in this style.</p>
517
+ <span class="summary_desc"><div class='inline'><p>
518
+ index (0 based) of cellStylesXfs item to be used in this style.
519
+ </p>
504
520
  </div></span>
505
521
 
506
522
  </li>
@@ -537,8 +553,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
537
553
 
538
554
 
539
555
 
540
- <span class="summary_desc"><div class='inline'>
541
- <p>Creates a new Xf object.</p>
556
+ <span class="summary_desc"><div class='inline'><p>
557
+ Creates a new Xf object.
558
+ </p>
542
559
  </div></span>
543
560
 
544
561
  </li>
@@ -560,8 +577,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
560
577
 
561
578
 
562
579
 
563
- <span class="summary_desc"><div class='inline'>
564
- <p>Serializes the xf elemen.</p>
580
+ <span class="summary_desc"><div class='inline'><p>
581
+ Serializes the xf elemen.
582
+ </p>
565
583
  </div></span>
566
584
 
567
585
  </li>
@@ -582,8 +600,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
582
600
 
583
601
  </p><div class="docstring">
584
602
  <div class="discussion">
585
-
586
- <p>Creates a new Xf object</p>
603
+ <p>
604
+ Creates a new Xf object
605
+ </p>
587
606
 
588
607
 
589
608
  </div>
@@ -604,8 +623,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
604
623
 
605
624
 
606
625
  &mdash;
607
- <div class='inline'>
608
- <p>a customizable set of options</p>
626
+ <div class='inline'><p>
627
+ a customizable set of options
628
+ </p>
609
629
  </div>
610
630
 
611
631
  </li>
@@ -800,8 +820,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
800
820
 
801
821
  </p><div class="docstring">
802
822
  <div class="discussion">
803
-
804
- <p>The cell alignment for this style</p>
823
+ <p>
824
+ The cell alignment for this style
825
+ </p>
805
826
 
806
827
 
807
828
  </div>
@@ -863,8 +884,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
863
884
 
864
885
  </p><div class="docstring">
865
886
  <div class="discussion">
866
-
867
- <p>Indicates if the alignment options should be applied</p>
887
+ <p>
888
+ Indicates if the alignment options should be applied
889
+ </p>
868
890
 
869
891
 
870
892
  </div>
@@ -919,8 +941,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
919
941
 
920
942
  </p><div class="docstring">
921
943
  <div class="discussion">
922
-
923
- <p>indicates if the borderId should be applied</p>
944
+ <p>
945
+ indicates if the borderId should be applied
946
+ </p>
924
947
 
925
948
 
926
949
  </div>
@@ -975,8 +998,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
975
998
 
976
999
  </p><div class="docstring">
977
1000
  <div class="discussion">
978
-
979
- <p>indicates if the fillId should be applied</p>
1001
+ <p>
1002
+ indicates if the fillId should be applied
1003
+ </p>
980
1004
 
981
1005
 
982
1006
  </div>
@@ -1031,8 +1055,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1031
1055
 
1032
1056
  </p><div class="docstring">
1033
1057
  <div class="discussion">
1034
-
1035
- <p>indicates if the fontId should be applied</p>
1058
+ <p>
1059
+ indicates if the fontId should be applied
1060
+ </p>
1036
1061
 
1037
1062
 
1038
1063
  </div>
@@ -1087,8 +1112,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1087
1112
 
1088
1113
  </p><div class="docstring">
1089
1114
  <div class="discussion">
1090
-
1091
- <p>indicates if the numFmtId should be applied</p>
1115
+ <p>
1116
+ indicates if the numFmtId should be applied
1117
+ </p>
1092
1118
 
1093
1119
 
1094
1120
  </div>
@@ -1143,8 +1169,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1143
1169
 
1144
1170
  </p><div class="docstring">
1145
1171
  <div class="discussion">
1146
-
1147
- <p>Indicates if the protection options should be applied</p>
1172
+ <p>
1173
+ Indicates if the protection options should be applied
1174
+ </p>
1148
1175
 
1149
1176
 
1150
1177
  </div>
@@ -1199,8 +1226,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1199
1226
 
1200
1227
  </p><div class="docstring">
1201
1228
  <div class="discussion">
1202
-
1203
- <p>index (0 based) of the border to be used in this style</p>
1229
+ <p>
1230
+ index (0 based) of the border to be used in this style
1231
+ </p>
1204
1232
 
1205
1233
 
1206
1234
  </div>
@@ -1255,8 +1283,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1255
1283
 
1256
1284
  </p><div class="docstring">
1257
1285
  <div class="discussion">
1258
-
1259
- <p>index (0 based) of the fill to be used in this style</p>
1286
+ <p>
1287
+ index (0 based) of the fill to be used in this style
1288
+ </p>
1260
1289
 
1261
1290
 
1262
1291
  </div>
@@ -1311,8 +1340,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1311
1340
 
1312
1341
  </p><div class="docstring">
1313
1342
  <div class="discussion">
1314
-
1315
- <p>index (0 based) of the font to be used in this style</p>
1343
+ <p>
1344
+ index (0 based) of the font to be used in this style
1345
+ </p>
1316
1346
 
1317
1347
 
1318
1348
  </div>
@@ -1367,8 +1397,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1367
1397
 
1368
1398
  </p><div class="docstring">
1369
1399
  <div class="discussion">
1370
-
1371
- <p>id of the numFmt to apply to this style</p>
1400
+ <p>
1401
+ id of the numFmt to apply to this style
1402
+ </p>
1372
1403
 
1373
1404
 
1374
1405
  </div>
@@ -1423,8 +1454,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1423
1454
 
1424
1455
  </p><div class="docstring">
1425
1456
  <div class="discussion">
1426
-
1427
- <p>indicates if the cell has a pivot table drop down button</p>
1457
+ <p>
1458
+ indicates if the cell has a pivot table drop down button
1459
+ </p>
1428
1460
 
1429
1461
 
1430
1462
  </div>
@@ -1479,8 +1511,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1479
1511
 
1480
1512
  </p><div class="docstring">
1481
1513
  <div class="discussion">
1482
-
1483
- <p>The cell protection for this style</p>
1514
+ <p>
1515
+ The cell protection for this style
1516
+ </p>
1484
1517
 
1485
1518
 
1486
1519
  </div>
@@ -1542,8 +1575,9 @@ way to manage styles for your workbook is with Styles#add_style</p>
1542
1575
 
1543
1576
  </p><div class="docstring">
1544
1577
  <div class="discussion">
1545
-
1546
- <p>indecates if text should be prefixed by a single quote in the cell</p>
1578
+ <p>
1579
+ indecates if text should be prefixed by a single quote in the cell
1580
+ </p>
1547
1581
 
1548
1582
 
1549
1583
  </div>
@@ -1598,9 +1632,10 @@ way to manage styles for your workbook is with Styles#add_style</p>
1598
1632
 
1599
1633
  </p><div class="docstring">
1600
1634
  <div class="discussion">
1601
-
1602
- <p>index (0 based) of cellStylesXfs item to be used in this style. Only
1603
- applies to cellXfs items</p>
1635
+ <p>
1636
+ index (0 based) of cellStylesXfs item to be used in this style. Only
1637
+ applies to cellXfs items
1638
+ </p>
1604
1639
 
1605
1640
 
1606
1641
  </div>
@@ -1659,8 +1694,9 @@ applies to cellXfs items</p>
1659
1694
 
1660
1695
  </p><div class="docstring">
1661
1696
  <div class="discussion">
1662
-
1663
- <p>Serializes the xf elemen</p>
1697
+ <p>
1698
+ Serializes the xf elemen
1699
+ </p>
1664
1700
 
1665
1701
 
1666
1702
  </div>
@@ -1679,8 +1715,9 @@ applies to cellXfs items</p>
1679
1715
 
1680
1716
 
1681
1717
  &mdash;
1682
- <div class='inline'>
1683
- <p>The document builder instance this objects xml will be added to.</p>
1718
+ <div class='inline'><p>
1719
+ The document builder instance this objects xml will be added to.
1720
+ </p>
1684
1721
  </div>
1685
1722
 
1686
1723
  </li>
@@ -1734,7 +1771,7 @@ applies to cellXfs items</p>
1734
1771
  </div>
1735
1772
 
1736
1773
  <div id="footer">
1737
- Generated on Wed Nov 30 08:53:53 2011 by
1774
+ Generated on Mon Dec 5 14:21:08 2011 by
1738
1775
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1739
1776
  0.7.3 (ruby-1.8.7).
1740
1777
  </div>
data/doc/_index.html CHANGED
@@ -388,6 +388,13 @@
388
388
 
389
389
  </li>
390
390
 
391
+ <li>
392
+ <span class='object_link'><a href="Axlsx/Parser.html" title="Axlsx::Parser (module)">Parser</a></span>
393
+
394
+ <small>(Axlsx)</small>
395
+
396
+ </li>
397
+
391
398
  <li>
392
399
  <span class='object_link'><a href="Axlsx/PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span>
393
400
 
@@ -402,6 +409,13 @@
402
409
 
403
410
  </li>
404
411
 
412
+ <li>
413
+ <span class='object_link'><a href="Axlsx/PictureLocking.html" title="Axlsx::PictureLocking (class)">PictureLocking</a></span>
414
+
415
+ <small>(Axlsx)</small>
416
+
417
+ </li>
418
+
405
419
  <li>
406
420
  <span class='object_link'><a href="Axlsx/Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span>
407
421
 
@@ -626,7 +640,7 @@
626
640
  </div>
627
641
 
628
642
  <div id="footer">
629
- Generated on Wed Nov 30 08:53:34 2011 by
643
+ Generated on Mon Dec 5 14:21:05 2011 by
630
644
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
631
645
  0.7.3 (ruby-1.8.7).
632
646
  </div>