axlsx 1.0.8 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. data/CHANGELOG.md +14 -0
  2. data/README.md +22 -21
  3. data/Rakefile +1 -1
  4. data/axlsx.gemspec +36 -0
  5. data/doc/Axlsx.html +373 -559
  6. data/doc/Axlsx/App.html +257 -360
  7. data/doc/Axlsx/Axis.html +113 -144
  8. data/doc/Axlsx/Bar3DChart.html +122 -152
  9. data/doc/Axlsx/BarSeries.html +67 -81
  10. data/doc/Axlsx/Border.html +96 -119
  11. data/doc/Axlsx/BorderPr.html +89 -114
  12. data/doc/Axlsx/CatAxis.html +79 -104
  13. data/doc/Axlsx/CatAxisData.html +40 -54
  14. data/doc/Axlsx/Cell.html +193 -679
  15. data/doc/Axlsx/CellAlignment.html +116 -157
  16. data/doc/Axlsx/CellProtection.html +50 -68
  17. data/doc/Axlsx/CellStyle.html +78 -106
  18. data/doc/Axlsx/Chart.html +361 -432
  19. data/doc/Axlsx/Color.html +56 -78
  20. data/doc/Axlsx/ContentType.html +28 -41
  21. data/doc/Axlsx/Core.html +43 -55
  22. data/doc/Axlsx/DataTypeValidator.html +34 -43
  23. data/doc/Axlsx/Default.html +55 -81
  24. data/doc/Axlsx/Drawing.html +322 -412
  25. data/doc/Axlsx/Fill.html +34 -47
  26. data/doc/Axlsx/Font.html +157 -207
  27. data/doc/Axlsx/GradientFill.html +90 -122
  28. data/doc/Axlsx/GradientStop.html +36 -50
  29. data/doc/Axlsx/GraphicFrame.html +106 -130
  30. data/doc/Axlsx/Line3DChart.html +108 -134
  31. data/doc/Axlsx/LineSeries.html +58 -67
  32. data/doc/Axlsx/Marker.html +84 -111
  33. data/doc/Axlsx/NumFmt.html +83 -102
  34. data/doc/Axlsx/OneCellAnchor.html +158 -196
  35. data/doc/Axlsx/Override.html +60 -92
  36. data/doc/Axlsx/Package.html +190 -759
  37. data/doc/Axlsx/PatternFill.html +78 -99
  38. data/doc/Axlsx/Pic.html +451 -405
  39. data/doc/Axlsx/Pie3DChart.html +33 -42
  40. data/doc/Axlsx/PieSeries.html +68 -80
  41. data/doc/Axlsx/RegexValidator.html +15 -20
  42. data/doc/Axlsx/Relationship.html +49 -66
  43. data/doc/Axlsx/Relationships.html +28 -41
  44. data/doc/Axlsx/RestrictionValidator.html +23 -32
  45. data/doc/Axlsx/Row.html +132 -161
  46. data/doc/Axlsx/Scaling.html +71 -90
  47. data/doc/Axlsx/SerAxis.html +61 -79
  48. data/doc/Axlsx/Series.html +125 -201
  49. data/doc/Axlsx/SeriesTitle.html +26 -31
  50. data/doc/Axlsx/Styles.html +286 -355
  51. data/doc/Axlsx/TableStyle.html +62 -87
  52. data/doc/Axlsx/TableStyleElement.html +84 -104
  53. data/doc/Axlsx/TableStyles.html +59 -82
  54. data/doc/Axlsx/Title.html +58 -155
  55. data/doc/Axlsx/TwoCellAnchor.html +165 -204
  56. data/doc/Axlsx/ValAxis.html +39 -53
  57. data/doc/Axlsx/ValAxisData.html +29 -39
  58. data/doc/Axlsx/View3D.html +93 -122
  59. data/doc/Axlsx/Workbook.html +359 -362
  60. data/doc/Axlsx/Worksheet.html +471 -816
  61. data/doc/Axlsx/Xf.html +341 -296
  62. data/doc/_index.html +7 -11
  63. data/doc/class_list.html +1 -1
  64. data/doc/file.LICENSE.html +86 -0
  65. data/doc/file.README.html +105 -107
  66. data/doc/file_list.html +3 -0
  67. data/doc/frames.html +1 -1
  68. data/doc/index.html +105 -107
  69. data/doc/method_list.html +426 -602
  70. data/doc/top-level-namespace.html +3 -3
  71. data/examples/example.rb +20 -1
  72. data/lib/axlsx.rb +20 -15
  73. data/lib/axlsx/content_type/default.rb +8 -3
  74. data/lib/axlsx/content_type/override.rb +11 -4
  75. data/lib/axlsx/doc_props/app.rb +53 -23
  76. data/lib/axlsx/drawing/axis.rb +16 -5
  77. data/lib/axlsx/drawing/bar_3D_chart.rb +15 -7
  78. data/lib/axlsx/drawing/bar_series.rb +7 -5
  79. data/lib/axlsx/drawing/cat_axis.rb +10 -3
  80. data/lib/axlsx/drawing/chart.rb +21 -15
  81. data/lib/axlsx/drawing/drawing.rb +16 -30
  82. data/lib/axlsx/drawing/graphic_frame.rb +2 -4
  83. data/lib/axlsx/drawing/line_3D_chart.rb +5 -2
  84. data/lib/axlsx/drawing/line_series.rb +6 -5
  85. data/lib/axlsx/drawing/marker.rb +9 -5
  86. data/lib/axlsx/drawing/one_cell_anchor.rb +7 -7
  87. data/lib/axlsx/drawing/pic.rb +29 -37
  88. data/lib/axlsx/drawing/pie_series.rb +7 -5
  89. data/lib/axlsx/drawing/scaling.rb +11 -5
  90. data/lib/axlsx/drawing/ser_axis.rb +6 -2
  91. data/lib/axlsx/drawing/series.rb +11 -11
  92. data/lib/axlsx/drawing/series_title.rb +1 -1
  93. data/lib/axlsx/drawing/title.rb +5 -12
  94. data/lib/axlsx/drawing/two_cell_anchor.rb +2 -3
  95. data/lib/axlsx/drawing/val_axis.rb +2 -2
  96. data/lib/axlsx/drawing/view_3D.rb +16 -9
  97. data/lib/axlsx/package.rb +25 -27
  98. data/lib/axlsx/rels/relationship.rb +4 -2
  99. data/lib/axlsx/stylesheet/border.rb +9 -4
  100. data/lib/axlsx/stylesheet/border_pr.rb +7 -4
  101. data/lib/axlsx/stylesheet/cell_alignment.rb +18 -9
  102. data/lib/axlsx/stylesheet/cell_protection.rb +5 -2
  103. data/lib/axlsx/stylesheet/cell_style.rb +12 -7
  104. data/lib/axlsx/stylesheet/color.rb +8 -6
  105. data/lib/axlsx/stylesheet/fill.rb +2 -1
  106. data/lib/axlsx/stylesheet/font.rb +24 -13
  107. data/lib/axlsx/stylesheet/gradient_fill.rb +16 -10
  108. data/lib/axlsx/stylesheet/gradient_stop.rb +5 -3
  109. data/lib/axlsx/stylesheet/num_fmt.rb +4 -2
  110. data/lib/axlsx/stylesheet/pattern_fill.rb +6 -4
  111. data/lib/axlsx/stylesheet/styles.rb +12 -12
  112. data/lib/axlsx/stylesheet/table_style.rb +6 -3
  113. data/lib/axlsx/stylesheet/table_style_element.rb +9 -4
  114. data/lib/axlsx/stylesheet/table_styles.rb +4 -4
  115. data/lib/axlsx/stylesheet/xf.rb +52 -31
  116. data/lib/axlsx/util/validators.rb +3 -3
  117. data/lib/axlsx/version.rb +1 -1
  118. data/lib/axlsx/workbook/workbook.rb +8 -9
  119. data/lib/axlsx/workbook/worksheet/cell.rb +25 -16
  120. data/lib/axlsx/workbook/worksheet/row.rb +2 -4
  121. data/lib/axlsx/workbook/worksheet/worksheet.rb +23 -32
  122. data/test/drawing/tc_one_cell_anchor.rb +1 -1
  123. metadata +135 -165
  124. data/doc/Axlsx/SimpleTypedList.html +0 -1686
  125. data/lib/schema/dc.xsd~ +0 -118
  126. data/lib/schema/dcterms.xsd~ +0 -331
  127. data/lib/schema/opc-coreProperties.xsd~ +0 -50
  128. data/test/drawing/tc_line_series.tc~ +0 -34
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: Axlsx::LineSeries
8
8
 
