axlsx 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. data/README.md +10 -9
  2. data/doc/Axlsx.html +2443 -0
  3. data/doc/Axlsx/App.html +2640 -0
  4. data/doc/Axlsx/Axis.html +1047 -0
  5. data/doc/Axlsx/Bar3DChart.html +1153 -0
  6. data/doc/Axlsx/BarSeries.html +764 -0
  7. data/doc/Axlsx/Border.html +775 -0
  8. data/doc/Axlsx/BorderPr.html +709 -0
  9. data/doc/Axlsx/CatAxis.html +766 -0
  10. data/doc/Axlsx/Cell.html +1623 -0
  11. data/doc/Axlsx/CellAlignment.html +1247 -0
  12. data/doc/Axlsx/CellProtection.html +565 -0
  13. data/doc/Axlsx/CellStyle.html +949 -0
  14. data/doc/Axlsx/Chart.html +1459 -0
  15. data/doc/Axlsx/Color.html +665 -0
  16. data/doc/Axlsx/ContentType.html +340 -0
  17. data/doc/Axlsx/Core.html +465 -0
  18. data/doc/Axlsx/DataTypeValidator.html +324 -0
  19. data/doc/Axlsx/Default.html +575 -0
  20. data/doc/Axlsx/Drawing.html +1154 -0
  21. data/doc/Axlsx/Fill.html +460 -0
  22. data/doc/Axlsx/Font.html +1554 -0
  23. data/doc/Axlsx/GradientFill.html +1026 -0
  24. data/doc/Axlsx/GradientStop.html +526 -0
  25. data/doc/Axlsx/GraphicFrame.html +646 -0
  26. data/doc/Axlsx/Line3DChart.html +921 -0
  27. data/doc/Axlsx/LineSeries.html +656 -0
  28. data/doc/Axlsx/Marker.html +857 -0
  29. data/doc/Axlsx/NumFmt.html +562 -0
  30. data/doc/Axlsx/Override.html +568 -0
  31. data/doc/Axlsx/Package.html +1293 -0
  32. data/doc/Axlsx/PatternFill.html +681 -0
  33. data/doc/Axlsx/Pie3DChart.html +439 -0
  34. data/doc/Axlsx/PieSeries.html +762 -0
  35. data/doc/Axlsx/RegexValidator.html +268 -0
  36. data/doc/Axlsx/Relationship.html +554 -0
  37. data/doc/Axlsx/Relationships.html +343 -0
  38. data/doc/Axlsx/RestrictionValidator.html +300 -0
  39. data/doc/Axlsx/Row.html +771 -0
  40. data/doc/Axlsx/Scaling.html +740 -0
  41. data/doc/Axlsx/SerAxis.html +624 -0
  42. data/doc/Axlsx/Series.html +746 -0
  43. data/doc/Axlsx/SeriesTitle.html +289 -0
  44. data/doc/Axlsx/SimpleTypedList.html +1617 -0
  45. data/doc/Axlsx/Styles.html +1754 -0
  46. data/doc/Axlsx/TableStyle.html +710 -0
  47. data/doc/Axlsx/TableStyleElement.html +677 -0
  48. data/doc/Axlsx/TableStyles.html +599 -0
  49. data/doc/Axlsx/Title.html +625 -0
  50. data/doc/Axlsx/TwoCellAnchor.html +1115 -0
  51. data/doc/Axlsx/ValAxis.html +539 -0
  52. data/doc/Axlsx/View3D.html +971 -0
  53. data/doc/Axlsx/Workbook.html +1347 -0
  54. data/doc/Axlsx/Worksheet.html +1864 -0
  55. data/doc/Axlsx/Xf.html +1681 -0
  56. data/doc/_index.html +611 -0
  57. data/doc/class_list.html +47 -0
  58. data/doc/css/common.css +1 -0
  59. data/doc/css/full_list.css +55 -0
  60. data/doc/css/style.css +322 -0
  61. data/doc/file.README.html +262 -0
  62. data/doc/file_list.html +49 -0
  63. data/doc/frames.html +13 -0
  64. data/doc/index.html +262 -0
  65. data/doc/js/app.js +205 -0
  66. data/doc/js/full_list.js +167 -0
  67. data/doc/js/jquery.js +16 -0
  68. data/doc/method_list.html +3038 -0
  69. data/doc/top-level-namespace.html +103 -0
  70. data/lib/axlsx/util/constants.rb +1 -1
  71. metadata +71 -3
