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,340 @@
|
|
|
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::ContentType
|
|
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 (C)</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">ContentType</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::ContentType
|
|
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"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li>
|
|
75
|
+
|
|
76
|
+
<li class="next">Axlsx::ContentType</li>
|
|
77
|
+
|
|
78
|
+
</ul>
|
|
79
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
80
|
+
|
|
81
|
+
</dd>
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
<dt class="r2 last">Defined in:</dt>
|
|
92
|
+
<dd class="r2 last">lib/axlsx/content_type/content_type.rb</dd>
|
|
93
|
+
|
|
94
|
+
</dl>
|
|
95
|
+
<div class="clear"></div>
|
|
96
|
+
|
|
97
|
+
<h2>Overview</h2><div class="docstring">
|
|
98
|
+
<div class="discussion">
|
|
99
|
+
<p>
|
|
100
|
+
ContentTypes used in the package. This is automatcially managed by the
|
|
101
|
+
package package.
|
|
102
|
+
</p>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
</div>
|
|
107
|
+
<div class="tags">
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<h2>Instance Attribute Summary</h2>
|
|
122
|
+
|
|
123
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3>
|
|
124
|
+
<p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</a></span></p>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<h2>
|
|
129
|
+
Instance Method Summary
|
|
130
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
131
|
+
</h2>
|
|
132
|
+
|
|
133
|
+
<ul class="summary">
|
|
134
|
+
|
|
135
|
+
<li class="public ">
|
|
136
|
+
<span class="summary_signature">
|
|
137
|
+
|
|
138
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (ContentType) <strong>initialize</strong> </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
<span class="note title constructor">constructor</span>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
154
|
+
A new instance of ContentType.
|
|
155
|
+
</p>
|
|
156
|
+
</div></span>
|
|
157
|
+
|
|
158
|
+
</li>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<li class="public ">
|
|
162
|
+
<span class="summary_signature">
|
|
163
|
+
|
|
164
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</span>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
178
|
+
Generates the xml document for [Content_Types].xml.
|
|
179
|
+
</p>
|
|
180
|
+
</div></span>
|
|
181
|
+
|
|
182
|
+
</li>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</ul>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3>
|
|
197
|
+
<p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p>
|
|
198
|
+
<div id="constructor_details" class="method_details_list">
|
|
199
|
+
<h2>Constructor Details</h2>
|
|
200
|
+
|
|
201
|
+
<div class="method_details first">
|
|
202
|
+
<p class="signature first" id="initialize-instance_method">
|
|
203
|
+
|
|
204
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::ContentType (class)">ContentType</a></span></tt>) <strong>initialize</strong>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
</p><div class="docstring">
|
|
209
|
+
<div class="discussion">
|
|
210
|
+
<p>
|
|
211
|
+
A new instance of ContentType
|
|
212
|
+
</p>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</div>
|
|
216
|
+
</div>
|
|
217
|
+
<div class="tags">
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
</div><table class="source_code">
|
|
221
|
+
<tr>
|
|
222
|
+
<td>
|
|
223
|
+
<pre class="lines">
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
8
|
|
227
|
+
9
|
|
228
|
+
10</pre>
|
|
229
|
+
</td>
|
|
230
|
+
<td>
|
|
231
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 8</span>
|
|
232
|
+
|
|
233
|
+
<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span>
|
|
234
|
+
<span class='super super kw'>super</span> <span class='lbrack token'>[</span><span class='Override constant id'>Override</span><span class='comma token'>,</span> <span class='Default constant id'>Default</span><span class='rbrack token'>]</span>
|
|
235
|
+
<span class='end end kw'>end</span>
|
|
236
|
+
</pre>
|
|
237
|
+
</td>
|
|
238
|
+
</tr>
|
|
239
|
+
</table>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
</div>
|
|
243
|
+
<div id="method_missing_details" class="method_details_list">
|
|
244
|
+
<h2>Dynamic Method Handling</h2>
|
|
245
|
+
<p class="notice super">
|
|
246
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
|
247
|
+
|
|
248
|
+
in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span>
|
|
249
|
+
|
|
250
|
+
</p>
|
|
251
|
+
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<div id="instance_method_details" class="method_details_list">
|
|
256
|
+
<h2>Instance Method Details</h2>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
<div class="method_details first">
|
|
260
|
+
<p class="signature first" id="to_xml-instance_method">
|
|
261
|
+
|
|
262
|
+
- (<tt>String</tt>) <strong>to_xml</strong>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
</p><div class="docstring">
|
|
267
|
+
<div class="discussion">
|
|
268
|
+
<p>
|
|
269
|
+
Generates the xml document for [Content_Types].xml
|
|
270
|
+
</p>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
</div>
|
|
274
|
+
</div>
|
|
275
|
+
<div class="tags">
|
|
276
|
+
|
|
277
|
+
<h3>Returns:</h3>
|
|
278
|
+
<ul class="return">
|
|
279
|
+
|
|
280
|
+
<li>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
—
|
|
288
|
+
<div class='inline'><p>
|
|
289
|
+
The document as a string.
|
|
290
|
+
</p>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
</ul>
|
|
296
|
+
|
|
297
|
+
</div><table class="source_code">
|
|
298
|
+
<tr>
|
|
299
|
+
<td>
|
|
300
|
+
<pre class="lines">
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
14
|
|
304
|
+
15
|
|
305
|
+
16
|
|
306
|
+
17
|
|
307
|
+
18
|
|
308
|
+
19
|
|
309
|
+
20
|
|
310
|
+
21</pre>
|
|
311
|
+
</td>
|
|
312
|
+
<td>
|
|
313
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 14</span>
|
|
314
|
+
|
|
315
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
|
|
316
|
+
<span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
|
|
317
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Types constant id'>Types</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='XML_NS_T constant id'>XML_NS_T</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
318
|
+
<span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='type identifier id'>type</span><span class='bitor op'>|</span> <span class='type identifier id'>type</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
|
|
319
|
+
<span class='rbrace token'>}</span>
|
|
320
|
+
<span class='end end kw'>end</span>
|
|
321
|
+
<span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
|
|
322
|
+
<span class='end end kw'>end</span>
|
|
323
|
+
</pre>
|
|
324
|
+
</td>
|
|
325
|
+
</tr>
|
|
326
|
+
</table>
|
|
327
|
+
</div>
|
|
328
|
+
|
|
329
|
+
</div>
|
|
330
|
+
|
|
331
|
+
</div>
|
|
332
|
+
|
|
333
|
+
<div id="footer">
|
|
334
|
+
Generated on Tue Nov 22 00:27:46 2011 by
|
|
335
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
336
|
+
0.7.3 (ruby-1.8.7).
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
</body>
|
|
340
|
+
</html>
|
data/doc/Axlsx/Core.html
ADDED
|
@@ -0,0 +1,465 @@
|
|
|
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::Core
|
|
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 (C)</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">Core</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::Core
|
|
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::Core</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/doc_props/core.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
|
+
Packages manage their own core object.
|
|
102
|
+
</p>
|
|
103
|
+
</div>
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<p>
|
|
107
|
+
The core object for the package.
|
|
108
|
+
</p>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
<div class="tags">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<h3>See Also:</h3>
|
|
117
|
+
<ul class="see">
|
|
118
|
+
|
|
119
|
+
<li>Package#core</li>
|
|
120
|
+
|
|
121
|
+
</ul>
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
|
|
125
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
126
|
+
<ul class="summary">
|
|
127
|
+
|
|
128
|
+
<li class="public ">
|
|
129
|
+
<span class="summary_signature">
|
|
130
|
+
|
|
131
|
+
<a href="#creator-instance_method" title="#creator (instance method)">- (String) <strong>creator</strong> </a>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
</span>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
148
|
+
The author of the document.
|
|
149
|
+
</p>
|
|
150
|
+
</div></span>
|
|
151
|
+
|
|
152
|
+
</li>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
</ul>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<h2>
|
|
162
|
+
Instance Method Summary
|
|
163
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
164
|
+
</h2>
|
|
165
|
+
|
|
166
|
+
<ul class="summary">
|
|
167
|
+
|
|
168
|
+
<li class="public ">
|
|
169
|
+
<span class="summary_signature">
|
|
170
|
+
|
|
171
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Core) <strong>initialize</strong>(options = {}) </a>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
</span>
|
|
176
|
+
|
|
177
|
+
<span class="note title constructor">constructor</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
187
|
+
Creates a new Core object.
|
|
188
|
+
</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<li class="public ">
|
|
195
|
+
<span class="summary_signature">
|
|
196
|
+
|
|
197
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</span>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
211
|
+
Serializes the core object.
|
|
212
|
+
</p>
|
|
213
|
+
</div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</ul>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<div id="constructor_details" class="method_details_list">
|
|
222
|
+
<h2>Constructor Details</h2>
|
|
223
|
+
|
|
224
|
+
<div class="method_details first">
|
|
225
|
+
<p class="signature first" id="initialize-instance_method">
|
|
226
|
+
|
|
227
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Core (class)">Core</a></span></tt>) <strong>initialize</strong>(options = {})
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</p><div class="docstring">
|
|
232
|
+
<div class="discussion">
|
|
233
|
+
<p>
|
|
234
|
+
Creates a new Core object.
|
|
235
|
+
</p>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</div>
|
|
239
|
+
</div>
|
|
240
|
+
<div class="tags">
|
|
241
|
+
<h3>Parameters:</h3>
|
|
242
|
+
<ul class="param">
|
|
243
|
+
|
|
244
|
+
<li>
|
|
245
|
+
|
|
246
|
+
<span class='name'>options</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
—
|
|
256
|
+
<div class='inline'><p>
|
|
257
|
+
a customizable set of options
|
|
258
|
+
</p>
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
</ul>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
269
|
+
<ul class="option">
|
|
270
|
+
|
|
271
|
+
<li>
|
|
272
|
+
<span class="name">creator</span>
|
|
273
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
274
|
+
<span class="default">
|
|
275
|
+
|
|
276
|
+
</span>
|
|
277
|
+
|
|
278
|
+
</li>
|
|
279
|
+
|
|
280
|
+
</ul>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</div><table class="source_code">
|
|
285
|
+
<tr>
|
|
286
|
+
<td>
|
|
287
|
+
<pre class="lines">
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
12
|
|
291
|
+
13
|
|
292
|
+
14</pre>
|
|
293
|
+
</td>
|
|
294
|
+
<td>
|
|
295
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 12</span>
|
|
296
|
+
|
|
297
|
+
<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>
|
|
298
|
+
<span class='@creator ivar id'>@creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:creator</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>'axlsx'</span>
|
|
299
|
+
<span class='end end kw'>end</span>
|
|
300
|
+
</pre>
|
|
301
|
+
</td>
|
|
302
|
+
</tr>
|
|
303
|
+
</table>
|
|
304
|
+
</div>
|
|
305
|
+
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
<div id="instance_attr_details" class="attr_details">
|
|
309
|
+
<h2>Instance Attribute Details</h2>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<span id="creator=-instance_method"></span>
|
|
313
|
+
<span id="creator-instance_method"></span>
|
|
314
|
+
<div class="method_details first">
|
|
315
|
+
<p class="signature first" id="creator-instance_method">
|
|
316
|
+
|
|
317
|
+
- (<tt>String</tt>) <strong>creator</strong>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
</p><div class="docstring">
|
|
322
|
+
<div class="discussion">
|
|
323
|
+
<p>
|
|
324
|
+
The author of the document. By default this is ‘axlsx’
|
|
325
|
+
</p>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
</div>
|
|
329
|
+
</div>
|
|
330
|
+
<div class="tags">
|
|
331
|
+
|
|
332
|
+
<h3>Returns:</h3>
|
|
333
|
+
<ul class="return">
|
|
334
|
+
|
|
335
|
+
<li>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
</li>
|
|
343
|
+
|
|
344
|
+
</ul>
|
|
345
|
+
|
|
346
|
+
</div><table class="source_code">
|
|
347
|
+
<tr>
|
|
348
|
+
<td>
|
|
349
|
+
<pre class="lines">
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
8
|
|
353
|
+
9
|
|
354
|
+
10</pre>
|
|
355
|
+
</td>
|
|
356
|
+
<td>
|
|
357
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 8</span>
|
|
358
|
+
|
|
359
|
+
<span class='def def kw'>def</span> <span class='creator identifier id'>creator</span>
|
|
360
|
+
<span class='@creator ivar id'>@creator</span>
|
|
361
|
+
<span class='end end kw'>end</span>
|
|
362
|
+
</pre>
|
|
363
|
+
</td>
|
|
364
|
+
</tr>
|
|
365
|
+
</table>
|
|
366
|
+
</div>
|
|
367
|
+
|
|
368
|
+
</div>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<div id="instance_method_details" class="method_details_list">
|
|
372
|
+
<h2>Instance Method Details</h2>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<div class="method_details first">
|
|
376
|
+
<p class="signature first" id="to_xml-instance_method">
|
|
377
|
+
|
|
378
|
+
- (<tt>String</tt>) <strong>to_xml</strong>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</p><div class="docstring">
|
|
383
|
+
<div class="discussion">
|
|
384
|
+
<p>
|
|
385
|
+
Serializes the core object. The created dcterms item is set to the current
|
|
386
|
+
time when this method is called.
|
|
387
|
+
</p>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</div>
|
|
391
|
+
</div>
|
|
392
|
+
<div class="tags">
|
|
393
|
+
|
|
394
|
+
<h3>Returns:</h3>
|
|
395
|
+
<ul class="return">
|
|
396
|
+
|
|
397
|
+
<li>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
</li>
|
|
405
|
+
|
|
406
|
+
</ul>
|
|
407
|
+
|
|
408
|
+
</div><table class="source_code">
|
|
409
|
+
<tr>
|
|
410
|
+
<td>
|
|
411
|
+
<pre class="lines">
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
18
|
|
415
|
+
19
|
|
416
|
+
20
|
|
417
|
+
21
|
|
418
|
+
22
|
|
419
|
+
23
|
|
420
|
+
24
|
|
421
|
+
25
|
|
422
|
+
26
|
|
423
|
+
27
|
|
424
|
+
28
|
|
425
|
+
29
|
|
426
|
+
30
|
|
427
|
+
31
|
|
428
|
+
32</pre>
|
|
429
|
+
</td>
|
|
430
|
+
<td>
|
|
431
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 18</span>
|
|
432
|
+
|
|
433
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
|
|
434
|
+
<span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
|
|
435
|
+
<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'>'cp:coreProperties'</span><span class='comma token'>,</span>
|
|
436
|
+
<span class='symbol val'>:"xmlns:cp"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS constant id'>CORE_NS</span><span class='comma token'>,</span>
|
|
437
|
+
<span class='symbol val'>:'xmlns:dc'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS_DC constant id'>CORE_NS_DC</span><span class='comma token'>,</span>
|
|
438
|
+
<span class='symbol val'>:'xmlns:dcmitype'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCMIT constant id'>CORE_NS_DCMIT</span><span class='comma token'>,</span>
|
|
439
|
+
<span class='symbol val'>:'xmlns:dcterms'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCT constant id'>CORE_NS_DCT</span><span class='comma token'>,</span>
|
|
440
|
+
<span class='symbol val'>:'xmlns:xsi'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_XSI constant id'>CORE_NS_XSI</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
441
|
+
<span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dc'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span>
|
|
442
|
+
<span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dcterms'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='created identifier id'>created</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='dot token'>.</span><span class='strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='string val'>'%Y-%m-%dT%H:%M:%S'</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:'xsi:type'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"dcterms:W3CDTF"</span>
|
|
443
|
+
<span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'cp'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='revision identifier id'>revision</span> <span class='integer val'>0</span>
|
|
444
|
+
<span class='rbrace token'>}</span>
|
|
445
|
+
<span class='end end kw'>end</span>
|
|
446
|
+
<span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
|
|
447
|
+
<span class='end end kw'>end</span>
|
|
448
|
+
</pre>
|
|
449
|
+
</td>
|
|
450
|
+
</tr>
|
|
451
|
+
</table>
|
|
452
|
+
</div>
|
|
453
|
+
|
|
454
|
+
</div>
|
|
455
|
+
|
|
456
|
+
</div>
|
|
457
|
+
|
|
458
|
+
<div id="footer">
|
|
459
|
+
Generated on Tue Nov 22 00:27:53 2011 by
|
|
460
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
461
|
+
0.7.3 (ruby-1.8.7).
|
|
462
|
+
</div>
|
|
463
|
+
|
|
464
|
+
</body>
|
|
465
|
+
</html>
|