9
- &mdash; Documentation by YARD 0.7.3
9
+ &mdash; AXLSX
10
10
 
11
11
  </title>
12
12
 
@@ -99,15 +99,13 @@
99
99
 
100
100
  <div class="note notetag">
101
101
  <strong>Note:</strong>
102
- <div class='inline'><p>
103
- The recommended way to manage series is to use Chart#add_series
104
- </p>
102
+ <div class='inline'>
103
+ <p>The recommended way to manage series is to use Chart#add_series</p>
105
104
  </div>
106
105
  </div>
107
106
 
108
- <p>
109
- A LineSeries defines the title, data and labels for line charts
110
- </p>
107
+
108
+ <p>A LineSeries defines the title, data and labels for line charts</p>
111
109
 
112
110
 
113
111
  </div>
@@ -152,9 +150,8 @@ A LineSeries defines the title, data and labels for line charts
152
150
 
153
151
 
154
152
 
155
- <span class="summary_desc"><div class='inline'><p>
156
- The data for this series.
157
- </p>
153
+ <span class="summary_desc"><div class='inline'>
154
+ <p>The data for this series.</p>
158
155
  </div></span>
159
156
 
160
157
  </li>
@@ -179,9 +176,8 @@ The data for this series.
179
176
 
180
177
 
