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,324 @@
|
|
|
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::DataTypeValidator
|
|
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 (D)</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">DataTypeValidator</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::DataTypeValidator
|
|
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::DataTypeValidator</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/util/validators.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
<p>
|
|
98
|
+
Validate that the class of the value provided is either an instance or the
|
|
99
|
+
class of the allowed types and that any specified additional validation
|
|
100
|
+
returns true.
|
|
101
|
+
</p>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
</div>
|
|
106
|
+
<div class="tags">
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
<h2>
|
|
116
|
+
Class Method Summary
|
|
117
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
118
|
+
</h2>
|
|
119
|
+
|
|
120
|
+
<ul class="summary">
|
|
121
|
+
|
|
122
|
+
<li class="public ">
|
|
123
|
+
<span class="summary_signature">
|
|
124
|
+
|
|
125
|
+
<a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, types, v, other = lambda{|v| true }) </a>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</span>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
139
|
+
Perform validation.
|
|
140
|
+
</p>
|
|
141
|
+
</div></span>
|
|
142
|
+
|
|
143
|
+
</li>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</ul>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<div id="class_method_details" class="method_details_list">
|
|
152
|
+
<h2>Class Method Details</h2>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<div class="method_details first">
|
|
156
|
+
<p class="signature first" id="validate-class_method">
|
|
157
|
+
|
|
158
|
+
+ (<tt>Boolean</tt>) <strong>validate</strong>(name, types, v, other = lambda{|v| true })
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</p><div class="docstring">
|
|
163
|
+
<div class="discussion">
|
|
164
|
+
<p>
|
|
165
|
+
Perform validation
|
|
166
|
+
</p>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</div>
|
|
170
|
+
</div>
|
|
171
|
+
<div class="tags">
|
|
172
|
+
<h3>Parameters:</h3>
|
|
173
|
+
<ul class="param">
|
|
174
|
+
|
|
175
|
+
<li>
|
|
176
|
+
|
|
177
|
+
<span class='name'>name</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
—
|
|
185
|
+
<div class='inline'><p>
|
|
186
|
+
The name of what is being validated. This is included in the error message
|
|
187
|
+
</p>
|
|
188
|
+
</div>
|
|
189
|
+
|
|
190
|
+
</li>
|
|
191
|
+
|
|
192
|
+
<li>
|
|
193
|
+
|
|
194
|
+
<span class='name'>types</span>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<span class='type'>(<tt>Array</tt>, <tt>Class</tt>)</span>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
—
|
|
202
|
+
<div class='inline'><p>
|
|
203
|
+
A single class or array of classes that the value is validated against.
|
|
204
|
+
</p>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
</li>
|
|
208
|
+
|
|
209
|
+
<li>
|
|
210
|
+
|
|
211
|
+
<span class='name'>other</span>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<span class='type'>(<tt>Block</tt>)</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<em class="default">(defaults to: <tt>lambda{|v| true }</tt>)</em>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
—
|
|
221
|
+
<div class='inline'><p>
|
|
222
|
+
Any block that must evaluate to true for the value to be valid
|
|
223
|
+
</p>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
</ul>
|
|
229
|
+
|
|
230
|
+
<h3>Returns:</h3>
|
|
231
|
+
<ul class="return">
|
|
232
|
+
|
|
233
|
+
<li>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
—
|
|
241
|
+
<div class='inline'><p>
|
|
242
|
+
true if validation succeeds.
|
|
243
|
+
</p>
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
</ul>
|
|
249
|
+
<h3>Raises:</h3>
|
|
250
|
+
<ul class="raise">
|
|
251
|
+
|
|
252
|
+
<li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<span class='type'>(<tt>ArugumentError</tt>)</span>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
—
|
|
260
|
+
<div class='inline'><p>
|
|
261
|
+
Raised if the class of the value provided is not in the specified array of
|
|
262
|
+
types or the block passed returns false
|
|
263
|
+
</p>
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
</li>
|
|
267
|
+
|
|
268
|
+
</ul>
|
|
269
|
+
|
|
270
|
+
<h3>See Also:</h3>
|
|
271
|
+
<ul class="see">
|
|
272
|
+
|
|
273
|
+
<li><span class='object_link'><a href="../Axlsx.html#validate_boolean-class_method" title="Axlsx.validate_boolean (method)">Axlsx.validate_boolean</a></span></li>
|
|
274
|
+
|
|
275
|
+
</ul>
|
|
276
|
+
|
|
277
|
+
</div><table class="source_code">
|
|
278
|
+
<tr>
|
|
279
|
+
<td>
|
|
280
|
+
<pre class="lines">
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
34
|
|
284
|
+
35
|
|
285
|
+
36
|
|
286
|
+
37
|
|
287
|
+
38
|
|
288
|
+
39
|
|
289
|
+
40
|
|
290
|
+
41
|
|
291
|
+
42
|
|
292
|
+
43</pre>
|
|
293
|
+
</td>
|
|
294
|
+
<td>
|
|
295
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 34</span>
|
|
296
|
+
|
|
297
|
+
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='other identifier id'>other</span><span class='assign token'>=</span> <span class='lambda identifier id'>lambda</span><span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
298
|
+
<span class='types identifier id'>types</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='types identifier id'>types</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Array constant id'>Array</span>
|
|
299
|
+
<span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='false false kw'>false</span>
|
|
300
|
+
<span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='Class constant id'>Class</span>
|
|
301
|
+
<span class='types identifier id'>types</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='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='ancestors identifier id'>ancestors</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
|
|
302
|
+
<span class='else else kw'>else</span>
|
|
303
|
+
<span class='types identifier id'>types</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='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
|
|
304
|
+
<span class='end end kw'>end</span>
|
|
305
|
+
<span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_TYPE constant id'>ERR_TYPE</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='other identifier id'>other</span><span class='dot token'>.</span><span class='call identifier id'>call</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='valid_type identifier id'>valid_type</span><span class='rparen token'>)</span>
|
|
306
|
+
<span class='end end kw'>end</span>
|
|
307
|
+
</pre>
|
|
308
|
+
</td>
|
|
309
|
+
</tr>
|
|
310
|
+
</table>
|
|
311
|
+
</div>
|
|
312
|
+
|
|
313
|
+
</div>
|
|
314
|
+
|
|
315
|
+
</div>
|
|
316
|
+
|
|
317
|
+
<div id="footer">
|
|
318
|
+
Generated on Tue Nov 22 00:27:37 2011 by
|
|
319
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
320
|
+
0.7.3 (ruby-1.8.7).
|
|
321
|
+
</div>
|
|
322
|
+
|
|
323
|
+
</body>
|
|
324
|
+
</html>
|
|
@@ -0,0 +1,575 @@
|
|
|
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::Default
|
|
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 (D)</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">Default</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::Default
|
|
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::Default</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/content_type/default.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
<p>
|
|
98
|
+
An default content part. These parts are automatically created by for you
|
|
99
|
+
based on the content of your package.
|
|
100
|
+
</p>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
</div>
|
|
105
|
+
<div class="tags">
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
|
|
110
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
111
|
+
<ul class="summary">
|
|
112
|
+
|
|
113
|
+
<li class="public ">
|
|
114
|
+
<span class="summary_signature">
|
|
115
|
+
|
|
116
|
+
<a href="#ContentType-instance_method" title="#ContentType (instance method)">- (String) <strong>ContentType</strong> </a>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</span>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
133
|
+
ContentType The type of content.
|
|
134
|
+
</p>
|
|
135
|
+
</div></span>
|
|
136
|
+
|
|
137
|
+
</li>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<li class="public ">
|
|
141
|
+
<span class="summary_signature">
|
|
142
|
+
|
|
143
|
+
<a href="#Extension-instance_method" title="#Extension (instance method)">- (String) <strong>Extension</strong> </a>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</span>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
160
|
+
The extension of the content type.
|
|
161
|
+
</p>
|
|
162
|
+
</div></span>
|
|
163
|
+
|
|
164
|
+
</li>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
</ul>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<h2>
|
|
174
|
+
Instance Method Summary
|
|
175
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
176
|
+
</h2>
|
|
177
|
+
|
|
178
|
+
<ul class="summary">
|
|
179
|
+
|
|
180
|
+
<li class="public ">
|
|
181
|
+
<span class="summary_signature">
|
|
182
|
+
|
|
183
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Default) <strong>initialize</strong>(options = {}) </a>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</span>
|
|
188
|
+
|
|
189
|
+
<span class="note title constructor">constructor</span>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
199
|
+
Creates a new Default object.
|
|
200
|
+
</p>
|
|
201
|
+
</div></span>
|
|
202
|
+
|
|
203
|
+
</li>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<li class="public ">
|
|
207
|
+
<span class="summary_signature">
|
|
208
|
+
|
|
209
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
</span>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
223
|
+
Serializes the object to xml.
|
|
224
|
+
</p>
|
|
225
|
+
</div></span>
|
|
226
|
+
|
|
227
|
+
</li>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
</ul>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<div id="constructor_details" class="method_details_list">
|
|
234
|
+
<h2>Constructor Details</h2>
|
|
235
|
+
|
|
236
|
+
<div class="method_details first">
|
|
237
|
+
<p class="signature first" id="initialize-instance_method">
|
|
238
|
+
|
|
239
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Default (class)">Default</a></span></tt>) <strong>initialize</strong>(options = {})
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</p><div class="docstring">
|
|
244
|
+
<div class="discussion">
|
|
245
|
+
<p>
|
|
246
|
+
Creates a new Default object
|
|
247
|
+
</p>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</div>
|
|
251
|
+
</div>
|
|
252
|
+
<div class="tags">
|
|
253
|
+
<h3>Parameters:</h3>
|
|
254
|
+
<ul class="param">
|
|
255
|
+
|
|
256
|
+
<li>
|
|
257
|
+
|
|
258
|
+
<span class='name'>options</span>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
—
|
|
268
|
+
<div class='inline'><p>
|
|
269
|
+
a customizable set of options
|
|
270
|
+
</p>
|
|
271
|
+
</div>
|
|
272
|
+
|
|
273
|
+
</li>
|
|
274
|
+
|
|
275
|
+
</ul>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
281
|
+
<ul class="option">
|
|
282
|
+
|
|
283
|
+
<li>
|
|
284
|
+
<span class="name">Extension</span>
|
|
285
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
286
|
+
<span class="default">
|
|
287
|
+
|
|
288
|
+
</span>
|
|
289
|
+
|
|
290
|
+
</li>
|
|
291
|
+
|
|
292
|
+
<li>
|
|
293
|
+
<span class="name">ContentType</span>
|
|
294
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
295
|
+
<span class="default">
|
|
296
|
+
|
|
297
|
+
</span>
|
|
298
|
+
|
|
299
|
+
</li>
|
|
300
|
+
|
|
301
|
+
</ul>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<h3>Raises:</h3>
|
|
305
|
+
<ul class="raise">
|
|
306
|
+
|
|
307
|
+
<li>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
—
|
|
315
|
+
<div class='inline'><p>
|
|
316
|
+
An argument error is raised if both Extension and ContentType are not
|
|
317
|
+
specified.
|
|
318
|
+
</p>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
</li>
|
|
322
|
+
|
|
323
|
+
</ul>
|
|
324
|
+
|
|
325
|
+
</div><table class="source_code">
|
|
326
|
+
<tr>
|
|
327
|
+
<td>
|
|
328
|
+
<pre class="lines">
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
16
|
|
332
|
+
17
|
|
333
|
+
18
|
|
334
|
+
19
|
|
335
|
+
20
|
|
336
|
+
21</pre>
|
|
337
|
+
</td>
|
|
338
|
+
<td>
|
|
339
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 16</span>
|
|
340
|
+
|
|
341
|
+
<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>
|
|
342
|
+
<span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Extension and ContentType are required"</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:Extension</span><span class='rbrack token'>]</span> <span class='andop op'>&&</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack token'>]</span>
|
|
343
|
+
<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>
|
|
344
|
+
<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>
|
|
345
|
+
<span class='end end kw'>end</span>
|
|
346
|
+
<span class='end end kw'>end</span>
|
|
347
|
+
</pre>
|
|
348
|
+
</td>
|
|
349
|
+
</tr>
|
|
350
|
+
</table>
|
|
351
|
+
</div>
|
|
352
|
+
|
|
353
|
+
</div>
|
|
354
|
+
|
|
355
|
+
<div id="instance_attr_details" class="attr_details">
|
|
356
|
+
<h2>Instance Attribute Details</h2>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<span id="ContentType=-instance_method"></span>
|
|
360
|
+
<span id="ContentType-instance_method"></span>
|
|
361
|
+
<div class="method_details first">
|
|
362
|
+
<p class="signature first" id="ContentType-instance_method">
|
|
363
|
+
|
|
364
|
+
- (<tt>String</tt>) <strong>ContentType</strong>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</p><div class="docstring">
|
|
369
|
+
<div class="discussion">
|
|
370
|
+
<p>
|
|
371
|
+
ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT,
|
|
372
|
+
STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT,
|
|
373
|
+
DRAWING_CT are allowed
|
|
374
|
+
</p>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
</div>
|
|
378
|
+
</div>
|
|
379
|
+
<div class="tags">
|
|
380
|
+
|
|
381
|
+
<h3>Returns:</h3>
|
|
382
|
+
<ul class="return">
|
|
383
|
+
|
|
384
|
+
<li>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
—
|
|
392
|
+
<div class='inline'><p>
|
|
393
|
+
ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT,
|
|
394
|
+
STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT,
|
|
395
|
+
DRAWING_CT are allowed
|
|
396
|
+
</p>
|
|
397
|
+
</div>
|
|
398
|
+
|
|
399
|
+
</li>
|
|
400
|
+
|
|
401
|
+
</ul>
|
|
402
|
+
|
|
403
|
+
</div><table class="source_code">
|
|
404
|
+
<tr>
|
|
405
|
+
<td>
|
|
406
|
+
<pre class="lines">
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
10
|
|
410
|
+
11
|
|
411
|
+
12</pre>
|
|
412
|
+
</td>
|
|
413
|
+
<td>
|
|
414
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 10</span>
|
|
415
|
+
|
|
416
|
+
<span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span>
|
|
417
|
+
<span class='@ContentType ivar id'>@ContentType</span>
|
|
418
|
+
<span class='end end kw'>end</span>
|
|
419
|
+
</pre>
|
|
420
|
+
</td>
|
|
421
|
+
</tr>
|
|
422
|
+
</table>
|
|
423
|
+
</div>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<span id="Extension=-instance_method"></span>
|
|
427
|
+
<span id="Extension-instance_method"></span>
|
|
428
|
+
<div class="method_details ">
|
|
429
|
+
<p class="signature " id="Extension-instance_method">
|
|
430
|
+
|
|
431
|
+
- (<tt>String</tt>) <strong>Extension</strong>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
</p><div class="docstring">
|
|
436
|
+
<div class="discussion">
|
|
437
|
+
<p>
|
|
438
|
+
The extension of the content type.
|
|
439
|
+
</p>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
</div>
|
|
443
|
+
</div>
|
|
444
|
+
<div class="tags">
|
|
445
|
+
|
|
446
|
+
<h3>Returns:</h3>
|
|
447
|
+
<ul class="return">
|
|
448
|
+
|
|
449
|
+
<li>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</li>
|
|
457
|
+
|
|
458
|
+
</ul>
|
|
459
|
+
|
|
460
|
+
</div><table class="source_code">
|
|
461
|
+
<tr>
|
|
462
|
+
<td>
|
|
463
|
+
<pre class="lines">
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
7
|
|
467
|
+
8
|
|
468
|
+
9</pre>
|
|
469
|
+
</td>
|
|
470
|
+
<td>
|
|
471
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 7</span>
|
|
472
|
+
|
|
473
|
+
<span class='def def kw'>def</span> <span class='Extension constant id'>Extension</span>
|
|
474
|
+
<span class='@Extension ivar id'>@Extension</span>
|
|
475
|
+
<span class='end end kw'>end</span>
|
|
476
|
+
</pre>
|
|
477
|
+
</td>
|
|
478
|
+
</tr>
|
|
479
|
+
</table>
|
|
480
|
+
</div>
|
|
481
|
+
|
|
482
|
+
</div>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
<div id="instance_method_details" class="method_details_list">
|
|
486
|
+
<h2>Instance Method Details</h2>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<div class="method_details first">
|
|
490
|
+
<p class="signature first" id="to_xml-instance_method">
|
|
491
|
+
|
|
492
|
+
- (<tt>String</tt>) <strong>to_xml</strong>(xml)
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
</p><div class="docstring">
|
|
497
|
+
<div class="discussion">
|
|
498
|
+
<p>
|
|
499
|
+
Serializes the object to xml
|
|
500
|
+
</p>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
</div>
|
|
504
|
+
</div>
|
|
505
|
+
<div class="tags">
|
|
506
|
+
<h3>Parameters:</h3>
|
|
507
|
+
<ul class="param">
|
|
508
|
+
|
|
509
|
+
<li>
|
|
510
|
+
|
|
511
|
+
<span class='name'>xml</span>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
<span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
—
|
|
519
|
+
<div class='inline'><p>
|
|
520
|
+
The document builder instance this objects xml will be added to.
|
|
521
|
+
</p>
|
|
522
|
+
</div>
|
|
523
|
+
|
|
524
|
+
</li>
|
|
525
|
+
|
|
526
|
+
</ul>
|
|
527
|
+
|
|
528
|
+
<h3>Returns:</h3>
|
|
529
|
+
<ul class="return">
|
|
530
|
+
|
|
531
|
+
<li>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
</li>
|
|
539
|
+
|
|
540
|
+
</ul>
|
|
541
|
+
|
|
542
|
+
</div><table class="source_code">
|
|
543
|
+
<tr>
|
|
544
|
+
<td>
|
|
545
|
+
<pre class="lines">
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
28
|
|
549
|
+
29
|
|
550
|
+
30</pre>
|
|
551
|
+
</td>
|
|
552
|
+
<td>
|
|
553
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 28</span>
|
|
554
|
+
|
|
555
|
+
<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>
|
|
556
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Default constant id'>Default</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span>
|
|
557
|
+
<span class='end end kw'>end</span>
|
|
558
|
+
</pre>
|
|
559
|
+
</td>
|
|
560
|
+
</tr>
|
|
561
|
+
</table>
|
|
562
|
+
</div>
|
|
563
|
+
|
|
564
|
+
</div>
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
|
|
568
|
+
<div id="footer">
|
|
569
|
+
Generated on Tue Nov 22 00:27:37 2011 by
|
|
570
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
571
|
+
0.7.3 (ruby-1.8.7).
|
|
572
|
+
</div>
|
|
573
|
+
|
|
574
|
+
</body>
|
|
575
|
+
</html>
|