axlsx 1.0.9 → 1.0.10a
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +3 -0
- data/Gemfile.lock +24 -0
- data/README.md +86 -1
- data/axlsx.gemspec +6 -10
- data/doc/Axlsx.html +557 -360
- data/doc/Axlsx/App.html +347 -244
- data/doc/Axlsx/Ar.html +200 -0
- data/doc/Axlsx/Ar/ClassMethods.html +192 -0
- data/doc/Axlsx/Ar/InstanceMethods.html +109 -0
- data/doc/Axlsx/Ar/SingletonMethods.html +304 -0
- data/doc/Axlsx/Axis.html +131 -98
- data/doc/Axlsx/Bar3DChart.html +138 -106
- data/doc/Axlsx/BarSeries.html +73 -54
- data/doc/Axlsx/Border.html +114 -87
- data/doc/Axlsx/BorderPr.html +107 -82
- data/doc/Axlsx/CatAxis.html +93 -68
- data/doc/Axlsx/CatAxisData.html +47 -38
- data/doc/Axlsx/Cell.html +642 -148
- data/doc/Axlsx/CellAlignment.html +152 -111
- data/doc/Axlsx/CellProtection.html +63 -45
- data/doc/Axlsx/CellStyle.html +101 -73
- data/doc/Axlsx/Chart.html +238 -179
- data/doc/Axlsx/Color.html +75 -53
- data/doc/Axlsx/ContentType.html +34 -26
- data/doc/Axlsx/Core.html +54 -42
- data/doc/Axlsx/DataTypeValidator.html +39 -30
- data/doc/Axlsx/Default.html +59 -43
- data/doc/Axlsx/Drawing.html +176 -128
- data/doc/Axlsx/Fill.html +46 -33
- data/doc/Axlsx/Font.html +197 -147
- data/doc/Axlsx/GradientFill.html +114 -82
- data/doc/Axlsx/GradientStop.html +47 -33
- data/doc/Axlsx/GraphicFrame.html +78 -60
- data/doc/Axlsx/Line3DChart.html +125 -97
- data/doc/Axlsx/LineSeries.html +60 -44
- data/doc/Axlsx/Marker.html +98 -71
- data/doc/Axlsx/NumFmt.html +99 -80
- data/doc/Axlsx/OneCellAnchor.html +126 -94
- data/doc/Axlsx/Override.html +59 -43
- data/doc/Axlsx/Package.html +269 -134
- data/doc/Axlsx/PatternFill.html +93 -72
- data/doc/Axlsx/Pic.html +202 -152
- data/doc/Axlsx/Pie3DChart.html +39 -30
- data/doc/Axlsx/PieSeries.html +72 -53
- data/doc/Axlsx/RegexValidator.html +19 -14
- data/doc/Axlsx/Relationship.html +60 -43
- data/doc/Axlsx/Relationships.html +34 -26
- data/doc/Axlsx/RestrictionValidator.html +31 -22
- data/doc/Axlsx/Row.html +241 -67
- data/doc/Axlsx/Scaling.html +80 -59
- data/doc/Axlsx/SerAxis.html +71 -51
- data/doc/Axlsx/Series.html +179 -51
- data/doc/Axlsx/SeriesTitle.html +29 -24
- data/doc/Axlsx/Styles.html +354 -285
- data/doc/Axlsx/TableStyle.html +74 -54
- data/doc/Axlsx/TableStyleElement.html +99 -79
- data/doc/Axlsx/TableStyles.html +65 -47
- data/doc/Axlsx/Title.html +66 -51
- data/doc/Axlsx/TwoCellAnchor.html +129 -96
- data/doc/Axlsx/ValAxis.html +52 -38
- data/doc/Axlsx/ValAxisData.html +32 -27
- data/doc/Axlsx/View3D.html +111 -80
- data/doc/Axlsx/Workbook.html +333 -272
- data/doc/Axlsx/Worksheet.html +1018 -266
- data/doc/Axlsx/Xf.html +188 -134
- data/doc/_index.html +44 -8
- data/doc/class_list.html +1 -1
- data/doc/file.LICENSE.html +28 -23
- data/doc/file.README.html +180 -91
- data/doc/index.html +180 -91
- data/doc/method_list.html +541 -421
- data/doc/top-level-namespace.html +2 -2
- data/examples/example.rb +70 -13
- data/lib/axlsx.rb +1 -0
- data/lib/axlsx/ar.rb +72 -0
- data/lib/axlsx/package.rb +8 -1
- data/lib/axlsx/util/simple_typed_list.rb +5 -0
- data/lib/axlsx/version.rb +1 -1
- data/lib/axlsx/workbook/workbook.rb +4 -2
- data/lib/axlsx/workbook/worksheet/row.rb +15 -0
- data/lib/axlsx/workbook/worksheet/worksheet.rb +44 -1
- data/test/workbook/worksheet/tc_row.rb +6 -0
- data/test/workbook/worksheet/tc_worksheet.rb +36 -0
- metadata +103 -59
@@ -0,0 +1,304 @@
|
|
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
|
+
Module: Axlsx::Ar::SingletonMethods
|
8
|
+
|
9
|
+
— AXLSX
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
relpath = '../..';
|
19
|
+
if (relpath != '') relpath += '/';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
25
|
+
|
26
|
+
|
27
|
+
</head>
|
28
|
+
<body>
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
31
|
+
</script>
|
32
|
+
|
33
|
+
<div id="header">
|
34
|
+
<div id="menu">
|
35
|
+
|
36
|
+
<a href="../../_index.html">Index (S)</a> »
|
37
|
+
<span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span>
|
38
|
+
»
|
39
|
+
<span class="title">SingletonMethods</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>Module: Axlsx::Ar::SingletonMethods
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
</h1>
|
64
|
+
|
65
|
+
<dl class="box">
|
66
|
+
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
<dt class="r1 last">Defined in:</dt>
|
75
|
+
<dd class="r1 last">lib/axlsx/ar.rb</dd>
|
76
|
+
|
77
|
+
</dl>
|
78
|
+
<div class="clear"></div>
|
79
|
+
|
80
|
+
<h2>Overview</h2><div class="docstring">
|
81
|
+
<div class="discussion">
|
82
|
+
<p>
|
83
|
+
Singleton methods for the mixin
|
84
|
+
</p>
|
85
|
+
|
86
|
+
|
87
|
+
</div>
|
88
|
+
</div>
|
89
|
+
<div class="tags">
|
90
|
+
|
91
|
+
|
92
|
+
</div>
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
<h2>
|
99
|
+
Instance Method Summary
|
100
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
101
|
+
</h2>
|
102
|
+
|
103
|
+
<ul class="summary">
|
104
|
+
|
105
|
+
<li class="public ">
|
106
|
+
<span class="summary_signature">
|
107
|
+
|
108
|
+
<a href="#to_xlsx-instance_method" title="#to_xlsx (instance method)">- (Object) <strong>to_xlsx</strong>(number = :all, options = {}) </a>
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
</span>
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
<span class="summary_desc"><div class='inline'><p>
|
122
|
+
Maps the AR class to an Axlsx package options are passed into AR find.
|
123
|
+
</p>
|
124
|
+
</div></span>
|
125
|
+
|
126
|
+
</li>
|
127
|
+
|
128
|
+
|
129
|
+
</ul>
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
<div id="instance_method_details" class="method_details_list">
|
135
|
+
<h2>Instance Method Details</h2>
|
136
|
+
|
137
|
+
|
138
|
+
<div class="method_details first">
|
139
|
+
<p class="signature first" id="to_xlsx-instance_method">
|
140
|
+
|
141
|
+
- (<tt>Object</tt>) <strong>to_xlsx</strong>(number = :all, options = {})
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
</p><div class="docstring">
|
146
|
+
<div class="discussion">
|
147
|
+
<p>
|
148
|
+
Maps the AR class to an Axlsx package options are passed into AR find
|
149
|
+
</p>
|
150
|
+
|
151
|
+
|
152
|
+
</div>
|
153
|
+
</div>
|
154
|
+
<div class="tags">
|
155
|
+
<h3>Parameters:</h3>
|
156
|
+
<ul class="param">
|
157
|
+
|
158
|
+
<li>
|
159
|
+
|
160
|
+
<span class='name'>options</span>
|
161
|
+
|
162
|
+
|
163
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
164
|
+
|
165
|
+
|
166
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
167
|
+
|
168
|
+
|
169
|
+
—
|
170
|
+
<div class='inline'><p>
|
171
|
+
a customizable set of options
|
172
|
+
</p>
|
173
|
+
</div>
|
174
|
+
|
175
|
+
</li>
|
176
|
+
|
177
|
+
</ul>
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
185
|
+
<ul class="option">
|
186
|
+
|
187
|
+
<li>
|
188
|
+
<span class="name">header_style</span>
|
189
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
190
|
+
<span class="default">
|
191
|
+
|
192
|
+
</span>
|
193
|
+
— <div class='inline'><p>
|
194
|
+
to apply to the first row of field names
|
195
|
+
</p>
|
196
|
+
</div>
|
197
|
+
</li>
|
198
|
+
|
199
|
+
<li>
|
200
|
+
<span class="name">an</span>
|
201
|
+
<span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span>
|
202
|
+
<span class="default">
|
203
|
+
|
204
|
+
</span>
|
205
|
+
— <div class='inline'><p>
|
206
|
+
array of Axlsx types for each cell in data rows or a single type that will
|
207
|
+
be applied to all types.
|
208
|
+
</p>
|
209
|
+
</div>
|
210
|
+
</li>
|
211
|
+
|
212
|
+
<li>
|
213
|
+
<span class="name">style</span>
|
214
|
+
<span class="type">(<tt>Integer</tt>, <tt>Array</tt>)</span>
|
215
|
+
<span class="default">
|
216
|
+
|
217
|
+
</span>
|
218
|
+
— <div class='inline'><p>
|
219
|
+
The style to pass to Worksheet#add_row
|
220
|
+
</p>
|
221
|
+
</div>
|
222
|
+
</li>
|
223
|
+
|
224
|
+
</ul>
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
<h3>See Also:</h3>
|
229
|
+
<ul class="see">
|
230
|
+
|
231
|
+
<li><span class='object_link'><a href="../Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li>
|
232
|
+
|
233
|
+
</ul>
|
234
|
+
|
235
|
+
</div><table class="source_code">
|
236
|
+
<tr>
|
237
|
+
<td>
|
238
|
+
<pre class="lines">
|
239
|
+
|
240
|
+
|
241
|
+
31
|
242
|
+
32
|
243
|
+
33
|
244
|
+
34
|
245
|
+
35
|
246
|
+
36
|
247
|
+
37
|
248
|
+
38
|
249
|
+
39
|
250
|
+
40
|
251
|
+
41
|
252
|
+
42
|
253
|
+
43
|
254
|
+
44
|
255
|
+
45
|
256
|
+
46
|
257
|
+
47
|
258
|
+
48
|
259
|
+
49
|
260
|
+
50
|
261
|
+
51</pre>
|
262
|
+
</td>
|
263
|
+
<td>
|
264
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 31</span>
|
265
|
+
|
266
|
+
<span class='def def kw'>def</span> <span class='to_xlsx identifier id'>to_xlsx</span><span class='lparen token'>(</span><span class='number identifier id'>number</span> <span class='assign token'>=</span> <span class='symbol val'>:all</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>
|
267
|
+
<span class='row_style identifier id'>row_style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:style</span><span class='rparen token'>)</span>
|
268
|
+
<span class='header_style identifier id'>header_style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:header_style</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='row_style identifier id'>row_style</span>
|
269
|
+
<span class='types identifier id'>types</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:types</span><span class='rparen token'>)</span>
|
270
|
+
|
271
|
+
<span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='mult op'>*</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='number identifier id'>number</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rbrack token'>]</span>
|
272
|
+
<span class='data identifier id'>data</span><span class='dot token'>.</span><span class='compact! fid id'>compact!</span>
|
273
|
+
<span class='data identifier id'>data</span><span class='dot token'>.</span><span class='flatten! fid id'>flatten!</span>
|
274
|
+
<span class='columns identifier id'>columns</span> <span class='assign token'>=</span> <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='attributes identifier id'>attributes</span><span class='dot token'>.</span><span class='keys identifier id'>keys</span>
|
275
|
+
<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
276
|
+
<span class='row_style identifier id'>row_style</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='row_style identifier id'>row_style</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='row_style identifier id'>row_style</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
277
|
+
<span class='header_style identifier id'>header_style</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='header_style identifier id'>header_style</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='header_style identifier id'>header_style</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
278
|
+
|
279
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='table_name identifier id'>table_name</span><span class='dot token'>.</span><span class='humanize identifier id'>humanize</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
|
280
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='columns identifier id'>columns</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='header_style identifier id'>header_style</span>
|
281
|
+
<span class='data identifier id'>data</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='r identifier id'>r</span><span class='bitor op'>|</span>
|
282
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='attributes identifier id'>attributes</span><span class='dot token'>.</span><span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='row_style identifier id'>row_style</span><span class='comma token'>,</span> <span class='symbol val'>:types=</span><span class='gt op'>></span><span class='types identifier id'>types</span>
|
283
|
+
<span class='end end kw'>end</span>
|
284
|
+
<span class='end end kw'>end</span>
|
285
|
+
<span class='p identifier id'>p</span>
|
286
|
+
<span class='end end kw'>end</span>
|
287
|
+
</pre>
|
288
|
+
</td>
|
289
|
+
</tr>
|
290
|
+
</table>
|
291
|
+
</div>
|
292
|
+
|
293
|
+
</div>
|
294
|
+
|
295
|
+
</div>
|
296
|
+
|
297
|
+
<div id="footer">
|
298
|
+
Generated on Sun Nov 27 21:54:25 2011 by
|
299
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
300
|
+
0.7.3 (ruby-1.8.7).
|
301
|
+
</div>
|
302
|
+
|
303
|
+
</body>
|
304
|
+
</html>
|
data/doc/Axlsx/Axis.html
CHANGED
@@ -94,8 +94,9 @@
|
|
94
94
|
|
95
95
|
<h2>Overview</h2><div class="docstring">
|
96
96
|
<div class="discussion">
|
97
|
-
|
98
|
-
|
97
|
+
<p>
|
98
|
+
the access class defines common properties and values for a chart axis.
|
99
|
+
</p>
|
99
100
|
|
100
101
|
|
101
102
|
</div>
|
@@ -131,8 +132,9 @@
|
|
131
132
|
|
132
133
|
|
133
134
|
|
134
|
-
<span class="summary_desc"><div class='inline'>
|
135
|
-
|
135
|
+
<span class="summary_desc"><div class='inline'><p>
|
136
|
+
the id of the axis.
|
137
|
+
</p>
|
136
138
|
</div></span>
|
137
139
|
|
138
140
|
</li>
|
@@ -157,8 +159,9 @@
|
|
157
159
|
|
158
160
|
|
159
161
|
|
160
|
-
<span class="summary_desc"><div class='inline'>
|
161
|
-
|
162
|
+
<span class="summary_desc"><div class='inline'><p>
|
163
|
+
The position of the axis must be one of [:l, :r, :t, :b].
|
164
|
+
</p>
|
162
165
|
</div></span>
|
163
166
|
|
164
167
|
</li>
|
@@ -183,8 +186,9 @@
|
|
183
186
|
|
184
187
|
|
185
188
|
|
186
|
-
<span class="summary_desc"><div class='inline'>
|
187
|
-
|
189
|
+
<span class="summary_desc"><div class='inline'><p>
|
190
|
+
The perpendicular axis.
|
191
|
+
</p>
|
188
192
|
</div></span>
|
189
193
|
|
190
194
|
</li>
|
@@ -209,9 +213,10 @@
|
|
209
213
|
|
210
214
|
|
211
215
|
|
212
|
-
<span class="summary_desc"><div class='inline'>
|
213
|
-
|
214
|
-
:min, :max]
|
216
|
+
<span class="summary_desc"><div class='inline'><p>
|
217
|
+
specifies how the perpendicular axis is crossed must be one of [:autoZero,
|
218
|
+
:min, :max].
|
219
|
+
</p>
|
215
220
|
</div></span>
|
216
221
|
|
217
222
|
</li>
|
@@ -236,8 +241,9 @@
|
|
236
241
|
|
237
242
|
|
238
243
|
|
239
|
-
<span class="summary_desc"><div class='inline'>
|
240
|
-
|
244
|
+
<span class="summary_desc"><div class='inline'><p>
|
245
|
+
The number format format code for this axis default :General.
|
246
|
+
</p>
|
241
247
|
</div></span>
|
242
248
|
|
243
249
|
</li>
|
@@ -262,8 +268,9 @@
|
|
262
268
|
|
263
269
|
|
264
270
|
|
265
|
-
<span class="summary_desc"><div class='inline'>
|
266
|
-
|
271
|
+
<span class="summary_desc"><div class='inline'><p>
|
272
|
+
The scaling of the axis.
|
273
|
+
</p>
|
267
274
|
</div></span>
|
268
275
|
|
269
276
|
</li>
|
@@ -288,8 +295,9 @@
|
|
288
295
|
|
289
296
|
|
290
297
|
|
291
|
-
<span class="summary_desc"><div class='inline'>
|
292
|
-
|
298
|
+
<span class="summary_desc"><div class='inline'><p>
|
299
|
+
the position of the tick labels must be one of [:nextTo, :high, :low].
|
300
|
+
</p>
|
293
301
|
</div></span>
|
294
302
|
|
295
303
|
</li>
|
@@ -326,8 +334,9 @@
|
|
326
334
|
|
327
335
|
|
328
336
|
|
329
|
-
<span class="summary_desc"><div class='inline'>
|
330
|
-
|
337
|
+
<span class="summary_desc"><div class='inline'><p>
|
338
|
+
Creates an Axis object.
|
339
|
+
</p>
|
331
340
|
</div></span>
|
332
341
|
|
333
342
|
</li>
|
@@ -349,8 +358,9 @@
|
|
349
358
|
|
350
359
|
|
351
360
|
|
352
|
-
<span class="summary_desc"><div class='inline'>
|
353
|
-
|
361
|
+
<span class="summary_desc"><div class='inline'><p>
|
362
|
+
Serializes the common axis.
|
363
|
+
</p>
|
354
364
|
</div></span>
|
355
365
|
|
356
366
|
</li>
|
@@ -371,8 +381,9 @@
|
|
371
381
|
|
372
382
|
</p><div class="docstring">
|
373
383
|
<div class="discussion">
|
374
|
-
|
375
|
-
|
384
|
+
<p>
|
385
|
+
Creates an Axis object
|
386
|
+
</p>
|
376
387
|
|
377
388
|
|
378
389
|
</div>
|
@@ -391,8 +402,9 @@
|
|
391
402
|
|
392
403
|
|
393
404
|
—
|
394
|
-
<div class='inline'>
|
395
|
-
|
405
|
+
<div class='inline'><p>
|
406
|
+
the id of this axis
|
407
|
+
</p>
|
396
408
|
</div>
|
397
409
|
|
398
410
|
</li>
|
@@ -407,8 +419,9 @@
|
|
407
419
|
|
408
420
|
|
409
421
|
—
|
410
|
-
<div class='inline'>
|
411
|
-
|
422
|
+
<div class='inline'><p>
|
423
|
+
the id of the perpendicular axis
|
424
|
+
</p>
|
412
425
|
</div>
|
413
426
|
|
414
427
|
</li>
|
@@ -425,8 +438,9 @@
|
|
425
438
|
|
426
439
|
|
427
440
|
—
|
428
|
-
<div class='inline'>
|
429
|
-
|
441
|
+
<div class='inline'><p>
|
442
|
+
a customizable set of options
|
443
|
+
</p>
|
430
444
|
</div>
|
431
445
|
|
432
446
|
</li>
|
@@ -484,8 +498,9 @@
|
|
484
498
|
|
485
499
|
|
486
500
|
—
|
487
|
-
<div class='inline'>
|
488
|
-
|
501
|
+
<div class='inline'><p>
|
502
|
+
If axId or crossAx are not unsigned integers
|
503
|
+
</p>
|
489
504
|
</div>
|
490
505
|
|
491
506
|
</li>
|
@@ -517,21 +532,22 @@
|
|
517
532
|
<td>
|
518
533
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 45</span>
|
519
534
|
|
520
|
-
<span class='kw'>def</span> <span class='id
|
521
|
-
<span class='
|
522
|
-
<span class='
|
523
|
-
<span class='ivar'>@axId</span> <span class='
|
524
|
-
<span class='ivar'>@crossAx</span> <span class='
|
525
|
-
<span class='ivar'>@format_code</span> <span class='
|
526
|
-
<span class='ivar'>@scaling</span> <span class='
|
527
|
-
<span class='kw'>self</span><span class='
|
528
|
-
<span class='kw'>self</span><span class='
|
529
|
-
<span class='kw'>self</span><span class='
|
530
|
-
<span class='kw'>self</span><span class='
|
531
|
-
<span class='id
|
532
|
-
<span class='kw'>self</span><span class='
|
533
|
-
<span class='kw'>end</span>
|
534
|
-
<span class='kw'>end</span
|
535
|
+
<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</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>
|
536
|
+
<span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='rparen token'>)</span>
|
537
|
+
<span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='crossAx identifier id'>crossAx</span><span class='rparen token'>)</span>
|
538
|
+
<span class='@axId ivar id'>@axId</span> <span class='assign token'>=</span> <span class='axId identifier id'>axId</span>
|
539
|
+
<span class='@crossAx ivar id'>@crossAx</span> <span class='assign token'>=</span> <span class='crossAx identifier id'>crossAx</span>
|
540
|
+
<span class='@format_code ivar id'>@format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span>
|
541
|
+
<span class='@scaling ivar id'>@scaling</span> <span class='assign token'>=</span> <span class='Scaling constant id'>Scaling</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:orientation=</span><span class='gt op'>></span><span class='symbol val'>:minMax</span><span class='rparen token'>)</span>
|
542
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='axPos identifier id'>axPos</span> <span class='assign token'>=</span> <span class='symbol val'>:l</span>
|
543
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='tickLblPos identifier id'>tickLblPos</span> <span class='assign token'>=</span> <span class='symbol val'>:nextTo</span>
|
544
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='format_code identifier id'>format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span>
|
545
|
+
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='crosses identifier id'>crosses</span> <span class='assign token'>=</span> <span class='symbol val'>:autoZero</span>
|
546
|
+
<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>
|
547
|
+
<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='dstring node'>"#{o[0]}="</span>
|
548
|
+
<span class='end end kw'>end</span>
|
549
|
+
<span class='end end kw'>end</span>
|
550
|
+
</pre>
|
535
551
|
</td>
|
536
552
|
</tr>
|
537
553
|
</table>
|
@@ -554,8 +570,9 @@
|
|
554
570
|
|
555
571
|
</p><div class="docstring">
|
556
572
|
<div class="discussion">
|
557
|
-
|
558
|
-
|
573
|
+
<p>
|
574
|
+
the id of the axis.
|
575
|
+
</p>
|
559
576
|
|
560
577
|
|
561
578
|
</div>
|
@@ -589,9 +606,10 @@
|
|
589
606
|
<td>
|
590
607
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 7</span>
|
591
608
|
|
592
|
-
<span class='kw'>def</span> <span class='id
|
593
|
-
<span class='ivar'>@axId</span>
|
594
|
-
<span class='kw'>end</span
|
609
|
+
<span class='def def kw'>def</span> <span class='axId identifier id'>axId</span>
|
610
|
+
<span class='@axId ivar id'>@axId</span>
|
611
|
+
<span class='end end kw'>end</span>
|
612
|
+
</pre>
|
595
613
|
</td>
|
596
614
|
</tr>
|
597
615
|
</table>
|
@@ -609,8 +627,9 @@
|
|
609
627
|
|
610
628
|
</p><div class="docstring">
|
611
629
|
<div class="discussion">
|
612
|
-
|
613
|
-
|
630
|
+
<p>
|
631
|
+
The position of the axis must be one of [:l, :r, :t, :b]
|
632
|
+
</p>
|
614
633
|
|
615
634
|
|
616
635
|
</div>
|
@@ -644,9 +663,10 @@
|
|
644
663
|
<td>
|
645
664
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 21</span>
|
646
665
|
|
647
|
-
<span class='kw'>def</span> <span class='id
|
648
|
-
<span class='ivar'>@axPos</span>
|
649
|
-
<span class='kw'>end</span
|
666
|
+
<span class='def def kw'>def</span> <span class='axPos identifier id'>axPos</span>
|
667
|
+
<span class='@axPos ivar id'>@axPos</span>
|
668
|
+
<span class='end end kw'>end</span>
|
669
|
+
</pre>
|
650
670
|
</td>
|
651
671
|
</tr>
|
652
672
|
</table>
|
@@ -664,8 +684,9 @@
|
|
664
684
|
|
665
685
|
</p><div class="docstring">
|
666
686
|
<div class="discussion">
|
667
|
-
|
668
|
-
|
687
|
+
<p>
|
688
|
+
The perpendicular axis
|
689
|
+
</p>
|
669
690
|
|
670
691
|
|
671
692
|
</div>
|
@@ -699,9 +720,10 @@
|
|
699
720
|
<td>
|
700
721
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 11</span>
|
701
722
|
|
702
|
-
<span class='kw'>def</span> <span class='id
|
703
|
-
<span class='ivar'>@crossAx</span>
|
704
|
-
<span class='kw'>end</span
|
723
|
+
<span class='def def kw'>def</span> <span class='crossAx identifier id'>crossAx</span>
|
724
|
+
<span class='@crossAx ivar id'>@crossAx</span>
|
725
|
+
<span class='end end kw'>end</span>
|
726
|
+
</pre>
|
705
727
|
</td>
|
706
728
|
</tr>
|
707
729
|
</table>
|
@@ -719,9 +741,10 @@
|
|
719
741
|
|
720
742
|
</p><div class="docstring">
|
721
743
|
<div class="discussion">
|
722
|
-
|
723
|
-
|
724
|
-
:min, :max]
|
744
|
+
<p>
|
745
|
+
specifies how the perpendicular axis is crossed must be one of [:autoZero,
|
746
|
+
:min, :max]
|
747
|
+
</p>
|
725
748
|
|
726
749
|
|
727
750
|
</div>
|
@@ -755,9 +778,10 @@
|
|
755
778
|
<td>
|
756
779
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 36</span>
|
757
780
|
|
758
|
-
<span class='kw'>def</span> <span class='id
|
759
|
-
<span class='ivar'>@crosses</span>
|
760
|
-
<span class='kw'>end</span
|
781
|
+
<span class='def def kw'>def</span> <span class='crosses identifier id'>crosses</span>
|
782
|
+
<span class='@crosses ivar id'>@crosses</span>
|
783
|
+
<span class='end end kw'>end</span>
|
784
|
+
</pre>
|
761
785
|
</td>
|
762
786
|
</tr>
|
763
787
|
</table>
|
@@ -775,8 +799,9 @@
|
|
775
799
|
|
776
800
|
</p><div class="docstring">
|
777
801
|
<div class="discussion">
|
778
|
-
|
779
|
-
|
802
|
+
<p>
|
803
|
+
The number format format code for this axis default :General
|
804
|
+
</p>
|
780
805
|
|
781
806
|
|
782
807
|
</div>
|
@@ -810,9 +835,10 @@
|
|
810
835
|
<td>
|
811
836
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 31</span>
|
812
837
|
|
813
|
-
<span class='kw'>def</span> <span class='id
|
814
|
-
<span class='ivar'>@format_code</span>
|
815
|
-
<span class='kw'>end</span
|
838
|
+
<span class='def def kw'>def</span> <span class='format_code identifier id'>format_code</span>
|
839
|
+
<span class='@format_code ivar id'>@format_code</span>
|
840
|
+
<span class='end end kw'>end</span>
|
841
|
+
</pre>
|
816
842
|
</td>
|
817
843
|
</tr>
|
818
844
|
</table>
|
@@ -830,8 +856,9 @@
|
|
830
856
|
|
831
857
|
</p><div class="docstring">
|
832
858
|
<div class="discussion">
|
833
|
-
|
834
|
-
|
859
|
+
<p>
|
860
|
+
The scaling of the axis
|
861
|
+
</p>
|
835
862
|
|
836
863
|
|
837
864
|
</div>
|
@@ -872,9 +899,10 @@
|
|
872
899
|
<td>
|
873
900
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 16</span>
|
874
901
|
|
875
|
-
<span class='kw'>def</span> <span class='id
|
876
|
-
<span class='ivar'>@scaling</span>
|
877
|
-
<span class='kw'>end</span
|
902
|
+
<span class='def def kw'>def</span> <span class='scaling identifier id'>scaling</span>
|
903
|
+
<span class='@scaling ivar id'>@scaling</span>
|
904
|
+
<span class='end end kw'>end</span>
|
905
|
+
</pre>
|
878
906
|
</td>
|
879
907
|
</tr>
|
880
908
|
</table>
|
@@ -892,8 +920,9 @@
|
|
892
920
|
|
893
921
|
</p><div class="docstring">
|
894
922
|
<div class="discussion">
|
895
|
-
|
896
|
-
|
923
|
+
<p>
|
924
|
+
the position of the tick labels must be one of [:nextTo, :high, :low]
|
925
|
+
</p>
|
897
926
|
|
898
927
|
|
899
928
|
</div>
|
@@ -927,9 +956,10 @@
|
|
927
956
|
<td>
|
928
957
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 26</span>
|
929
958
|
|
930
|
-
<span class='kw'>def</span> <span class='id
|
931
|
-
<span class='ivar'>@tickLblPos</span>
|
932
|
-
<span class='kw'>end</span
|
959
|
+
<span class='def def kw'>def</span> <span class='tickLblPos identifier id'>tickLblPos</span>
|
960
|
+
<span class='@tickLblPos ivar id'>@tickLblPos</span>
|
961
|
+
<span class='end end kw'>end</span>
|
962
|
+
</pre>
|
933
963
|
</td>
|
934
964
|
</tr>
|
935
965
|
</table>
|
@@ -951,8 +981,9 @@
|
|
951
981
|
|
952
982
|
</p><div class="docstring">
|
953
983
|
<div class="discussion">
|
954
|
-
|
955
|
-
|
984
|
+
<p>
|
985
|
+
Serializes the common axis
|
986
|
+
</p>
|
956
987
|
|
957
988
|
|
958
989
|
</div>
|
@@ -971,8 +1002,9 @@
|
|
971
1002
|
|
972
1003
|
|
973
1004
|
—
|
974
|
-
<div class='inline'>
|
975
|
-
|
1005
|
+
<div class='inline'><p>
|
1006
|
+
The document builder instance this objects xml will be added to.
|
1007
|
+
</p>
|
976
1008
|
</div>
|
977
1009
|
|
978
1010
|
</li>
|
@@ -1013,16 +1045,17 @@
|
|
1013
1045
|
<td>
|
1014
1046
|
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 79</span>
|
1015
1047
|
|
1016
|
-
<span class='kw'>def</span> <span class='id
|
1017
|
-
<span class='id
|
1018
|
-
<span class='ivar'>@scaling</span><span class='
|
1019
|
-
<span class='id
|
1020
|
-
<span class='id
|
1021
|
-
<span class='id
|
1022
|
-
<span class='id
|
1023
|
-
<span class='id
|
1024
|
-
<span class='id
|
1025
|
-
<span class='kw'>end</span
|
1048
|
+
<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>
|
1049
|
+
<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'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axId ivar id'>@axId</span><span class='rparen token'>)</span>
|
1050
|
+
<span class='@scaling ivar id'>@scaling</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>
|
1051
|
+
<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'>'c:axPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axPos ivar id'>@axPos</span><span class='rparen token'>)</span>
|
1052
|
+
<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'>'c:majorGridlines'</span><span class='rparen token'>)</span>
|
1053
|
+
<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'>'c:numFmt'</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@format_code ivar id'>@format_code</span><span class='comma token'>,</span> <span class='symbol val'>:sourceLinked=</span><span class='gt op'>></span><span class='string val'>"1"</span><span class='rparen token'>)</span>
|
1054
|
+
<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'>'c:tickLblPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickLblPos ivar id'>@tickLblPos</span><span class='rparen token'>)</span>
|
1055
|
+
<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'>'c:crossAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossAx ivar id'>@crossAx</span><span class='rparen token'>)</span>
|
1056
|
+
<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'>'c:crosses'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crosses ivar id'>@crosses</span><span class='rparen token'>)</span>
|
1057
|
+
<span class='end end kw'>end</span>
|
1058
|
+
</pre>
|
1026
1059
|
</td>
|
1027
1060
|
</tr>
|
1028
1061
|
</table>
|
@@ -1033,9 +1066,9 @@
|
|
1033
1066
|
</div>
|
1034
1067
|
|
1035
1068
|
<div id="footer">
|
1036
|
-
Generated on
|
1069
|
+
Generated on Sun Nov 27 21:54:15 2011 by
|
1037
1070
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1038
|
-
0.7.3 (ruby-1.
|
1071
|
+
0.7.3 (ruby-1.8.7).
|
1039
1072
|
</div>
|
1040
1073
|
|
1041
1074
|
</body>
|