181
178
 
182
- <span class="summary_desc"><div class='inline'><p>
183
- The labels for this series.
184
- </p>
179
+ <span class="summary_desc"><div class='inline'>
180
+ <p>The labels for this series.</p>
185
181
  </div></span>
186
182
 
187
183
  </li>
@@ -197,7 +193,7 @@ The labels for this series.
197
193
 
198
194
 
199
195
  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3>
200
- <p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">order</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p>
196
+ <p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p>
201
197
 
202
198
 
203
199
 
@@ -226,9 +222,8 @@ The labels for this series.
226
222
 
227
223
 
228
224
 
229
- <span class="summary_desc"><div class='inline'><p>
230
- Creates a new series.
231
- </p>
225
+ <span class="summary_desc"><div class='inline'>
226
+ <p>Creates a new series.</p>
232
227
  </div></span>
233
228
 
234
229
  </li>
@@ -250,9 +245,8 @@ Creates a new series.
250
245
 
251
246
 
252
247
 
253
- <span class="summary_desc"><div class='inline'><p>
254
- Serializes the series.
255
- </p>
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>Serializes the series.</p>
256
250
  </div></span>
257
251
 
258
252
  </li>
@@ -266,7 +260,12 @@ Serializes the series.
266
260
 
267
261
 
268
262
 
269
- <div id="constructor_details" class="method_details_list">
263
+
264
+
265
+
266
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3>
267
+ <p class="inherited"><span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">#index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">#order</a></span>, <span class='object_link'><a href="Series.html#order%3D-instance_method" title="Axlsx::Series#order= (method)">#order=</a></span></p>
268
+ <div id="constructor_details" class="method_details_list">
270
269
  <h2>Constructor Details</h2>
271
270
 
272
271
  <div class="method_details first">
@@ -278,9 +277,8 @@ Serializes the series.
278
277
 
279
278
  </p><div class="docstring">
280
279
  <div class="discussion">
