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.
- data/README.md +10 -9
- data/doc/Axlsx.html +2443 -0
- data/doc/Axlsx/App.html +2640 -0
- data/doc/Axlsx/Axis.html +1047 -0
- data/doc/Axlsx/Bar3DChart.html +1153 -0
- data/doc/Axlsx/BarSeries.html +764 -0
- data/doc/Axlsx/Border.html +775 -0
- data/doc/Axlsx/BorderPr.html +709 -0
- data/doc/Axlsx/CatAxis.html +766 -0
- data/doc/Axlsx/Cell.html +1623 -0
- data/doc/Axlsx/CellAlignment.html +1247 -0
- data/doc/Axlsx/CellProtection.html +565 -0
- data/doc/Axlsx/CellStyle.html +949 -0
- data/doc/Axlsx/Chart.html +1459 -0
- data/doc/Axlsx/Color.html +665 -0
- data/doc/Axlsx/ContentType.html +340 -0
- data/doc/Axlsx/Core.html +465 -0
- data/doc/Axlsx/DataTypeValidator.html +324 -0
- data/doc/Axlsx/Default.html +575 -0
- data/doc/Axlsx/Drawing.html +1154 -0
- data/doc/Axlsx/Fill.html +460 -0
- data/doc/Axlsx/Font.html +1554 -0
- data/doc/Axlsx/GradientFill.html +1026 -0
- data/doc/Axlsx/GradientStop.html +526 -0
- data/doc/Axlsx/GraphicFrame.html +646 -0
- data/doc/Axlsx/Line3DChart.html +921 -0
- data/doc/Axlsx/LineSeries.html +656 -0
- data/doc/Axlsx/Marker.html +857 -0
- data/doc/Axlsx/NumFmt.html +562 -0
- data/doc/Axlsx/Override.html +568 -0
- data/doc/Axlsx/Package.html +1293 -0
- data/doc/Axlsx/PatternFill.html +681 -0
- data/doc/Axlsx/Pie3DChart.html +439 -0
- data/doc/Axlsx/PieSeries.html +762 -0
- data/doc/Axlsx/RegexValidator.html +268 -0
- data/doc/Axlsx/Relationship.html +554 -0
- data/doc/Axlsx/Relationships.html +343 -0
- data/doc/Axlsx/RestrictionValidator.html +300 -0
- data/doc/Axlsx/Row.html +771 -0
- data/doc/Axlsx/Scaling.html +740 -0
- data/doc/Axlsx/SerAxis.html +624 -0
- data/doc/Axlsx/Series.html +746 -0
- data/doc/Axlsx/SeriesTitle.html +289 -0
- data/doc/Axlsx/SimpleTypedList.html +1617 -0
- data/doc/Axlsx/Styles.html +1754 -0
- data/doc/Axlsx/TableStyle.html +710 -0
- data/doc/Axlsx/TableStyleElement.html +677 -0
- data/doc/Axlsx/TableStyles.html +599 -0
- data/doc/Axlsx/Title.html +625 -0
- data/doc/Axlsx/TwoCellAnchor.html +1115 -0
- data/doc/Axlsx/ValAxis.html +539 -0
- data/doc/Axlsx/View3D.html +971 -0
- data/doc/Axlsx/Workbook.html +1347 -0
- data/doc/Axlsx/Worksheet.html +1864 -0
- data/doc/Axlsx/Xf.html +1681 -0
- data/doc/_index.html +611 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +262 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +262 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +3038 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/axlsx/util/constants.rb +1 -1
- metadata +71 -3
|
@@ -0,0 +1,857 @@
|
|
|
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::Marker
|
|
8
|
+
|
|
9
|
+
— 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 (M)</a> »
|
|
37
|
+
<span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
|
|
38
|
+
»
|
|
39
|
+
<span class="title">Marker</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::Marker
|
|
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::Marker</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/marker.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 markers is Worksheet#add_chart Markers are
|
|
102
|
+
created for a two cell anchor based on the :start and :end options.
|
|
103
|
+
</p>
|
|
104
|
+
</div>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<p>
|
|
108
|
+
The Marker class defines a point in the worksheet that drawing anchors
|
|
109
|
+
attach to.
|
|
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
|
+
</ul>
|
|
124
|
+
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
128
|
+
<ul class="summary">
|
|
129
|
+
|
|
130
|
+
<li class="public ">
|
|
131
|
+
<span class="summary_signature">
|
|
132
|
+
|
|
133
|
+
<a href="#col-instance_method" title="#col (instance method)">- (Integer) <strong>col</strong> </a>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</span>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
150
|
+
The column this marker anchors to.
|
|
151
|
+
</p>
|
|
152
|
+
</div></span>
|
|
153
|
+
|
|
154
|
+
</li>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<li class="public ">
|
|
158
|
+
<span class="summary_signature">
|
|
159
|
+
|
|
160
|
+
<a href="#colOff-instance_method" title="#colOff (instance method)">- (Integer) <strong>colOff</strong> </a>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</span>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
177
|
+
The offset distance from this marker’s column.
|
|
178
|
+
</p>
|
|
179
|
+
</div></span>
|
|
180
|
+
|
|
181
|
+
</li>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<li class="public ">
|
|
185
|
+
<span class="summary_signature">
|
|
186
|
+
|
|
187
|
+
<a href="#row-instance_method" title="#row (instance method)">- (Integer) <strong>row</strong> </a>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
</span>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
204
|
+
The row this marker anchors to.
|
|
205
|
+
</p>
|
|
206
|
+
</div></span>
|
|
207
|
+
|
|
208
|
+
</li>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<li class="public ">
|
|
212
|
+
<span class="summary_signature">
|
|
213
|
+
|
|
214
|
+
<a href="#rowOff-instance_method" title="#rowOff (instance method)">- (Integer) <strong>rowOff</strong> </a>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</span>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
231
|
+
The offset distance from this marker’s row.
|
|
232
|
+
</p>
|
|
233
|
+
</div></span>
|
|
234
|
+
|
|
235
|
+
</li>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</ul>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<h2>
|
|
245
|
+
Instance Method Summary
|
|
246
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
247
|
+
</h2>
|
|
248
|
+
|
|
249
|
+
<ul class="summary">
|
|
250
|
+
|
|
251
|
+
<li class="public ">
|
|
252
|
+
<span class="summary_signature">
|
|
253
|
+
|
|
254
|
+
<a href="#coord-instance_method" title="#coord (instance method)">- (Object) <strong>coord</strong>(col, row) </a>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</span>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
268
|
+
shortcut to set the column, row position for this marker.
|
|
269
|
+
</p>
|
|
270
|
+
</div></span>
|
|
271
|
+
|
|
272
|
+
</li>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<li class="public ">
|
|
276
|
+
<span class="summary_signature">
|
|
277
|
+
|
|
278
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Marker) <strong>initialize</strong>(options = {}) </a>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
</span>
|
|
283
|
+
|
|
284
|
+
<span class="note title constructor">constructor</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
294
|
+
Creates a new Marker object.
|
|
295
|
+
</p>
|
|
296
|
+
</div></span>
|
|
297
|
+
|
|
298
|
+
</li>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<li class="public ">
|
|
302
|
+
<span class="summary_signature">
|
|
303
|
+
|
|
304
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
</span>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
318
|
+
Serializes the marker.
|
|
319
|
+
</p>
|
|
320
|
+
</div></span>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</ul>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<div id="constructor_details" class="method_details_list">
|
|
329
|
+
<h2>Constructor Details</h2>
|
|
330
|
+
|
|
331
|
+
<div class="method_details first">
|
|
332
|
+
<p class="signature first" id="initialize-instance_method">
|
|
333
|
+
|
|
334
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>initialize</strong>(options = {})
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
</p><div class="docstring">
|
|
339
|
+
<div class="discussion">
|
|
340
|
+
<p>
|
|
341
|
+
Creates a new Marker object
|
|
342
|
+
</p>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
</div>
|
|
346
|
+
</div>
|
|
347
|
+
<div class="tags">
|
|
348
|
+
<h3>Parameters:</h3>
|
|
349
|
+
<ul class="param">
|
|
350
|
+
|
|
351
|
+
<li>
|
|
352
|
+
|
|
353
|
+
<span class='name'>options</span>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
—
|
|
363
|
+
<div class='inline'><p>
|
|
364
|
+
a customizable set of options
|
|
365
|
+
</p>
|
|
366
|
+
</div>
|
|
367
|
+
|
|
368
|
+
</li>
|
|
369
|
+
|
|
370
|
+
</ul>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
376
|
+
<ul class="option">
|
|
377
|
+
|
|
378
|
+
<li>
|
|
379
|
+
<span class="name">col</span>
|
|
380
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
381
|
+
<span class="default">
|
|
382
|
+
|
|
383
|
+
</span>
|
|
384
|
+
|
|
385
|
+
</li>
|
|
386
|
+
|
|
387
|
+
<li>
|
|
388
|
+
<span class="name">colOff</span>
|
|
389
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
390
|
+
<span class="default">
|
|
391
|
+
|
|
392
|
+
</span>
|
|
393
|
+
|
|
394
|
+
</li>
|
|
395
|
+
|
|
396
|
+
<li>
|
|
397
|
+
<span class="name">row</span>
|
|
398
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
399
|
+
<span class="default">
|
|
400
|
+
|
|
401
|
+
</span>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
<li>
|
|
406
|
+
<span class="name">rowOff</span>
|
|
407
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
408
|
+
<span class="default">
|
|
409
|
+
|
|
410
|
+
</span>
|
|
411
|
+
|
|
412
|
+
</li>
|
|
413
|
+
|
|
414
|
+
</ul>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
</div><table class="source_code">
|
|
419
|
+
<tr>
|
|
420
|
+
<td>
|
|
421
|
+
<pre class="lines">
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
28
|
|
425
|
+
29
|
|
426
|
+
30
|
|
427
|
+
31
|
|
428
|
+
32
|
|
429
|
+
33</pre>
|
|
430
|
+
</td>
|
|
431
|
+
<td>
|
|
432
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 28</span>
|
|
433
|
+
|
|
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'>"#{o[0]}="</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>
|
|
441
|
+
</td>
|
|
442
|
+
</tr>
|
|
443
|
+
</table>
|
|
444
|
+
</div>
|
|
445
|
+
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
<div id="instance_attr_details" class="attr_details">
|
|
449
|
+
<h2>Instance Attribute Details</h2>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<span id="col=-instance_method"></span>
|
|
453
|
+
<span id="col-instance_method"></span>
|
|
454
|
+
<div class="method_details first">
|
|
455
|
+
<p class="signature first" id="col-instance_method">
|
|
456
|
+
|
|
457
|
+
- (<tt>Integer</tt>) <strong>col</strong>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
</p><div class="docstring">
|
|
462
|
+
<div class="discussion">
|
|
463
|
+
<p>
|
|
464
|
+
The column this marker anchors to
|
|
465
|
+
</p>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
</div>
|
|
470
|
+
<div class="tags">
|
|
471
|
+
|
|
472
|
+
<h3>Returns:</h3>
|
|
473
|
+
<ul class="return">
|
|
474
|
+
|
|
475
|
+
<li>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
</li>
|
|
483
|
+
|
|
484
|
+
</ul>
|
|
485
|
+
|
|
486
|
+
</div><table class="source_code">
|
|
487
|
+
<tr>
|
|
488
|
+
<td>
|
|
489
|
+
<pre class="lines">
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
9
|
|
493
|
+
10
|
|
494
|
+
11</pre>
|
|
495
|
+
</td>
|
|
496
|
+
<td>
|
|
497
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 9</span>
|
|
498
|
+
|
|
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>
|
|
503
|
+
</td>
|
|
504
|
+
</tr>
|
|
505
|
+
</table>
|
|
506
|
+
</div>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
<span id="colOff=-instance_method"></span>
|
|
510
|
+
<span id="colOff-instance_method"></span>
|
|
511
|
+
<div class="method_details ">
|
|
512
|
+
<p class="signature " id="colOff-instance_method">
|
|
513
|
+
|
|
514
|
+
- (<tt>Integer</tt>) <strong>colOff</strong>
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
</p><div class="docstring">
|
|
519
|
+
<div class="discussion">
|
|
520
|
+
<p>
|
|
521
|
+
The offset distance from this marker’s column
|
|
522
|
+
</p>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
</div>
|
|
526
|
+
</div>
|
|
527
|
+
<div class="tags">
|
|
528
|
+
|
|
529
|
+
<h3>Returns:</h3>
|
|
530
|
+
<ul class="return">
|
|
531
|
+
|
|
532
|
+
<li>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
</li>
|
|
540
|
+
|
|
541
|
+
</ul>
|
|
542
|
+
|
|
543
|
+
</div><table class="source_code">
|
|
544
|
+
<tr>
|
|
545
|
+
<td>
|
|
546
|
+
<pre class="lines">
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
13
|
|
550
|
+
14
|
|
551
|
+
15</pre>
|
|
552
|
+
</td>
|
|
553
|
+
<td>
|
|
554
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 13</span>
|
|
555
|
+
|
|
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>
|
|
560
|
+
</td>
|
|
561
|
+
</tr>
|
|
562
|
+
</table>
|
|
563
|
+
</div>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<span id="row=-instance_method"></span>
|
|
567
|
+
<span id="row-instance_method"></span>
|
|
568
|
+
<div class="method_details ">
|
|
569
|
+
<p class="signature " id="row-instance_method">
|
|
570
|
+
|
|
571
|
+
- (<tt>Integer</tt>) <strong>row</strong>
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
</p><div class="docstring">
|
|
576
|
+
<div class="discussion">
|
|
577
|
+
<p>
|
|
578
|
+
The row this marker anchors to
|
|
579
|
+
</p>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</div>
|
|
583
|
+
</div>
|
|
584
|
+
<div class="tags">
|
|
585
|
+
|
|
586
|
+
<h3>Returns:</h3>
|
|
587
|
+
<ul class="return">
|
|
588
|
+
|
|
589
|
+
<li>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
</li>
|
|
597
|
+
|
|
598
|
+
</ul>
|
|
599
|
+
|
|
600
|
+
</div><table class="source_code">
|
|
601
|
+
<tr>
|
|
602
|
+
<td>
|
|
603
|
+
<pre class="lines">
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
17
|
|
607
|
+
18
|
|
608
|
+
19</pre>
|
|
609
|
+
</td>
|
|
610
|
+
<td>
|
|
611
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 17</span>
|
|
612
|
+
|
|
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>
|
|
617
|
+
</td>
|
|
618
|
+
</tr>
|
|
619
|
+
</table>
|
|
620
|
+
</div>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
<span id="rowOff=-instance_method"></span>
|
|
624
|
+
<span id="rowOff-instance_method"></span>
|
|
625
|
+
<div class="method_details ">
|
|
626
|
+
<p class="signature " id="rowOff-instance_method">
|
|
627
|
+
|
|
628
|
+
- (<tt>Integer</tt>) <strong>rowOff</strong>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
</p><div class="docstring">
|
|
633
|
+
<div class="discussion">
|
|
634
|
+
<p>
|
|
635
|
+
The offset distance from this marker’s row
|
|
636
|
+
</p>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
</div>
|
|
640
|
+
</div>
|
|
641
|
+
<div class="tags">
|
|
642
|
+
|
|
643
|
+
<h3>Returns:</h3>
|
|
644
|
+
<ul class="return">
|
|
645
|
+
|
|
646
|
+
<li>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
</li>
|
|
654
|
+
|
|
655
|
+
</ul>
|
|
656
|
+
|
|
657
|
+
</div><table class="source_code">
|
|
658
|
+
<tr>
|
|
659
|
+
<td>
|
|
660
|
+
<pre class="lines">
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
21
|
|
664
|
+
22
|
|
665
|
+
23</pre>
|
|
666
|
+
</td>
|
|
667
|
+
<td>
|
|
668
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 21</span>
|
|
669
|
+
|
|
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>
|
|
674
|
+
</td>
|
|
675
|
+
</tr>
|
|
676
|
+
</table>
|
|
677
|
+
</div>
|
|
678
|
+
|
|
679
|
+
</div>
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
<div id="instance_method_details" class="method_details_list">
|
|
683
|
+
<h2>Instance Method Details</h2>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<div class="method_details first">
|
|
687
|
+
<p class="signature first" id="coord-instance_method">
|
|
688
|
+
|
|
689
|
+
- (<tt>Object</tt>) <strong>coord</strong>(col, row)
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
</p><div class="docstring">
|
|
694
|
+
<div class="discussion">
|
|
695
|
+
<p>
|
|
696
|
+
shortcut to set the column, row position for this marker
|
|
697
|
+
</p>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
</div>
|
|
701
|
+
</div>
|
|
702
|
+
<div class="tags">
|
|
703
|
+
<h3>Parameters:</h3>
|
|
704
|
+
<ul class="param">
|
|
705
|
+
|
|
706
|
+
<li>
|
|
707
|
+
|
|
708
|
+
<span class='name'>col</span>
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
<span class='type'></span>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
—
|
|
716
|
+
<div class='inline'><p>
|
|
717
|
+
the column for the marker
|
|
718
|
+
</p>
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
</li>
|
|
722
|
+
|
|
723
|
+
<li>
|
|
724
|
+
|
|
725
|
+
<span class='name'>row</span>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
<span class='type'></span>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
—
|
|
733
|
+
<div class='inline'><p>
|
|
734
|
+
the row of the marker
|
|
735
|
+
</p>
|
|
736
|
+
</div>
|
|
737
|
+
|
|
738
|
+
</li>
|
|
739
|
+
|
|
740
|
+
</ul>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
</div><table class="source_code">
|
|
744
|
+
<tr>
|
|
745
|
+
<td>
|
|
746
|
+
<pre class="lines">
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
43
|
|
750
|
+
44
|
|
751
|
+
45
|
|
752
|
+
46</pre>
|
|
753
|
+
</td>
|
|
754
|
+
<td>
|
|
755
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 43</span>
|
|
756
|
+
|
|
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>
|
|
762
|
+
</td>
|
|
763
|
+
</tr>
|
|
764
|
+
</table>
|
|
765
|
+
</div>
|
|
766
|
+
|
|
767
|
+
<div class="method_details ">
|
|
768
|
+
<p class="signature " id="to_xml-instance_method">
|
|
769
|
+
|
|
770
|
+
- (<tt>String</tt>) <strong>to_xml</strong>(xml)
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
</p><div class="docstring">
|
|
775
|
+
<div class="discussion">
|
|
776
|
+
<p>
|
|
777
|
+
Serializes the marker
|
|
778
|
+
</p>
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
</div>
|
|
782
|
+
</div>
|
|
783
|
+
<div class="tags">
|
|
784
|
+
<h3>Parameters:</h3>
|
|
785
|
+
<ul class="param">
|
|
786
|
+
|
|
787
|
+
<li>
|
|
788
|
+
|
|
789
|
+
<span class='name'>xml</span>
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
—
|
|
797
|
+
<div class='inline'><p>
|
|
798
|
+
The document builder instance this objects xml will be added to.
|
|
799
|
+
</p>
|
|
800
|
+
</div>
|
|
801
|
+
|
|
802
|
+
</li>
|
|
803
|
+
|
|
804
|
+
</ul>
|
|
805
|
+
|
|
806
|
+
<h3>Returns:</h3>
|
|
807
|
+
<ul class="return">
|
|
808
|
+
|
|
809
|
+
<li>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
</li>
|
|
817
|
+
|
|
818
|
+
</ul>
|
|
819
|
+
|
|
820
|
+
</div><table class="source_code">
|
|
821
|
+
<tr>
|
|
822
|
+
<td>
|
|
823
|
+
<pre class="lines">
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
50
|
|
827
|
+
51
|
|
828
|
+
52
|
|
829
|
+
53
|
|
830
|
+
54</pre>
|
|
831
|
+
</td>
|
|
832
|
+
<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'>"xdr:#{k.to_s}"</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>
|
|
841
|
+
</td>
|
|
842
|
+
</tr>
|
|
843
|
+
</table>
|
|
844
|
+
</div>
|
|
845
|
+
|
|
846
|
+
</div>
|
|
847
|
+
|
|
848
|
+
</div>
|
|
849
|
+
|
|
850
|
+
<div id="footer">
|
|
851
|
+
Generated on Tue Nov 22 00:27:48 2011 by
|
|
852
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
853
|
+
0.7.3 (ruby-1.8.7).
|
|
854
|
+
</div>
|
|
855
|
+
|
|
856
|
+
</body>
|
|
857
|
+
</html>
|