data/doc/Axlsx/Drawing.html ADDED
@@ -0,0 +1,1154 @@
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::Drawing
8
+
9
+ &mdash; Documentation by YARD 0.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (D)</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">Drawing</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::Drawing
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::Drawing</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/drawing/drawing.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+
98
+ <div class="note notetag">
99
+ <strong>Note:</strong>
100
+ <div class='inline'><p>
101
+ The recommended way to manage drawings is to use the Worksheet.add_chart
102
+ method, specifying the chart class, start and end marker locations.
103
+ </p>
104
+ </div>
105
+ </div>
106
+
107
+ <p>
108
+ A Drawing is a canvas for charts. Each worksheet has a single drawing that
109
+ can specify multiple anchors which reference charts.
110
+ </p>
111
+
112
+
113
+ </div>
114
+ </div>
115
+ <div class="tags">
116
+
117
+
118
+ <h3>See Also:</h3>
119
+ <ul class="see">
120
+
121
+ <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li>
122
+
123
+ <li><span class='object_link'><a href="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></li>
124
+
125
+ <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li>
126
+
127
+ </ul>
128
+
129
+ </div>
130
+
131
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
132
+ <ul class="summary">
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#anchors-instance_method" title="#anchors (instance method)">- (SimpleTypedList) <strong>anchors</strong> </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+
144
+ <span class="note title readonly">readonly</span>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+ <span class="summary_desc"><div class='inline'><p>
154
+ A collection of anchors for this drawing.
155
+ </p>
156
+ </div></span>
157
+
158
+ </li>
159
+
160
+
161
+ <li class="public ">
162
+ <span class="summary_signature">
163
+
164
+ <a href="#charts-instance_method" title="#charts (instance method)">- (Array) <strong>charts</strong> </a>
165
+
166
+
167
+
168
+ </span>
169
+
170
+
171
+ <span class="note title readonly">readonly</span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+ <span class="summary_desc"><div class='inline'><p>
181
+ An array of charts that are associated with this drawing&#8217;s anchors.
182
+ </p>
183
+ </div></span>
184
+
185
+ </li>
186
+
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+ <span class="note title readonly">readonly</span>
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+ <span class="summary_desc"><div class='inline'><p>
208
+ The index of this drawing in the owning workbooks&#8217;s drawings
209
+ collection.
210
+ </p>
211
+ </div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+ <span class="note title readonly">readonly</span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+ <span class="summary_desc"><div class='inline'><p>
236
+ The part name for this drawing.
237
+ </p>
238
+ </div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="public ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+ <span class="note title readonly">readonly</span>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <span class="summary_desc"><div class='inline'><p>
263
+ The drawing&#8217;s relationships.
264
+ </p>
265
+ </div></span>
266
+
267
+ </li>
268
+
269
+
270
+ <li class="public ">
271
+ <span class="summary_signature">
272
+
273
+ <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a>
274
+
275
+
276
+
277
+ </span>
278
+
279
+
280
+ <span class="note title readonly">readonly</span>
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+ <span class="summary_desc"><div class='inline'><p>
290
+ The relational part name for this drawing.
291
+ </p>
292
+ </div></span>
293
+
294
+ </li>
295
+
296
+
297
+ <li class="public ">
298
+ <span class="summary_signature">
299
+
300
+ <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a>
301
+
302
+
303
+
304
+ </span>
305
+
306
+
307
+ <span class="note title readonly">readonly</span>
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'><p>
317
+ The relation reference id for this drawing.
318
+ </p>
319
+ </div></span>
320
+
321
+ </li>
322
+
323
+
324
+ <li class="public ">
325
+ <span class="summary_signature">
326
+
327
+ <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a>
328
+
329
+
330
+
331
+ </span>
332
+
333
+
334
+ <span class="note title readonly">readonly</span>
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+ <span class="summary_desc"><div class='inline'><p>
344
+ The worksheet that owns the drawing.
345
+ </p>
346
+ </div></span>
347
+
348
+ </li>
349
+
350
+
351
+ </ul>
352
+
353
+
354
+
355
+
356
+
357
+ <h2>
358
+ Instance Method Summary
359
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
360
+ </h2>
361
+
362
+ <ul class="summary">
363
+
364
+ <li class="public ">
365
+ <span class="summary_signature">
366
+
367
+ <a href="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) </a>
368
+
369
+
370
+
371
+ </span>
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+ <span class="summary_desc"><div class='inline'><p>
381
+ Adds a chart to the drawing.
382
+ </p>
383
+ </div></span>
384
+
385
+ </li>
386
+
387
+
388
+ <li class="public ">
389
+ <span class="summary_signature">
390
+
391
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Drawing) <strong>initialize</strong>(worksheet) </a>
392
+
393
+
394
+
395
+ </span>
396
+
397
+ <span class="note title constructor">constructor</span>
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+ <span class="summary_desc"><div class='inline'><p>
407
+ Creates a new Drawing object.
408
+ </p>
409
+ </div></span>
410
+
411
+ </li>
412
+
413
+
414
+ <li class="public ">
415
+ <span class="summary_signature">
416
+
417
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
418
+
419
+
420
+
421
+ </span>
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+ <span class="summary_desc"><div class='inline'><p>
431
+ Serializes the drawing.
432
+ </p>
433
+ </div></span>
434
+
435
+ </li>
436
+
437
+
438
+ </ul>
439
+
440
+
441
+ <div id="constructor_details" class="method_details_list">
442
+ <h2>Constructor Details</h2>
443
+
444
+ <div class="method_details first">
445
+ <p class="signature first" id="initialize-instance_method">
446
+
447
+ - (<tt><span class='object_link'><a href="" title="Axlsx::Drawing (class)">Drawing</a></span></tt>) <strong>initialize</strong>(worksheet)
448
+
449
+
450
+
451
+ </p><div class="docstring">
452
+ <div class="discussion">
453
+ <p>
454
+ Creates a new Drawing object
455
+ </p>
456
+
457
+
458
+ </div>
459
+ </div>
460
+ <div class="tags">
461
+ <h3>Parameters:</h3>
462
+ <ul class="param">
463
+
464
+ <li>
465
+
466
+ <span class='name'>worksheet</span>
467
+
468
+
469
+ <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
470
+
471
+
472
+
473
+ &mdash;
474
+ <div class='inline'><p>
475
+ The worksheet that owns this drawing
476
+ </p>
477
+ </div>
478
+
479
+ </li>
480
+
481
+ </ul>
482
+
483
+
484
+ </div><table class="source_code">
485
+ <tr>
486
+ <td>
487
+ <pre class="lines">
488
+
489
+
490
+ 67
491
+ 68
492
+ 69
493
+ 70
494
+ 71
495
+ 72</pre>
496
+ </td>
497
+ <td>
498
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 67</span>
499
+
500
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='worksheet identifier id'>worksheet</span><span class='rparen token'>)</span>
501
+ <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>&quot;Drawing.worksheet&quot;</span><span class='comma token'>,</span> <span class='Worksheet constant id'>Worksheet</span><span class='comma token'>,</span> <span class='worksheet identifier id'>worksheet</span>
502
+ <span class='@worksheet ivar id'>@worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span>
503
+ <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span> <span class='lshft op'>&lt;&lt;</span> <span class='self self kw'>self</span>
504
+ <span class='@anchors ivar id'>@anchors</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='TwoCellAnchor constant id'>TwoCellAnchor</span>
505
+ <span class='end end kw'>end</span>
506
+ </pre>
507
+ </td>
508
+ </tr>
509
+ </table>
510
+ </div>
511
+
512
+ </div>
513
+
514
+ <div id="instance_attr_details" class="attr_details">
515
+ <h2>Instance Attribute Details</h2>
516
+
517
+
518
+ <span id=""></span>
519
+ <span id="anchors-instance_method"></span>
520
+ <div class="method_details first">
521
+ <p class="signature first" id="anchors-instance_method">
522
+
523
+ - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>anchors</strong> <span class="extras">(readonly)</span>
524
+
525
+
526
+
527
+ </p><div class="docstring">
528
+ <div class="discussion">
529
+ <p>
530
+ A collection of anchors for this drawing
531
+ </p>
532
+
533
+
534
+ </div>
535
+ </div>
536
+ <div class="tags">
537
+
538
+ <h3>Returns:</h3>
539
+ <ul class="return">
540
+
541
+ <li>
542
+
543
+
544
+ <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
545
+
546
+
547
+
548
+ </li>
549
+
550
+ </ul>
551
+
552
+ </div><table class="source_code">
553
+ <tr>
554
+ <td>
555
+ <pre class="lines">
556
+
557
+
558
+ 39
559
+ 40
560
+ 41</pre>
561
+ </td>
562
+ <td>
563
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 39</span>
564
+
565
+ <span class='def def kw'>def</span> <span class='anchors identifier id'>anchors</span>
566
+ <span class='@anchors ivar id'>@anchors</span>
567
+ <span class='end end kw'>end</span>
568
+ </pre>
569
+ </td>
570
+ </tr>
571
+ </table>
572
+ </div>
573
+
574
+
575
+ <span id=""></span>
576
+ <span id="charts-instance_method"></span>
577
+ <div class="method_details ">
578
+ <p class="signature " id="charts-instance_method">
579
+
580
+ - (<tt>Array</tt>) <strong>charts</strong> <span class="extras">(readonly)</span>
581
+
582
+
583
+
584
+ </p><div class="docstring">
585
+ <div class="discussion">
586
+ <p>
587
+ An array of charts that are associated with this drawing&#8217;s anchors
588
+ </p>
589
+
590
+
591
+ </div>
592
+ </div>
593
+ <div class="tags">
594
+
595
+ <h3>Returns:</h3>
596
+ <ul class="return">
597
+
598
+ <li>
599
+
600
+
601
+ <span class='type'>(<tt>Array</tt>)</span>
602
+
603
+
604
+
605
+ </li>
606
+
607
+ </ul>
608
+
609
+ </div><table class="source_code">
610
+ <tr>
611
+ <td>
612
+ <pre class="lines">
613
+
614
+
615
+ 43
616
+ 44
617
+ 45</pre>
618
+ </td>
619
+ <td>
620
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 43</span>
621
+
622
+ <span class='def def kw'>def</span> <span class='charts identifier id'>charts</span>
623
+ <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='rbrace token'>}</span>
624
+ <span class='end end kw'>end</span>
625
+ </pre>
626
+ </td>
627
+ </tr>
628
+ </table>
629
+ </div>
630
+
631
+
632
+ <span id=""></span>
633
+ <span id="index-instance_method"></span>
634
+ <div class="method_details ">
635
+ <p class="signature " id="index-instance_method">
636
+
637
+ - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span>
638
+
639
+
640
+
641
+ </p><div class="docstring">
642
+ <div class="discussion">
643
+ <p>
644
+ The index of this drawing in the owning workbooks&#8217;s drawings
645
+ collection.
646
+ </p>
647
+
648
+
649
+ </div>
650
+ </div>
651
+ <div class="tags">
652
+
653
+ <h3>Returns:</h3>
654
+ <ul class="return">
655
+
656
+ <li>
657
+
658
+
659
+ <span class='type'>(<tt>Integer</tt>)</span>
660
+
661
+
662
+
663
+ </li>
664
+
665
+ </ul>
666
+
667
+ </div><table class="source_code">
668
+ <tr>
669
+ <td>
670
+ <pre class="lines">
671
+
672
+
673
+ 47
674
+ 48
675
+ 49</pre>
676
+ </td>
677
+ <td>
678
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 47</span>
679
+
680
+ <span class='def def kw'>def</span> <span class='index identifier id'>index</span>
681
+ <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</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>
682
+ <span class='end end kw'>end</span>
683
+ </pre>
684
+ </td>
685
+ </tr>
686
+ </table>
687
+ </div>
688
+
689
+
690
+ <span id=""></span>
691
+ <span id="pn-instance_method"></span>
692
+ <div class="method_details ">
693
+ <p class="signature " id="pn-instance_method">
694
+
695
+ - (<tt>String</tt>) <strong>pn</strong> <span class="extras">(readonly)</span>
696
+
697
+
698
+
699
+ </p><div class="docstring">
700
+ <div class="discussion">
701
+ <p>
702
+ The part name for this drawing
703
+ </p>
704
+
705
+
706
+ </div>
707
+ </div>
708
+ <div class="tags">
709
+
710
+ <h3>Returns:</h3>
711
+ <ul class="return">
712
+
713
+ <li>
714
+
715
+
716
+ <span class='type'>(<tt>String</tt>)</span>
717
+
718
+
719
+
720
+ </li>
721
+
722
+ </ul>
723
+
724
+ </div><table class="source_code">
725
+ <tr>
726
+ <td>
727
+ <pre class="lines">
728
+
729
+
730
+ 55
731
+ 56
732
+ 57</pre>
733
+ </td>
734
+ <td>
735
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 55</span>
736
+
737
+ <span class='def def kw'>def</span> <span class='pn identifier id'>pn</span>
738
+ <span class='dstring node'>&quot;#{DRAWING_PN % (index+1)}&quot;</span>
739
+ <span class='end end kw'>end</span>
740
+ </pre>
741
+ </td>
742
+ </tr>
743
+ </table>
744
+ </div>
745
+
746
+
747
+ <span id=""></span>
748
+ <span id="relationships-instance_method"></span>
749
+ <div class="method_details ">
750
+ <p class="signature " id="relationships-instance_method">
751
+
752
+ - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> <span class="extras">(readonly)</span>
753
+
754
+
755
+
756
+ </p><div class="docstring">
757
+ <div class="discussion">
758
+ <p>
759
+ The drawing&#8217;s relationships.
760
+ </p>
761
+
762
+
763
+ </div>
764
+ </div>
765
+ <div class="tags">
766
+
767
+ <h3>Returns:</h3>
768
+ <ul class="return">
769
+
770
+ <li>
771
+
772
+
773
+ <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span>
774
+
775
+
776
+
777
+ </li>
778
+
779
+ </ul>
780
+
781
+ </div><table class="source_code">
782
+ <tr>
783
+ <td>
784
+ <pre class="lines">
785
+
786
+
787
+ 63
788
+ 64
789
+ 65
790
+ 66
791
+ 67
792
+ 68
793
+ 69
794
+ 70</pre>
795
+ </td>
796
+ <td>
797
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 63</span>
798
+
799
+ <span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span>
800
+ <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>
801
+ <span class='@anchors ivar id'>@anchors</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='anchor identifier id'>anchor</span><span class='bitor op'>|</span>
802
+ <span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span>
803
+ <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='CHART_R constant id'>CHART_R</span><span class='comma token'>,</span> <span class='dstring node'>&quot;../#{chart.pn}&quot;</span><span class='rparen token'>)</span>
804
+ <span class='end end kw'>end</span>
805
+ <span class='r identifier id'>r</span>
806
+ <span class='end end kw'>end</span>
807
+ </pre>
808
+ </td>
809
+ </tr>
810
+ </table>
811
+ </div>
812
+
813
+
814
+ <span id=""></span>
815
+ <span id="rels_pn-instance_method"></span>
816
+ <div class="method_details ">
817
+ <p class="signature " id="rels_pn-instance_method">
818
+
819
+ - (<tt>String</tt>) <strong>rels_pn</strong> <span class="extras">(readonly)</span>
820
+
821
+
822
+
823
+ </p><div class="docstring">
824
+ <div class="discussion">
825
+ <p>
826
+ The relational part name for this drawing
827
+ </p>
828
+
829
+
830
+ </div>
831
+ </div>
832
+ <div class="tags">
833
+
834
+ <h3>Returns:</h3>
835
+ <ul class="return">
836
+
837
+ <li>
838
+
839
+
840
+ <span class='type'>(<tt>String</tt>)</span>
841
+
842
+
843
+
844
+ </li>
845
+
846
+ </ul>
847
+
848
+ </div><table class="source_code">
849
+ <tr>
850
+ <td>
851
+ <pre class="lines">
852
+
853
+
854
+ 59
855
+ 60
856
+ 61</pre>
857
+ </td>
858
+ <td>
859
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 59</span>
860
+
861
+ <span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span>
862
+ <span class='dstring node'>&quot;#{DRAWING_RELS_PN % (index+1)}&quot;</span>
863
+ <span class='end end kw'>end</span>
864
+ </pre>
865
+ </td>
866
+ </tr>
867
+ </table>
868
+ </div>
869
+
870
+
871
+ <span id=""></span>
872
+ <span id="rId-instance_method"></span>
873
+ <div class="method_details ">
874
+ <p class="signature " id="rId-instance_method">
875
+
876
+ - (<tt>String</tt>) <strong>rId</strong> <span class="extras">(readonly)</span>
877
+
878
+
879
+
880
+ </p><div class="docstring">
881
+ <div class="discussion">
882
+ <p>
883
+ The relation reference id for this drawing
884
+ </p>
885
+
886
+
887
+ </div>
888
+ </div>
889
+ <div class="tags">
890
+
891
+ <h3>Returns:</h3>
892
+ <ul class="return">
893
+
894
+ <li>
895
+
896
+
897
+ <span class='type'>(<tt>String</tt>)</span>
898
+
899
+
900
+
901
+ </li>
902
+
903
+ </ul>
904
+
905
+ </div><table class="source_code">
906
+ <tr>
907
+ <td>
908
+ <pre class="lines">
909
+
910
+
911
+ 51
912
+ 52
913
+ 53</pre>
914
+ </td>
915
+ <td>
916
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 51</span>
917
+
918
+ <span class='def def kw'>def</span> <span class='rId identifier id'>rId</span>
919
+ <span class='dstring node'>&quot;rId#{index+1}&quot;</span>
920
+ <span class='end end kw'>end</span>
921
+ </pre>
922
+ </td>
923
+ </tr>
924
+ </table>
925
+ </div>
926
+
927
+
928
+ <span id=""></span>
929
+ <span id="worksheet-instance_method"></span>
930
+ <div class="method_details ">
931
+ <p class="signature " id="worksheet-instance_method">
932
+
933
+ - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong> <span class="extras">(readonly)</span>
934
+
935
+
936
+
937
+ </p><div class="docstring">
938
+ <div class="discussion">
939
+ <p>
940
+ The worksheet that owns the drawing
941
+ </p>
942
+
943
+
944
+ </div>
945
+ </div>
946
+ <div class="tags">
947
+
948
+ <h3>Returns:</h3>
949
+ <ul class="return">
950
+
951
+ <li>
952
+
953
+
954
+ <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span>
955
+
956
+
957
+
958
+ </li>
959
+
960
+ </ul>
961
+
962
+ </div><table class="source_code">
963
+ <tr>
964
+ <td>
965
+ <pre class="lines">
966
+
967
+
968
+ 34
969
+ 35
970
+ 36</pre>
971
+ </td>
972
+ <td>
973
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 34</span>
974
+
975
+ <span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span>
976
+ <span class='@worksheet ivar id'>@worksheet</span>
977
+ <span class='end end kw'>end</span>
978
+ </pre>
979
+ </td>
980
+ </tr>
981
+ </table>
982
+ </div>
983
+
984
+ </div>
985
+
986
+
987
+ <div id="instance_method_details" class="method_details_list">
988
+ <h2>Instance Method Details</h2>
989
+
990
+
991
+ <div class="method_details first">
992
+ <p class="signature first" id="add_chart-instance_method">
993
+
994
+ - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {})
995
+
996
+
997
+
998
+ </p><div class="docstring">
999
+ <div class="discussion">
1000
+
1001
+ <div class="note notetag">
1002
+ <strong>Note:</strong>
1003
+ <div class='inline'><p>
1004
+ The recommended way to manage charts is to use Worksheet.add_chart.
1005
+ </p>
1006
+ </div>
1007
+ </div>
1008
+
1009
+ <p>
1010
+ Adds a chart to the drawing.
1011
+ </p>
1012
+
1013
+
1014
+ </div>
1015
+ </div>
1016
+ <div class="tags">
1017
+ <h3>Parameters:</h3>
1018
+ <ul class="param">
1019
+
1020
+ <li>
1021
+
1022
+ <span class='name'>chart_type</span>
1023
+
1024
+
1025
+ <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span>
1026
+
1027
+
1028
+
1029
+ &mdash;
1030
+ <div class='inline'><p>
1031
+ The class of the chart to be added to the drawing
1032
+ </p>
1033
+ </div>
1034
+
1035
+ </li>
1036
+
1037
+ <li>
1038
+
1039
+ <span class='name'>options</span>
1040
+
1041
+
1042
+ <span class='type'>(<tt>Hash</tt>)</span>
1043
+
1044
+
1045
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1046
+
1047
+
1048
+ </li>
1049
+
1050
+ </ul>
1051
+
1052
+
1053
+ </div><table class="source_code">
1054
+ <tr>
1055
+ <td>
1056
+ <pre class="lines">
1057
+
1058
+
1059
+ 79
1060
+ 80
1061
+ 81
1062
+ 82
1063
+ 83</pre>
1064
+ </td>
1065
+ <td>
1066
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 79</span>
1067
+
1068
+ <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>
1069
+ <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>&quot;Drawing.chart_type&quot;</span><span class='comma token'>,</span> <span class='Chart constant id'>Chart</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span>
1070
+ <span class='TwoCellAnchor constant id'>TwoCellAnchor</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='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
1071
+ <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span>
1072
+ <span class='end end kw'>end</span>
1073
+ </pre>
1074
+ </td>
1075
+ </tr>
1076
+ </table>
1077
+ </div>
1078
+
1079
+ <div class="method_details ">
1080
+ <p class="signature " id="to_xml-instance_method">
1081
+
1082
+ - (<tt>String</tt>) <strong>to_xml</strong>
1083
+
1084
+
1085
+
1086
+ </p><div class="docstring">
1087
+ <div class="discussion">
1088
+ <p>
1089
+ Serializes the drawing
1090
+ </p>
1091
+
1092
+
1093
+ </div>
1094
+ </div>
1095
+ <div class="tags">
1096
+
1097
+ <h3>Returns:</h3>
1098
+ <ul class="return">
1099
+
1100
+ <li>
1101
+
1102
+
1103
+ <span class='type'>(<tt>String</tt>)</span>
1104
+
1105
+
1106
+
1107
+ </li>
1108
+
1109
+ </ul>
1110
+
1111
+ </div><table class="source_code">
1112
+ <tr>
1113
+ <td>
1114
+ <pre class="lines">
1115
+
1116
+
1117
+ 116
1118
+ 117
1119
+ 118
1120
+ 119
1121
+ 120
1122
+ 121
1123
+ 122
1124
+ 123</pre>
1125
+ </td>
1126
+ <td>
1127
+ <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 116</span>
1128
+
1129
+ <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span>
1130
+ <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>
1131
+ <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='string val'>'xdr:wsDr'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:xdr'</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='XML_NS_XDR constant id'>XML_NS_XDR</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
1132
+ <span class='anchors identifier id'>anchors</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='anchor identifier id'>anchor</span><span class='bitor op'>|</span> <span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
1133
+ <span class='rbrace token'>}</span>
1134
+ <span class='end end kw'>end</span>
1135
+ <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
1136
+ <span class='end end kw'>end</span>
1137
+ </pre>
1138
+ </td>
1139
+ </tr>
1140
+ </table>
1141
+ </div>
1142
+
1143
+ </div>
1144
+
1145
+ </div>
1146
+
1147
+ <div id="footer">
1148
+ Generated on Tue Nov 22 00:27:38 2011 by
1149
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1150
+ 0.7.3 (ruby-1.8.7).
1151
+ </div>
1152
+
1153
+ </body>
1154
+ </html>