281
- <p>
282
- Creates a new series
283
- </p>
280
+
281
+ <p>Creates a new series</p>
284
282
 
285
283
 
286
284
  </div>
@@ -312,9 +310,8 @@ Creates a new series
312
310
 
313
311
 
314
312
  &mdash;
315
- <div class='inline'><p>
316
- a customizable set of options
317
- </p>
313
+ <div class='inline'>
314
+ <p>a customizable set of options</p>
318
315
  </div>
319
316
 
320
317
  </li>
@@ -361,17 +358,18 @@ a customizable set of options
361
358
  21
362
359
  22
363
360
  23
364
- 24</pre>
361
+ 24
362
+ 25</pre>
365
363
  </td>
366
364
  <td>
367
365
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 20</span>
368
366
 
369
- <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</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>
370
- <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
371
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier id'>labels</span> <span class='assign token'>=</span> <span class='CatAxisData constant id'>CatAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
372
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='ValAxisData constant id'>ValAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
373
- <span class='end end kw'>end</span>
374
- </pre>
367
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
368
+ <span class='ivar'>@labels</span><span class='comma'>,</span> <span class='ivar'>@data</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span>
369
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span>
370
+ <span class='ivar'>@labels</span> <span class='op'>=</span> <span class='const'>CatAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
371
+ <span class='ivar'>@data</span> <span class='op'>=</span> <span class='const'>ValAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
372
+ <span class='kw'>end</span></pre>
375
373
  </td>
376
374
  </tr>
377
375
  </table>
@@ -394,9 +392,8 @@ a customizable set of options
394
392
 
395
393
  </p><div class="docstring">
396
394
  <div class="discussion">
397
- <p>
398
- The data for this series.
399
- </p>
395
+
396
+ <p>The data for this series.</p>
400
397
 
401
398
 
402
399
  </div>
@@ -430,10 +427,9 @@ The data for this series.
430
427
  <td>
431
428
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 10</span>
432
429
 
433
- <span class='def def kw'>def</span> <span class='data identifier id'>data</span>
434
- <span class='@data ivar id'>@data</span>
435
- <span class='end end kw'>end</span>
436
- </pre>
430
+ <span class='kw'>def</span> <span class='id data'>data</span>
431
+ <span class='ivar'>@data</span>
432
+ <span class='kw'>end</span></pre>
437
433
  </td>
438
434
  </tr>
439
435
  </table>
@@ -451,9 +447,8 @@ The data for this series.
451
447
 
452
448
  </p><div class="docstring">
453
449
  <div class="discussion">
454
- <p>
455
- The labels for this series.
456
- </p>
450
+
451
+ <p>The labels for this series.</p>
457
452
 
458
453
 
459
454
  </div>
@@ -487,10 +482,9 @@ The labels for this series.
487
482
  <td>
488
483
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 14</span>
489
484
 
490
- <span class='def def kw'>def</span> <span class='labels identifier id'>labels</span>
491
- <span class='@labels ivar id'>@labels</span>
492
- <span class='end end kw'>end</span>
493
- </pre>
485
+ <span class='kw'>def</span> <span class='id labels'>labels</span>
486
+ <span class='ivar'>@labels</span>
487
+ <span class='kw'>end</span></pre>
494
488
  </td>
495
489
  </tr>
496
490
  </table>
@@ -512,9 +506,8 @@ The labels for this series.
512
506
 
513
507
  </p><div class="docstring">
514
508
  <div class="discussion">
515
- <p>
516
- Serializes the series
517
- </p>
509
+
510
+ <p>Serializes the series</p>
518
511
 
519
512
 
520
513
  </div>
@@ -533,9 +526,8 @@ Serializes the series
533
526
 
534
527
 
535
528
  &mdash;
536
- <div class='inline'><p>
537
- The document builder instance this objects xml will be added to.
538
- </p>
529
+ <div class='inline'>
530
+ <p>The document builder instance this objects xml will be added to.</p>
539
531
  </div>
540
532
 
541
533
  </li>
