axlsx 1.0.5 → 1.0.6
Sign up to get free protection for your applications and to get access to all the features.
- 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
data/doc/file_list.html
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
+
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
+
|
17
|
+
|
18
|
+
<base id="base_target" target="_parent" />
|
19
|
+
</head>
|
20
|
+
<body>
|
21
|
+
<script type="text/javascript" charset="utf-8">
|
22
|
+
if (window.top.frames.main) {
|
23
|
+
document.getElementById('base_target').target = 'main';
|
24
|
+
document.body.className = 'frames';
|
25
|
+
}
|
26
|
+
</script>
|
27
|
+
<div id="content">
|
28
|
+
<h1 id="full_list_header">File List</h1>
|
29
|
+
<div id="nav">
|
30
|
+
|
31
|
+
<a target="_self" href="class_list.html">Classes</a>
|
32
|
+
|
33
|
+
<a target="_self" href="method_list.html">Methods</a>
|
34
|
+
|
35
|
+
<a target="_self" href="file_list.html">Files</a>
|
36
|
+
|
37
|
+
</div>
|
38
|
+
<div id="search">Search: <input type="text" /></div>
|
39
|
+
|
40
|
+
<ul id="full_list" class="files">
|
41
|
+
|
42
|
+
|
43
|
+
<li class="r1"><a href="index.html" title="README">README</a></li>
|
44
|
+
|
45
|
+
|
46
|
+
</ul>
|
47
|
+
</div>
|
48
|
+
</body>
|
49
|
+
</html>
|
data/doc/frames.html
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
3
|
+
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
7
|
+
<title>Documentation by YARD 0.7.3</title>
|
8
|
+
</head>
|
9
|
+
<frameset cols="20%,*">
|
10
|
+
<frame name="list" src="class_list.html" />
|
11
|
+
<frame name="main" src="index.html" />
|
12
|
+
</frameset>
|
13
|
+
</html>
|
data/doc/index.html
ADDED
@@ -0,0 +1,262 @@
|
|
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
|
+
File: README
|
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" title="Index">Index</a> »
|
37
|
+
<span class="title">File: README</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a id="class_list_link" href="#">Class List</a>
|
46
|
+
|
47
|
+
<a id="method_list_link" href="#">Method List</a>
|
48
|
+
|
49
|
+
<a id="file_list_link" href="#">File List</a>
|
50
|
+
|
51
|
+
</div>
|
52
|
+
<div class="clear"></div>
|
53
|
+
</div>
|
54
|
+
|
55
|
+
<iframe id="search_frame"></iframe>
|
56
|
+
|
57
|
+
<div id="content"><div id='filecontents'><h1>Axlsx: Office Open XML Spreadsheet Generation</h1>
|
58
|
+
|
59
|
+
<p><strong>IRC</strong>: <a href="irc://irc.freenode.net/axlsx">irc.freenode.net / #axlsx</a> <br/>
|
60
|
+
<strong>Git</strong>: <a href="http://github.com/randym/axlsx">http://github.com/randym/axlsx</a> <br/>
|
61
|
+
<strong>Author</strong>: Randy Morgan <br/>
|
62
|
+
<strong>Copyright</strong>: 2011 <br/>
|
63
|
+
<strong>License</strong>: MIT License <br/>
|
64
|
+
<strong>Latest Version</strong>: 1.0.6 <br/>
|
65
|
+
<strong>Ruby Version</strong>: 1.8.7 <br/>
|
66
|
+
<strong>Release Date</strong>: November 22nd 2011</p>
|
67
|
+
|
68
|
+
<h2>Synopsis</h2>
|
69
|
+
|
70
|
+
<p>Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language.
|
71
|
+
It enables the you to generate 100% valid xlsx files that include customised styling 3D pie, bar and line charts. Below is a summary of salient features.</p>
|
72
|
+
|
73
|
+
<h2>Feature List</h2>
|
74
|
+
|
75
|
+
<p>**1. Author xlsx documents: Axlsx is made to let you easily and quickly generate profesional xlsx based reports that can be validated before serialiation.</p>
|
76
|
+
|
77
|
+
<p>**2. Generate 3D Pie, Line and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all.</p>
|
78
|
+
|
79
|
+
<p>**3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.</p>
|
80
|
+
|
81
|
+
<p>**4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String and Time types are automatically identified and serialized to your spreadsheet.</p>
|
82
|
+
|
83
|
+
<p>**5. Automatic column widths: Axlsx will automatically determine the appropriate width for your columns based on the content in the worksheet.</p>
|
84
|
+
|
85
|
+
<p>**6. Support for both 1904 and 1900 epocs configurable in the workbook.</p>
|
86
|
+
|
87
|
+
<h2>Installing</h2>
|
88
|
+
|
89
|
+
<p>To install Axlsx, use the following command:</p>
|
90
|
+
|
91
|
+
<pre class="code">$ <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='axlsx identifier id'>axlsx</span>
|
92
|
+
</pre>
|
93
|
+
|
94
|
+
<h2>Usage</h2>
|
95
|
+
|
96
|
+
<pre class="code"> <span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span>
|
97
|
+
<span class='require identifier id'>require</span> <span class='string val'>'axlsx'</span>
|
98
|
+
</pre>
|
99
|
+
|
100
|
+
<h2>A Simple Workbook</h2>
|
101
|
+
|
102
|
+
<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
103
|
+
<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='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
|
104
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span>
|
105
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span>
|
106
|
+
<span class='end end kw'>end</span>
|
107
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example1.xlsx"</span><span class='rparen token'>)</span>
|
108
|
+
</pre>
|
109
|
+
|
110
|
+
<h2>Generating A Bar Chart</h2>
|
111
|
+
|
112
|
+
<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
113
|
+
<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='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
|
114
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span>
|
115
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span>
|
116
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Bar3DChart constant id'>Bar3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 2: Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span>
|
117
|
+
<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span>
|
118
|
+
<span class='end end kw'>end</span>
|
119
|
+
<span class='end end kw'>end</span>
|
120
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example2.xlsx"</span><span class='rparen token'>)</span>
|
121
|
+
</pre>
|
122
|
+
|
123
|
+
<h2>Generating A Pie Chart</h2>
|
124
|
+
|
125
|
+
<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
126
|
+
<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='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
|
127
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span>
|
128
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span>
|
129
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 3: Pie Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span>
|
130
|
+
<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span>
|
131
|
+
<span class='end end kw'>end</span>
|
132
|
+
<span class='end end kw'>end</span>
|
133
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example3.xlsx"</span><span class='rparen token'>)</span>
|
134
|
+
</pre>
|
135
|
+
|
136
|
+
<h2>Using Custom Styles</h2>
|
137
|
+
|
138
|
+
<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
139
|
+
<span class='wb identifier id'>wb</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>
|
140
|
+
<span class='black_cell identifier id'>black_cell</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</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='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFFFFFF"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:alignment</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:horizontal=</span><span class='gt op'>></span> <span class='symbol val'>:center</span> <span class='rbrace token'>}</span>
|
141
|
+
<span class='blue_cell identifier id'>blue_cell</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</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='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF0000FF"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFFFFFF"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:alignment</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:horizontal=</span><span class='gt op'>></span> <span class='symbol val'>:center</span> <span class='rbrace token'>}</span>
|
142
|
+
<span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</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>
|
143
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Text Autowidth"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='black_cell identifier id'>black_cell</span><span class='comma token'>,</span> <span class='blue_cell identifier id'>blue_cell</span><span class='comma token'>,</span> <span class='black_cell identifier id'>black_cell</span><span class='rbrack token'>]</span>
|
144
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</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='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span>
|
145
|
+
<span class='end end kw'>end</span>
|
146
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example4.xlsx"</span><span class='rparen token'>)</span>
|
147
|
+
</pre>
|
148
|
+
|
149
|
+
<h2>Using Custom Formatting and date1904</h2>
|
150
|
+
|
151
|
+
<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
152
|
+
<span class='wb identifier id'>wb</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>
|
153
|
+
<span class='date identifier id'>date</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</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='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"yyyy-mm-dd"</span><span class='comma token'>,</span> <span class='symbol val'>:border</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='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span>
|
154
|
+
<span class='padded identifier id'>padded</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</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='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"00#"</span><span class='comma token'>,</span> <span class='symbol val'>:border</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='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span>
|
155
|
+
<span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</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='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"0%"</span><span class='comma token'>,</span> <span class='symbol val'>:border</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='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span>
|
156
|
+
<span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='comment val'># required for generation on mac</span>
|
157
|
+
<span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</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>
|
158
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Custom Formatted Date"</span><span class='comma token'>,</span> <span class='string val'>"Percent Formatted Float"</span><span class='comma token'>,</span> <span class='string val'>"Padded Numbers"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</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='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span>
|
159
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.2</span><span class='comma token'>,</span> <span class='integer val'>32</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='date identifier id'>date</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='comma token'>,</span> <span class='padded identifier id'>padded</span><span class='rbrack token'>]</span>
|
160
|
+
<span class='end end kw'>end</span>
|
161
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example5.xlsx"</span><span class='rparen token'>)</span>
|
162
|
+
</pre>
|
163
|
+
|
164
|
+
<h2>Validation</h2>
|
165
|
+
|
166
|
+
<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
167
|
+
<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='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
|
168
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span>
|
169
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span>
|
170
|
+
<span class='end end kw'>end</span>
|
171
|
+
|
172
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</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='error identifier id'>error</span><span class='bitor op'>|</span>
|
173
|
+
<span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span>
|
174
|
+
<span class='end end kw'>end</span>
|
175
|
+
</pre>
|
176
|
+
|
177
|
+
<h2>Generating A Line Chart</h2>
|
178
|
+
|
179
|
+
<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
180
|
+
<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='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
|
181
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>7</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='rbrack token'>]</span>
|
182
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>14</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='rbrack token'>]</span>
|
183
|
+
<span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Line3DChart constant id'>Line3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>10</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 6: Line Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span>
|
184
|
+
<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
|
185
|
+
<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
|
186
|
+
<span class='end end kw'>end</span>
|
187
|
+
<span class='end end kw'>end</span>
|
188
|
+
<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example6.xlsx"</span><span class='rparen token'>)</span>
|
189
|
+
</pre>
|
190
|
+
|
191
|
+
<h3>Documentation</h3>
|
192
|
+
|
193
|
+
<p>This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:</p>
|
194
|
+
|
195
|
+
<p> yard server -g</p>
|
196
|
+
|
197
|
+
<h3>Specs</h3>
|
198
|
+
|
199
|
+
<p>This gem has 100% test coverage using test/unit. To execute tests for this gem, simply run rake in the gem directory.</p>
|
200
|
+
|
201
|
+
<h2>Changelog</h2>
|
202
|
+
|
203
|
+
<ul>
|
204
|
+
<li><strong>October.20.11</strong>: 0.1.0 release</li>
|
205
|
+
<li><strong>October.21.11</strong>: 1.0.3 release
|
206
|
+
|
207
|
+
<ul>
|
208
|
+
<li>Updated documentation</li>
|
209
|
+
</ul>
|
210
|
+
</li>
|
211
|
+
<li><strong>October.21.11</strong>: 1.0.4
|
212
|
+
|
213
|
+
<ul>
|
214
|
+
<li>altered package to accept a filename string for serialization instead of a File object.</li>
|
215
|
+
<li>Updated specs to conform</li>
|
216
|
+
<li>More examples for readme</li>
|
217
|
+
</ul>
|
218
|
+
</li>
|
219
|
+
<li><strong>October.22.11</strong>: 1.05
|
220
|
+
|
221
|
+
<ul>
|
222
|
+
<li>Added support for line charts</li>
|
223
|
+
<li>Updated examples and readme</li>
|
224
|
+
<li>Updated series title to be a real title <strong> NOTE </strong> If you are accessing titles directly you will need to update text assignation to title.text = v</li>
|
225
|
+
<li>BugFix: shape attribute for bar chart is now properly serialized</li>
|
226
|
+
<li>BugFix: date1904 property now properly set for charts</li>
|
227
|
+
<li>Added style property to charts</li>
|
228
|
+
<li>Removed serialization write test as it most commonly fails when run from the gem's intalled directory</li>
|
229
|
+
</ul>
|
230
|
+
</li>
|
231
|
+
<li><strong>October.22.11</strong>: 1.0.6 release
|
232
|
+
|
233
|
+
<ul>
|
234
|
+
<li>Bumping version to include docs. Bug in gemspec pointing to incorrect directory.
|
235
|
+
On Deck</li>
|
236
|
+
</ul>
|
237
|
+
</li>
|
238
|
+
</ul>
|
239
|
+
|
240
|
+
|
241
|
+
<hr />
|
242
|
+
|
243
|
+
<ul>
|
244
|
+
<li>Verification with ruby 1.9.3</li>
|
245
|
+
<li>Active Record support via package::serialize_ar so you can dump an AR result into a worksheet in one go.</li>
|
246
|
+
</ul>
|
247
|
+
|
248
|
+
|
249
|
+
<h2>Copyright</h2>
|
250
|
+
|
251
|
+
<p>Axlsx © 2011 by <a href="mailto:digial.ipseity@gmail.com">Randy Morgan</a>. Axlsx is
|
252
|
+
licensed under the MIT license. Please see the <a href="file.LICENSE.html" title="LICENSE">LICENSE</a> document for more information.</p>
|
253
|
+
</div></div>
|
254
|
+
|
255
|
+
<div id="footer">
|
256
|
+
Generated on Tue Nov 22 00:27:36 2011 by
|
257
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
258
|
+
0.7.3 (ruby-1.8.7).
|
259
|
+
</div>
|
260
|
+
|
261
|
+
</body>
|
262
|
+
</html>
|
data/doc/js/app.js
ADDED
@@ -0,0 +1,205 @@
|
|
1
|
+
function createSourceLinks() {
|
2
|
+
$('.method_details_list .source_code').
|
3
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
4
|
+
$('.toggleSource').toggle(function() {
|
5
|
+
$(this).parent().next().slideDown(100);
|
6
|
+
$(this).text("Hide source");
|
7
|
+
},
|
8
|
+
function() {
|
9
|
+
$(this).parent().next().slideUp(100);
|
10
|
+
$(this).text("View source");
|
11
|
+
});
|
12
|
+
}
|
13
|
+
|
14
|
+
function createDefineLinks() {
|
15
|
+
var tHeight = 0;
|
16
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
17
|
+
$('.toggleDefines').toggle(function() {
|
18
|
+
tHeight = $(this).parent().prev().height();
|
19
|
+
$(this).prev().show();
|
20
|
+
$(this).parent().prev().height($(this).parent().height());
|
21
|
+
$(this).text("(less)");
|
22
|
+
},
|
23
|
+
function() {
|
24
|
+
$(this).prev().hide();
|
25
|
+
$(this).parent().prev().height(tHeight);
|
26
|
+
$(this).text("more...");
|
27
|
+
});
|
28
|
+
}
|
29
|
+
|
30
|
+
function createFullTreeLinks() {
|
31
|
+
var tHeight = 0;
|
32
|
+
$('.inheritanceTree').toggle(function() {
|
33
|
+
tHeight = $(this).parent().prev().height();
|
34
|
+
$(this).parent().toggleClass('showAll');
|
35
|
+
$(this).text("(hide)");
|
36
|
+
$(this).parent().prev().height($(this).parent().height());
|
37
|
+
},
|
38
|
+
function() {
|
39
|
+
$(this).parent().toggleClass('showAll');
|
40
|
+
$(this).parent().prev().height(tHeight);
|
41
|
+
$(this).text("show all");
|
42
|
+
});
|
43
|
+
}
|
44
|
+
|
45
|
+
function fixBoxInfoHeights() {
|
46
|
+
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
47
|
+
$(this).prev().height($(this).height());
|
48
|
+
});
|
49
|
+
}
|
50
|
+
|
51
|
+
function searchFrameLinks() {
|
52
|
+
$('#method_list_link').click(function() {
|
53
|
+
toggleSearchFrame(this, relpath + 'method_list.html');
|
54
|
+
});
|
55
|
+
|
56
|
+
$('#class_list_link').click(function() {
|
57
|
+
toggleSearchFrame(this, relpath + 'class_list.html');
|
58
|
+
});
|
59
|
+
|
60
|
+
$('#file_list_link').click(function() {
|
61
|
+
toggleSearchFrame(this, relpath + 'file_list.html');
|
62
|
+
});
|
63
|
+
}
|
64
|
+
|
65
|
+
function toggleSearchFrame(id, link) {
|
66
|
+
var frame = $('#search_frame');
|
67
|
+
$('#search a').removeClass('active').addClass('inactive');
|
68
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
69
|
+
frame.slideUp(100);
|
70
|
+
$('#search a').removeClass('active inactive');
|
71
|
+
}
|
72
|
+
else {
|
73
|
+
$(id).addClass('active').removeClass('inactive');
|
74
|
+
frame.attr('src', link).slideDown(100);
|
75
|
+
}
|
76
|
+
}
|
77
|
+
|
78
|
+
function linkSummaries() {
|
79
|
+
$('.summary_signature').click(function() {
|
80
|
+
document.location = $(this).find('a').attr('href');
|
81
|
+
});
|
82
|
+
}
|
83
|
+
|
84
|
+
function framesInit() {
|
85
|
+
if (window.top.frames.main) {
|
86
|
+
document.body.className = 'frames';
|
87
|
+
$('#menu .noframes a').attr('href', document.location);
|
88
|
+
$('html head title', window.parent.document).text($('html head title').text());
|
89
|
+
}
|
90
|
+
}
|
91
|
+
|
92
|
+
function keyboardShortcuts() {
|
93
|
+
if (window.top.frames.main) return;
|
94
|
+
$(document).keypress(function(evt) {
|
95
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
96
|
+
if (typeof evt.target !== "undefined" &&
|
97
|
+
(evt.target.nodeName == "INPUT" ||
|
98
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
99
|
+
switch (evt.charCode) {
|
100
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
101
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
102
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
103
|
+
default: break;
|
104
|
+
}
|
105
|
+
});
|
106
|
+
}
|
107
|
+
|
108
|
+
function summaryToggle() {
|
109
|
+
$('.summary_toggle').click(function() {
|
110
|
+
localStorage.summaryCollapsed = $(this).text();
|
111
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
112
|
+
var next = $(this).parent().parent().next();
|
113
|
+
if (next.hasClass('compact')) {
|
114
|
+
next.toggle();
|
115
|
+
next.next().toggle();
|
116
|
+
}
|
117
|
+
else if (next.hasClass('summary')) {
|
118
|
+
var list = $('<ul class="summary compact" />');
|
119
|
+
list.html(next.html());
|
120
|
+
list.find('.summary_desc, .note').remove();
|
121
|
+
list.find('a').each(function() {
|
122
|
+
$(this).html($(this).find('strong').html());
|
123
|
+
$(this).parent().html($(this)[0].outerHTML);
|
124
|
+
});
|
125
|
+
next.before(list);
|
126
|
+
next.toggle();
|
127
|
+
}
|
128
|
+
return false;
|
129
|
+
});
|
130
|
+
if (localStorage) {
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
|
132
|
+
else localStorage.summaryCollapsed = "expand";
|
133
|
+
}
|
134
|
+
}
|
135
|
+
|
136
|
+
function fixOutsideWorldLinks() {
|
137
|
+
$('a').each(function() {
|
138
|
+
if (window.location.host != this.host) this.target = '_parent';
|
139
|
+
});
|
140
|
+
}
|
141
|
+
|
142
|
+
function generateTOC() {
|
143
|
+
if ($('#filecontents').length === 0) return;
|
144
|
+
var _toc = $('<ol class="top"></ol>');
|
145
|
+
var show = false;
|
146
|
+
var toc = _toc;
|
147
|
+
var counter = 0;
|
148
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
149
|
+
var i;
|
150
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
151
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
152
|
+
var lastTag = parseInt(tags[0][1], 10);
|
153
|
+
$(tags.join(', ')).each(function() {
|
154
|
+
if (this.id == "filecontents") return;
|
155
|
+
show = true;
|
156
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
157
|
+
if (this.id.length === 0) {
|
158
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
159
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
160
|
+
this.id = proposedId;
|
161
|
+
}
|
162
|
+
if (thisTag > lastTag) {
|
163
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
164
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
165
|
+
}
|
166
|
+
}
|
167
|
+
if (thisTag < lastTag) {
|
168
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
169
|
+
}
|
170
|
+
toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
|
171
|
+
lastTag = thisTag;
|
172
|
+
});
|
173
|
+
if (!show) return;
|
174
|
+
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
175
|
+
$('#content').prepend(html);
|
176
|
+
$('#toc').append(_toc);
|
177
|
+
$('#toc .hide_toc').toggle(function() {
|
178
|
+
$('#toc .top').slideUp('fast');
|
179
|
+
$('#toc').toggleClass('hidden');
|
180
|
+
$('#toc .title small').toggle();
|
181
|
+
}, function() {
|
182
|
+
$('#toc .top').slideDown('fast');
|
183
|
+
$('#toc').toggleClass('hidden');
|
184
|
+
$('#toc .title small').toggle();
|
185
|
+
});
|
186
|
+
$('#toc .float_toc').toggle(function() {
|
187
|
+
$(this).text('float');
|
188
|
+
$('#toc').toggleClass('nofloat');
|
189
|
+
}, function() {
|
190
|
+
$(this).text('left');
|
191
|
+
$('#toc').toggleClass('nofloat');
|
192
|
+
});
|
193
|
+
}
|
194
|
+
|
195
|
+
$(framesInit);
|
196
|
+
$(createSourceLinks);
|
197
|
+
$(createDefineLinks);
|
198
|
+
$(createFullTreeLinks);
|
199
|
+
$(fixBoxInfoHeights);
|
200
|
+
$(searchFrameLinks);
|
201
|
+
$(linkSummaries);
|
202
|
+
$(keyboardShortcuts);
|
203
|
+
$(summaryToggle);
|
204
|
+
$(fixOutsideWorldLinks);
|
205
|
+
$(generateTOC);
|