@@ -562,23 +554,22 @@ The document builder instance this objects xml will be added to.
562
554
  <pre class="lines">
563
555
 
564
556
 
565
- 29
566
557
  30
567
558
  31
568
559
  32
569
560
  33
570
- 34</pre>
561
+ 34
562
+ 35</pre>
571
563
  </td>
572
564
  <td>
573
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 29</span>
574
-
575
- <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
576
- <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</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>
577
- <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
578
- <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
579
- <span class='end end kw'>end</span>
580
- <span class='end end kw'>end</span>
581
- </pre>
565
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 30</span>
566
+
567
+ <span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span>
568
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml_inner'>xml_inner</span><span class='op'>|</span>
569
+ <span class='ivar'>@labels</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@labels</span><span class='period'>.</span><span class='id nil?'>nil?</span>
570
+ <span class='ivar'>@data</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id nil?'>nil?</span>
571
+ <span class='kw'>end</span>
572
+ <span class='kw'>end</span></pre>
582
573
  </td>
583
574
  </tr>
584
575
  </table>
@@ -589,9 +580,9 @@ The document builder instance this objects xml will be added to.
589
580
  </div>
590
581
 
591
582
  <div id="footer">
592
- Generated on Wed Nov 23 21:47:59 2011 by
583
+ Generated on Sat Nov 26 13:16:38 2011 by
593
584
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
594
- 0.7.3 (ruby-1.8.7).
585
+ 0.7.3 (ruby-1.9.3).
595
586
  </div>
596
587
 
597
588
  </body>
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: Axlsx::Marker
8
8
 
9
- &mdash; Documentation by YARD 0.7.3
9
+ &mdash; AXLSX
10
10
 
11
11
  </title>
12
12
 
@@ -97,17 +97,15 @@
97
97
 
98
98
  <div class="note notetag">
99
99
  <strong>Note:</strong>
100
- <div class='inline'><p>
101
- The recommended way to manage markers is Worksheet#add_chart Markers are
102
- created for a two cell anchor based on the :start and :end options.
103
- </p>
100
+ <div class='inline'>
101
+ <p>The recommended way to manage markers is Worksheet#add_chart Markers are
102
+ created for a two cell anchor based on the :start and :end options.</p>
104
103
  </div>
105
104
  </div>
106
105
 
107
- <p>
108
- The Marker class defines a point in the worksheet that drawing anchors
109
- attach to.
110
- </p>
106
+
107
+ <p>The Marker class defines a point in the worksheet that drawing anchors
108
+ attach to.</p>
111
109
 
112
110
 
113
111
  </div>
@@ -146,9 +144,8 @@ attach to.
146
144
 
147
145
 
148
146
 
149
- <span class="summary_desc"><div class='inline'><p>
150
- The column this marker anchors to.
151
- </p>
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>The column this marker anchors to.</p>
152
149
  </div></span>
153
150
 
154
151
  </li>
@@ -173,9 +170,8 @@ The column this marker anchors to.
173
170
 
174
171
 
175
172
 
176
- <span class="summary_desc"><div class='inline'><p>
177
- The offset distance from this marker&#8217;s column.
178
- </p>
173
+ <span class="summary_desc"><div class='inline'>
174
+ <p>The offset distance from this marker's column.</p>
179
175
  </div></span>
180
176
 
181
177
  </li>
@@ -200,9 +196,8 @@ The offset distance from this marker&#8217;s column.
200
196
 
201
197
 
202
198
 
203
- <span class="summary_desc"><div class='inline'><p>
204
- The row this marker anchors to.
205
- </p>
199
+ <span class="summary_desc"><div class='inline'>
200
+ <p>The row this marker anchors to.</p>
206
201
  </div></span>
207
202
 
208
203
  </li>
@@ -227,9 +222,8 @@ The row this marker anchors to.
227
222
 
228
223
 
229
224
 
230
- <span class="summary_desc"><div class='inline'><p>
231
- The offset distance from this marker&#8217;s row.
232
- </p>
225
+ <span class="summary_desc"><div class='inline'>
226
+ <p>The offset distance from this marker's row.</p>
233
227
  </div></span>
234
228
 
235
229
  </li>
@@ -264,9 +258,8 @@ The offset distance from this marker&#8217;s row.
264
258
 
265
259
 
266
260
 
267
- <span class="summary_desc"><div class='inline'><p>
268
- shortcut to set the column, row position for this marker.
269
- </p>
261
+ <span class="summary_desc"><div class='inline'>
262
+ <p>shortcut to set the column, row position for this marker.</p>
270
263
  </div></span>
271
264
 
272
265
  </li>
@@ -290,9 +283,8 @@ shortcut to set the column, row position for this marker.
290
283
 
291
284
 
292
285
 
293
- <span class="summary_desc"><div class='inline'><p>
294
- Creates a new Marker object.
295
- </p>
286
+ <span class="summary_desc"><div class='inline'>
287
+ <p>Creates a new Marker object.</p>
296
288
  </div></span>
297
289
 
298
290
  </li>
@@ -314,9 +306,8 @@ Creates a new Marker object.
314
306
 
315
307
 
316
308
 
317
- <span class="summary_desc"><div class='inline'><p>
318
- Serializes the marker.
319
- </p>
309
+ <span class="summary_desc"><div class='inline'>
310
+ <p>Serializes the marker.</p>
320
311
  </div></span>
321
312
 
322
313
  </li>
@@ -337,9 +328,8 @@ Serializes the marker.
337
328
 
338
329
  </p><div class="docstring">
339
330
  <div class="discussion">
340
- <p>
341
- Creates a new Marker object
342
- </p>
331
+
332
+ <p>Creates a new Marker object</p>
343
333
 
344
334
 
345
335
  </div>
@@ -360,9 +350,8 @@ Creates a new Marker object
360
350
 
361
351
 
362
352
  &mdash;
363
- <div class='inline'><p>
364
- a customizable set of options
365
- </p>
353
+ <div class='inline'>
354
+ <p>a customizable set of options</p>
366
355
  </div>
367
356
 
368
357
  </li>
@@ -431,13 +420,12 @@ a customizable set of options
431
420
  <td>
432
421
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 28</span>
433
422
 
434
- <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
435
- <span class='@col ivar id'>@col</span><span class='comma token'>,</span> <span class='@colOff ivar id'>@colOff</span><span class='comma token'>,</span> <span class='@row ivar id'>@row</span><span class='comma token'>,</span> <span class='@rowOff ivar id'>@rowOff</span> <span class='assign token'>=</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span>
436
- <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span>
437
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>&quot;#{o[0]}=&quot;</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span>
438
- <span class='end end kw'>end</span>
439
- <span class='end end kw'>end</span>
440
- </pre>
423
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
424
+ <span class='ivar'>@col</span><span class='comma'>,</span> <span class='ivar'>@colOff</span><span class='comma'>,</span> <span class='ivar'>@row</span><span class='comma'>,</span> <span class='ivar'>@rowOff</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span>
425
+ <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span>
426
+ <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
427
+ <span class='kw'>end</span>
428
+ <span class='kw'>end</span></pre>
441
429
  </td>
442
430
  </tr>
443
431
  </table>
@@ -460,9 +448,8 @@ a customizable set of options
460
448
 
461
449
  </p><div class="docstring">
462
450
  <div class="discussion">
463
- <p>
464
- The column this marker anchors to
465
- </p>
451
+
452
+ <p>The column this marker anchors to</p>
466
453
 
467
454
 
468
455
  </div>
@@ -496,10 +483,9 @@ The column this marker anchors to
496
483
  <td>
497
484
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 9</span>
498
485
 
499
- <span class='def def kw'>def</span> <span class='col identifier id'>col</span>
500
- <span class='@col ivar id'>@col</span>
501
- <span class='end end kw'>end</span>
502
- </pre>
486
+ <span class='kw'>def</span> <span class='id col'>col</span>
487
+ <span class='ivar'>@col</span>
488
+ <span class='kw'>end</span></pre>
503
489
  </td>
504
490
  </tr>
505
491
  </table>
@@ -517,9 +503,8 @@ The column this marker anchors to
517
503
 
518
504
  </p><div class="docstring">
519
505
  <div class="discussion">
520
- <p>
521
- The offset distance from this marker&#8217;s column
522
- </p>
506
+
507
+ <p>The offset distance from this marker's column</p>
523
508
 
524
509
 
525
510
  </div>
@@ -553,10 +538,9 @@ The offset distance from this marker&#8217;s column
553
538
  <td>
554
539
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 13</span>
555
540
 
556
- <span class='def def kw'>def</span> <span class='colOff identifier id'>colOff</span>
557
- <span class='@colOff ivar id'>@colOff</span>
558
- <span class='end end kw'>end</span>
559
- </pre>
541
+ <span class='kw'>def</span> <span class='id colOff'>colOff</span>
542
+ <span class='ivar'>@colOff</span>
543
+ <span class='kw'>end</span></pre>
560
544
  </td>
561
545
  </tr>
562
546
  </table>
@@ -574,9 +558,8 @@ The offset distance from this marker&#8217;s column
574
558
 
575
559
  </p><div class="docstring">
576
560
  <div class="discussion">
577
- <p>
578
- The row this marker anchors to
579
- </p>
561
+
562
+ <p>The row this marker anchors to</p>
580
563
 
581
564
 
582
565
  </div>
@@ -610,10 +593,9 @@ The row this marker anchors to
610
593
  <td>
611
594
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 17</span>
612
595
 
613
- <span class='def def kw'>def</span> <span class='row identifier id'>row</span>
614
- <span class='@row ivar id'>@row</span>
615
- <span class='end end kw'>end</span>
616
- </pre>
596
+ <span class='kw'>def</span> <span class='id row'>row</span>
597
+ <span class='ivar'>@row</span>
598
+ <span class='kw'>end</span></pre>
617
599
  </td>
618
600
  </tr>
619
601
  </table>
@@ -631,9 +613,8 @@ The row this marker anchors to
631
613
 
632
614
  </p><div class="docstring">
633
615
  <div class="discussion">
634
- <p>
635
- The offset distance from this marker&#8217;s row
636
- </p>
616
+
617
+ <p>The offset distance from this marker's row</p>
637
618
 
638
619
 
639
620
  </div>
@@ -667,10 +648,9 @@ The offset distance from this marker&#8217;s row
667
648
  <td>
668
649
  <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 21</span>
669
650
 
670
- <span class='def def kw'>def</span> <span class='rowOff identifier id'>rowOff</span>
671
- <span class='@rowOff ivar id'>@rowOff</span>
672
- <span class='end end kw'>end</span>
673
- </pre>
651
+ <span class='kw'>def</span> <span class='id rowOff'>rowOff</span>
652
+ <span class='ivar'>@rowOff</span>
653
+ <span class='kw'>end</span></pre>
674
654
  </td>
675
655
  </tr>
676
656
  </table>
@@ -692,9 +672,8 @@ The offset distance from this marker&#8217;s row
692
672
 
693
673
  </p><div class="docstring">
694
674
  <div class="discussion">
695
- <p>
696
- shortcut to set the column, row position for this marker
697
- </p>
675
+
676
+ <p>shortcut to set the column, row position for this marker</p>
698
677
 
699
678
 
700
679
  </div>
@@ -713,9 +692,8 @@ shortcut to set the column, row position for this marker
713
692
 
714
693
 
715
694
  &mdash;
716
- <div class='inline'><p>
717
- the column for the marker
718
- </p>
695
+ <div class='inline'>
696
+ <p>the column for the marker</p>
719
697
  </div>
720
698
 
721
699
  </li>
@@ -730,9 +708,8 @@ the column for the marker
730
708
 
731
709
 
732
710
  &mdash;
733
- <div class='inline'><p>
734
- the row of the marker
735
- </p>
711
+ <div class='inline'>
712
+ <p>the row of the marker</p>
736
713
  </div>
737
714
 
738
715
  </li>
@@ -746,19 +723,18 @@ the row of the marker
746
723
  <pre class="lines">
747
724
 
748
725
 
749
- 43
750
- 44
751
- 45
752
- 46</pre>
726
+ 47
727
+ 48
728
+ 49
729
+ 50</pre>
753
730
  </td>
754
731
  <td>
755
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 43</span>
732
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 47</span>
756
733
 
757
- <span class='def def kw'>def</span> <span class='coord identifier id'>coord</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='row identifier id'>row</span><span class='rparen token'>)</span>
758
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span>
759
- <span class='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span>
760
- <span class='end end kw'>end</span>
761
- </pre>
734
+ <span class='kw'>def</span> <span class='id coord'>coord</span><span class='lparen'>(</span><span class='id col'>col</span><span class='comma'>,</span> <span class='id row'>row</span><span class='rparen'>)</span>
735
+ <span class='kw'>self</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id col'>col</span>
736
+ <span class='kw'>self</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id row'>row</span>
737
+ <span class='kw'>end</span></pre>
762
738
  </td>
763
739
  </tr>
764
740
  </table>
@@ -773,9 +749,8 @@ the row of the marker
773
749
 
774
750
  </p><div class="docstring">
775
751
  <div class="discussion">
776
- <p>
777
- Serializes the marker
778
- </p>
752
+
753
+ <p>Serializes the marker</p>
779
754
 
780
755
 
781
756
  </div>
@@ -794,9 +769,8 @@ Serializes the marker
794
769
 
795
770
 
796
771
  &mdash;
797
- <div class='inline'><p>
798
- The document builder instance this objects xml will be added to.
799
- </p>
772
+ <div class='inline'>
773
+ <p>The document builder instance this objects xml will be added to.</p>
800
774
  </div>
801
775
 
802
776
  </li>
@@ -823,21 +797,20 @@ The document builder instance this objects xml will be added to.
823
797
  <pre class="lines">
824
798
 
825
799
 
826
- 50
827
- 51
828
- 52
829
- 53
830
- 54</pre>
800
+ 54
801
+ 55
802
+ 56
803
+ 57
804
+ 58</pre>
831
805
  </td>
832
806
  <td>
833
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 50</span>
834
-
835
- <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
836
- <span class='lbrack token'>[</span><span class='symbol val'>:col</span><span class='comma token'>,</span> <span class='symbol val'>:colOff</span><span class='comma token'>,</span> <span class='symbol val'>:row</span><span class='comma token'>,</span> <span class='symbol val'>:rowOff</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='k identifier id'>k</span><span class='bitor op'>|</span>
837
- <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>&quot;xdr:#{k.to_s}&quot;</span><span class='comma token'>,</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
838
- <span class='end end kw'>end</span>
839
- <span class='end end kw'>end</span>
840
- </pre>
807
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 54</span>
808
+
809
+ <span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span>
810
+ <span class='lbracket'>[</span><span class='symbol'>:col</span><span class='comma'>,</span> <span class='symbol'>:colOff</span><span class='comma'>,</span> <span class='symbol'>:row</span><span class='comma'>,</span> <span class='symbol'>:rowOff</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='op'>|</span>
811
+ <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>xdr:</span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id k'>k</span><span class='rparen'>)</span><span class='rparen'>)</span>
812
+ <span class='kw'>end</span>
813
+ <span class='kw'>end</span></pre>
841
814
  </td>
842
815
  </tr>
843
816
  </table>
@@ -848,9 +821,9 @@ The document builder instance this objects xml will be added to.
848
821
  </div>
849
822
 
850
823
  <div id="footer">
851
- Generated on Wed Nov 23 21:48:04 2011 by
824
+ Generated on Sat Nov 26 13:16:37 2011 by
852
825
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
853
- 0.7.3 (ruby-1.8.7).
826
+ 0.7.3 (ruby-1.9.3).
854
827
  </div>
855
828
 
856
829
  </body>