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,1153 @@
|
|
|
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::Bar3DChart
|
|
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 (B)</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">Bar3DChart</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::Bar3DChart
|
|
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="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li>
|
|
75
|
+
|
|
76
|
+
<li class="next">Axlsx::Bar3DChart</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/drawing/bar_3D_chart.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
|
+
The Bar3DChart is a three dimentional barchart (who would have guessed?)
|
|
101
|
+
that you can add to your worksheet.
|
|
102
|
+
</p>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
</div>
|
|
107
|
+
<div class="tags">
|
|
108
|
+
|
|
109
|
+
<div class="examples">
|
|
110
|
+
<h3>Examples:</h3>
|
|
111
|
+
|
|
112
|
+
<h4><div class='inline'><p>
|
|
113
|
+
Creating a chart
|
|
114
|
+
</p>
|
|
115
|
+
</div></h4>
|
|
116
|
+
<pre class="example code"><span class='comment val'># This example creates two charts in a single sheet.</span>
|
|
117
|
+
<span class='comment val'># The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.</span>
|
|
118
|
+
|
|
119
|
+
<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span>
|
|
120
|
+
<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span>
|
|
121
|
+
|
|
122
|
+
<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>
|
|
123
|
+
<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span>
|
|
124
|
+
<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This is a chart with no data in the sheet"</span><span class='rbrack token'>]</span>
|
|
125
|
+
|
|
126
|
+
<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</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='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at=</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'>6</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'>"Most Popular Pets"</span><span class='rparen token'>)</span>
|
|
127
|
+
<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='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Slimy Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Fuzzy Bunnies"</span><span class='comma token'>,</span> <span class='string val'>"Rottweiler"</span><span class='rbrack token'>]</span>
|
|
128
|
+
|
|
129
|
+
<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This chart uses the data below"</span><span class='rbrack token'>]</span>
|
|
130
|
+
<span class='title_row identifier id'>title_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Least Popular Pets"</span><span class='rbrack token'>]</span>
|
|
131
|
+
<span class='label_row identifier id'>label_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='string val'>"Dry Skinned Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Bald Cats"</span><span class='comma token'>,</span> <span class='string val'>"Violent Parrots"</span><span class='rbrack token'>]</span>
|
|
132
|
+
<span class='data_row identifier id'>data_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Votes"</span><span class='comma token'>,</span> <span class='integer val'>6</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='rbrack token'>]</span>
|
|
133
|
+
|
|
134
|
+
<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</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'>11</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'>0</span><span class='comma token'>,</span><span class='integer val'>16</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='title_row identifier id'>title_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='rparen token'>)</span>
|
|
135
|
+
<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='assign token'>=</span><span class='gt op'>></span> <span class='data_row identifier id'>data_row</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'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='label_row identifier id'>label_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span>
|
|
136
|
+
|
|
137
|
+
<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_pie_3d_chart.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span>
|
|
138
|
+
<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='f identifier id'>f</span><span class='rparen token'>)</span>
|
|
139
|
+
</pre>
|
|
140
|
+
|
|
141
|
+
</div>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<h3>See Also:</h3>
|
|
145
|
+
<ul class="see">
|
|
146
|
+
|
|
147
|
+
<li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li>
|
|
148
|
+
|
|
149
|
+
<li><span class='object_link'><a href="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li>
|
|
150
|
+
|
|
151
|
+
<li><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</a></span></li>
|
|
152
|
+
|
|
153
|
+
<li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li>
|
|
154
|
+
|
|
155
|
+
<li><span class='object_link'><a href="Package.html#serialize-instance_method" title="Axlsx::Package#serialize (method)">Package#serialize</a></span></li>
|
|
156
|
+
|
|
157
|
+
</ul>
|
|
158
|
+
|
|
159
|
+
</div>
|
|
160
|
+
<h2>Constant Summary</h2>
|
|
161
|
+
|
|
162
|
+
<dl class="constants">
|
|
163
|
+
|
|
164
|
+
<dt id="GAP_AMOUNT_PERCENT-constant" class="">GAP_AMOUNT_PERCENT =
|
|
165
|
+
<div class="docstring">
|
|
166
|
+
<div class="discussion">
|
|
167
|
+
<p>
|
|
168
|
+
validation regex for gap amount percent
|
|
169
|
+
</p>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</div>
|
|
173
|
+
</div>
|
|
174
|
+
<div class="tags">
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</div>
|
|
178
|
+
</dt>
|
|
179
|
+
<dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span>
|
|
180
|
+
</pre></dd>
|
|
181
|
+
|
|
182
|
+
</dl>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
191
|
+
<ul class="summary">
|
|
192
|
+
|
|
193
|
+
<li class="public ">
|
|
194
|
+
<span class="summary_signature">
|
|
195
|
+
|
|
196
|
+
<a href="#barDir-instance_method" title="#barDir (instance method)">- (Symbol) <strong>barDir</strong> </a>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
213
|
+
The direction of the bars in the chart must be one of [:bar, :col].
|
|
214
|
+
</p>
|
|
215
|
+
</div></span>
|
|
216
|
+
|
|
217
|
+
</li>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<li class="public ">
|
|
221
|
+
<span class="summary_signature">
|
|
222
|
+
|
|
223
|
+
<a href="#catAxis-instance_method" title="#catAxis (instance method)">- (CatAxis) <strong>catAxis</strong> </a>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="note title readonly">readonly</span>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
240
|
+
the category axis.
|
|
241
|
+
</p>
|
|
242
|
+
</div></span>
|
|
243
|
+
|
|
244
|
+
</li>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
<li class="public ">
|
|
248
|
+
<span class="summary_signature">
|
|
249
|
+
|
|
250
|
+
<a href="#gapDepth-instance_method" title="#gapDepth (instance method)">- (String) <strong>gapDepth</strong> </a>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
</span>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
267
|
+
space between bar or column clusters, as a percentage of the bar or column
|
|
268
|
+
width.
|
|
269
|
+
</p>
|
|
270
|
+
</div></span>
|
|
271
|
+
|
|
272
|
+
</li>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<li class="public ">
|
|
276
|
+
<span class="summary_signature">
|
|
277
|
+
|
|
278
|
+
<a href="#gapWidth-instance_method" title="#gapWidth (instance method)">- (String) <strong>gapWidth</strong> </a>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
</span>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
295
|
+
space between bar or column clusters, as a percentage of the bar or column
|
|
296
|
+
width.
|
|
297
|
+
</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#grouping-instance_method" title="#grouping (instance method)">- (Symbol) <strong>grouping</strong> </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
323
|
+
grouping for a column, line, or area chart.
|
|
324
|
+
</p>
|
|
325
|
+
</div></span>
|
|
326
|
+
|
|
327
|
+
</li>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<li class="public ">
|
|
331
|
+
<span class="summary_signature">
|
|
332
|
+
|
|
333
|
+
<a href="#shape-instance_method" title="#shape (instance method)">- (Symbol) <strong>shape</strong> </a>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
</span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
350
|
+
The shabe of the bars or columns must be one of [:percentStacked,
|
|
351
|
+
:clustered, :standard, :stacked].
|
|
352
|
+
</p>
|
|
353
|
+
</div></span>
|
|
354
|
+
|
|
355
|
+
</li>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<li class="public ">
|
|
359
|
+
<span class="summary_signature">
|
|
360
|
+
|
|
361
|
+
<a href="#valAxis-instance_method" title="#valAxis (instance method)">- (ValAxis) <strong>valAxis</strong> </a>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
</span>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="note title readonly">readonly</span>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
378
|
+
the category axis.
|
|
379
|
+
</p>
|
|
380
|
+
</div></span>
|
|
381
|
+
|
|
382
|
+
</li>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</ul>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3>
|
|
395
|
+
<p class="inherited"><span class='object_link'><a href="Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">end_at</a></span>, <span class='object_link'><a href="Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">graphic_frame</a></span>, <span class='object_link'><a href="Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">index</a></span>, <span class='object_link'><a href="Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">pn</a></span>, <span class='object_link'><a href="Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">series</a></span>, <span class='object_link'><a href="Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">series_type</a></span>, <span class='object_link'><a href="Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">show_legend</a></span>, <span class='object_link'><a href="Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">start_at</a></span>, <span class='object_link'><a href="Chart.html#style-instance_method" title="Axlsx::Chart#style (method)">style</a></span>, <span class='object_link'><a href="Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">title</a></span>, <span class='object_link'><a href="Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">view3D</a></span></p>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<h2>
|
|
400
|
+
Instance Method Summary
|
|
401
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
402
|
+
</h2>
|
|
403
|
+
|
|
404
|
+
<ul class="summary">
|
|
405
|
+
|
|
406
|
+
<li class="public ">
|
|
407
|
+
<span class="summary_signature">
|
|
408
|
+
|
|
409
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Bar3DChart) <strong>initialize</strong>(frame, options = {}) </a>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</span>
|
|
414
|
+
|
|
415
|
+
<span class="note title constructor">constructor</span>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
425
|
+
Creates a new bar chart object.
|
|
426
|
+
</p>
|
|
427
|
+
</div></span>
|
|
428
|
+
|
|
429
|
+
</li>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<li class="public ">
|
|
433
|
+
<span class="summary_signature">
|
|
434
|
+
|
|
435
|
+
<a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
</span>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
449
|
+
Serializes the bar chart.
|
|
450
|
+
</p>
|
|
451
|
+
</div></span>
|
|
452
|
+
|
|
453
|
+
</li>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</ul>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3>
|
|
468
|
+
<p class="inherited"><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span></p>
|
|
469
|
+
<div id="constructor_details" class="method_details_list">
|
|
470
|
+
<h2>Constructor Details</h2>
|
|
471
|
+
|
|
472
|
+
<div class="method_details first">
|
|
473
|
+
<p class="signature first" id="initialize-instance_method">
|
|
474
|
+
|
|
475
|
+
- (<tt><span class='object_link'><a href="" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span></tt>) <strong>initialize</strong>(frame, options = {})
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
</p><div class="docstring">
|
|
480
|
+
<div class="discussion">
|
|
481
|
+
<p>
|
|
482
|
+
Creates a new bar chart object
|
|
483
|
+
</p>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</div>
|
|
487
|
+
</div>
|
|
488
|
+
<div class="tags">
|
|
489
|
+
<h3>Parameters:</h3>
|
|
490
|
+
<ul class="param">
|
|
491
|
+
|
|
492
|
+
<li>
|
|
493
|
+
|
|
494
|
+
<span class='name'>frame</span>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
—
|
|
502
|
+
<div class='inline'><p>
|
|
503
|
+
The workbook that owns this chart.
|
|
504
|
+
</p>
|
|
505
|
+
</div>
|
|
506
|
+
|
|
507
|
+
</li>
|
|
508
|
+
|
|
509
|
+
<li>
|
|
510
|
+
|
|
511
|
+
<span class='name'>options</span>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
—
|
|
521
|
+
<div class='inline'><p>
|
|
522
|
+
a customizable set of options
|
|
523
|
+
</p>
|
|
524
|
+
</div>
|
|
525
|
+
|
|
526
|
+
</li>
|
|
527
|
+
|
|
528
|
+
</ul>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
<h3>Options Hash (<tt>options</tt>):</h3>
|
|
536
|
+
<ul class="option">
|
|
537
|
+
|
|
538
|
+
<li>
|
|
539
|
+
<span class="name">title</span>
|
|
540
|
+
<span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span>
|
|
541
|
+
<span class="default">
|
|
542
|
+
|
|
543
|
+
</span>
|
|
544
|
+
|
|
545
|
+
</li>
|
|
546
|
+
|
|
547
|
+
<li>
|
|
548
|
+
<span class="name">show_legend</span>
|
|
549
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
550
|
+
<span class="default">
|
|
551
|
+
|
|
552
|
+
</span>
|
|
553
|
+
|
|
554
|
+
</li>
|
|
555
|
+
|
|
556
|
+
<li>
|
|
557
|
+
<span class="name">barDir</span>
|
|
558
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
|
559
|
+
<span class="default">
|
|
560
|
+
|
|
561
|
+
</span>
|
|
562
|
+
|
|
563
|
+
</li>
|
|
564
|
+
|
|
565
|
+
<li>
|
|
566
|
+
<span class="name">grouping</span>
|
|
567
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
|
568
|
+
<span class="default">
|
|
569
|
+
|
|
570
|
+
</span>
|
|
571
|
+
|
|
572
|
+
</li>
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
<span class="name">gapWidth</span>
|
|
576
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
577
|
+
<span class="default">
|
|
578
|
+
|
|
579
|
+
</span>
|
|
580
|
+
|
|
581
|
+
</li>
|
|
582
|
+
|
|
583
|
+
<li>
|
|
584
|
+
<span class="name">gapDepth</span>
|
|
585
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
586
|
+
<span class="default">
|
|
587
|
+
|
|
588
|
+
</span>
|
|
589
|
+
|
|
590
|
+
</li>
|
|
591
|
+
|
|
592
|
+
<li>
|
|
593
|
+
<span class="name">shape</span>
|
|
594
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
|
595
|
+
<span class="default">
|
|
596
|
+
|
|
597
|
+
</span>
|
|
598
|
+
|
|
599
|
+
</li>
|
|
600
|
+
|
|
601
|
+
</ul>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
</div><table class="source_code">
|
|
606
|
+
<tr>
|
|
607
|
+
<td>
|
|
608
|
+
<pre class="lines">
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
79
|
|
612
|
+
80
|
|
613
|
+
81
|
|
614
|
+
82
|
|
615
|
+
83
|
|
616
|
+
84
|
|
617
|
+
85
|
|
618
|
+
86
|
|
619
|
+
87
|
|
620
|
+
88
|
|
621
|
+
89</pre>
|
|
622
|
+
</td>
|
|
623
|
+
<td>
|
|
624
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 79</span>
|
|
625
|
+
|
|
626
|
+
<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
627
|
+
<span class='@barDir ivar id'>@barDir</span> <span class='assign token'>=</span> <span class='symbol val'>:bar</span>
|
|
628
|
+
<span class='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:clustered</span>
|
|
629
|
+
<span class='@catAxId ivar id'>@catAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span>
|
|
630
|
+
<span class='@valAxId ivar id'>@valAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span>
|
|
631
|
+
<span class='@catAxis ivar id'>@catAxis</span> <span class='assign token'>=</span> <span class='CatAxis constant id'>CatAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@catAxId ivar id'>@catAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span>
|
|
632
|
+
<span class='@valAxis ivar id'>@valAxis</span> <span class='assign token'>=</span> <span class='ValAxis constant id'>ValAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@valAxId ivar id'>@valAxId</span><span class='comma token'>,</span> <span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span>
|
|
633
|
+
<span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rAngAx=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span>
|
|
634
|
+
<span class='super super kw'>super</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
|
|
635
|
+
<span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='BarSeries constant id'>BarSeries</span>
|
|
636
|
+
<span class='end end kw'>end</span>
|
|
637
|
+
</pre>
|
|
638
|
+
</td>
|
|
639
|
+
</tr>
|
|
640
|
+
</table>
|
|
641
|
+
</div>
|
|
642
|
+
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
<div id="instance_attr_details" class="attr_details">
|
|
646
|
+
<h2>Instance Attribute Details</h2>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<span id="barDir=-instance_method"></span>
|
|
650
|
+
<span id="barDir-instance_method"></span>
|
|
651
|
+
<div class="method_details first">
|
|
652
|
+
<p class="signature first" id="barDir-instance_method">
|
|
653
|
+
|
|
654
|
+
- (<tt>Symbol</tt>) <strong>barDir</strong>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
</p><div class="docstring">
|
|
659
|
+
<div class="discussion">
|
|
660
|
+
<p>
|
|
661
|
+
The direction of the bars in the chart must be one of [:bar, :col]
|
|
662
|
+
</p>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
</div>
|
|
666
|
+
</div>
|
|
667
|
+
<div class="tags">
|
|
668
|
+
|
|
669
|
+
<h3>Returns:</h3>
|
|
670
|
+
<ul class="return">
|
|
671
|
+
|
|
672
|
+
<li>
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
</li>
|
|
680
|
+
|
|
681
|
+
</ul>
|
|
682
|
+
|
|
683
|
+
</div><table class="source_code">
|
|
684
|
+
<tr>
|
|
685
|
+
<td>
|
|
686
|
+
<pre class="lines">
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
47
|
|
690
|
+
48
|
|
691
|
+
49</pre>
|
|
692
|
+
</td>
|
|
693
|
+
<td>
|
|
694
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 47</span>
|
|
695
|
+
|
|
696
|
+
<span class='def def kw'>def</span> <span class='barDir identifier id'>barDir</span>
|
|
697
|
+
<span class='@barDir ivar id'>@barDir</span>
|
|
698
|
+
<span class='end end kw'>end</span>
|
|
699
|
+
</pre>
|
|
700
|
+
</td>
|
|
701
|
+
</tr>
|
|
702
|
+
</table>
|
|
703
|
+
</div>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
<span id=""></span>
|
|
707
|
+
<span id="catAxis-instance_method"></span>
|
|
708
|
+
<div class="method_details ">
|
|
709
|
+
<p class="signature " id="catAxis-instance_method">
|
|
710
|
+
|
|
711
|
+
- (<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>) <strong>catAxis</strong> <span class="extras">(readonly)</span>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
</p><div class="docstring">
|
|
716
|
+
<div class="discussion">
|
|
717
|
+
<p>
|
|
718
|
+
the category axis
|
|
719
|
+
</p>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
</div>
|
|
723
|
+
</div>
|
|
724
|
+
<div class="tags">
|
|
725
|
+
|
|
726
|
+
<h3>Returns:</h3>
|
|
727
|
+
<ul class="return">
|
|
728
|
+
|
|
729
|
+
<li>
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
<span class='type'>(<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>)</span>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</li>
|
|
737
|
+
|
|
738
|
+
</ul>
|
|
739
|
+
|
|
740
|
+
</div><table class="source_code">
|
|
741
|
+
<tr>
|
|
742
|
+
<td>
|
|
743
|
+
<pre class="lines">
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
38
|
|
747
|
+
39
|
|
748
|
+
40</pre>
|
|
749
|
+
</td>
|
|
750
|
+
<td>
|
|
751
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 38</span>
|
|
752
|
+
|
|
753
|
+
<span class='def def kw'>def</span> <span class='catAxis identifier id'>catAxis</span>
|
|
754
|
+
<span class='@catAxis ivar id'>@catAxis</span>
|
|
755
|
+
<span class='end end kw'>end</span>
|
|
756
|
+
</pre>
|
|
757
|
+
</td>
|
|
758
|
+
</tr>
|
|
759
|
+
</table>
|
|
760
|
+
</div>
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
<span id="gapDepth=-instance_method"></span>
|
|
764
|
+
<span id="gapDepth-instance_method"></span>
|
|
765
|
+
<div class="method_details ">
|
|
766
|
+
<p class="signature " id="gapDepth-instance_method">
|
|
767
|
+
|
|
768
|
+
- (<tt>String</tt>) <strong>gapDepth</strong>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
</p><div class="docstring">
|
|
773
|
+
<div class="discussion">
|
|
774
|
+
<p>
|
|
775
|
+
space between bar or column clusters, as a percentage of the bar or column
|
|
776
|
+
width.
|
|
777
|
+
</p>
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
</div>
|
|
781
|
+
</div>
|
|
782
|
+
<div class="tags">
|
|
783
|
+
|
|
784
|
+
<h3>Returns:</h3>
|
|
785
|
+
<ul class="return">
|
|
786
|
+
|
|
787
|
+
<li>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
</li>
|
|
795
|
+
|
|
796
|
+
</ul>
|
|
797
|
+
|
|
798
|
+
</div><table class="source_code">
|
|
799
|
+
<tr>
|
|
800
|
+
<td>
|
|
801
|
+
<pre class="lines">
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
51
|
|
805
|
+
52
|
|
806
|
+
53</pre>
|
|
807
|
+
</td>
|
|
808
|
+
<td>
|
|
809
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 51</span>
|
|
810
|
+
|
|
811
|
+
<span class='def def kw'>def</span> <span class='gapDepth identifier id'>gapDepth</span>
|
|
812
|
+
<span class='@gapDepth ivar id'>@gapDepth</span>
|
|
813
|
+
<span class='end end kw'>end</span>
|
|
814
|
+
</pre>
|
|
815
|
+
</td>
|
|
816
|
+
</tr>
|
|
817
|
+
</table>
|
|
818
|
+
</div>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
<span id="gapWidth=-instance_method"></span>
|
|
822
|
+
<span id="gapWidth-instance_method"></span>
|
|
823
|
+
<div class="method_details ">
|
|
824
|
+
<p class="signature " id="gapWidth-instance_method">
|
|
825
|
+
|
|
826
|
+
- (<tt>String</tt>) <strong>gapWidth</strong>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
</p><div class="docstring">
|
|
831
|
+
<div class="discussion">
|
|
832
|
+
<p>
|
|
833
|
+
space between bar or column clusters, as a percentage of the bar or column
|
|
834
|
+
width.
|
|
835
|
+
</p>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
</div>
|
|
839
|
+
</div>
|
|
840
|
+
<div class="tags">
|
|
841
|
+
|
|
842
|
+
<h3>Returns:</h3>
|
|
843
|
+
<ul class="return">
|
|
844
|
+
|
|
845
|
+
<li>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
</li>
|
|
853
|
+
|
|
854
|
+
</ul>
|
|
855
|
+
|
|
856
|
+
</div><table class="source_code">
|
|
857
|
+
<tr>
|
|
858
|
+
<td>
|
|
859
|
+
<pre class="lines">
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
55
|
|
863
|
+
56
|
|
864
|
+
57</pre>
|
|
865
|
+
</td>
|
|
866
|
+
<td>
|
|
867
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 55</span>
|
|
868
|
+
|
|
869
|
+
<span class='def def kw'>def</span> <span class='gapWidth identifier id'>gapWidth</span>
|
|
870
|
+
<span class='@gapWidth ivar id'>@gapWidth</span>
|
|
871
|
+
<span class='end end kw'>end</span>
|
|
872
|
+
</pre>
|
|
873
|
+
</td>
|
|
874
|
+
</tr>
|
|
875
|
+
</table>
|
|
876
|
+
</div>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
<span id="grouping=-instance_method"></span>
|
|
880
|
+
<span id="grouping-instance_method"></span>
|
|
881
|
+
<div class="method_details ">
|
|
882
|
+
<p class="signature " id="grouping-instance_method">
|
|
883
|
+
|
|
884
|
+
- (<tt>Symbol</tt>) <strong>grouping</strong>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
</p><div class="docstring">
|
|
889
|
+
<div class="discussion">
|
|
890
|
+
<p>
|
|
891
|
+
grouping for a column, line, or area chart. must be one of
|
|
892
|
+
[:percentStacked, :clustered, :standard, :stacked]
|
|
893
|
+
</p>
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
</div>
|
|
897
|
+
</div>
|
|
898
|
+
<div class="tags">
|
|
899
|
+
|
|
900
|
+
<h3>Returns:</h3>
|
|
901
|
+
<ul class="return">
|
|
902
|
+
|
|
903
|
+
<li>
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
</li>
|
|
911
|
+
|
|
912
|
+
</ul>
|
|
913
|
+
|
|
914
|
+
</div><table class="source_code">
|
|
915
|
+
<tr>
|
|
916
|
+
<td>
|
|
917
|
+
<pre class="lines">
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
60
|
|
921
|
+
61
|
|
922
|
+
62</pre>
|
|
923
|
+
</td>
|
|
924
|
+
<td>
|
|
925
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 60</span>
|
|
926
|
+
|
|
927
|
+
<span class='def def kw'>def</span> <span class='grouping identifier id'>grouping</span>
|
|
928
|
+
<span class='@grouping ivar id'>@grouping</span>
|
|
929
|
+
<span class='end end kw'>end</span>
|
|
930
|
+
</pre>
|
|
931
|
+
</td>
|
|
932
|
+
</tr>
|
|
933
|
+
</table>
|
|
934
|
+
</div>
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
<span id="shape=-instance_method"></span>
|
|
938
|
+
<span id="shape-instance_method"></span>
|
|
939
|
+
<div class="method_details ">
|
|
940
|
+
<p class="signature " id="shape-instance_method">
|
|
941
|
+
|
|
942
|
+
- (<tt>Symbol</tt>) <strong>shape</strong>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
</p><div class="docstring">
|
|
947
|
+
<div class="discussion">
|
|
948
|
+
<p>
|
|
949
|
+
The shabe of the bars or columns must be one of [:percentStacked,
|
|
950
|
+
:clustered, :standard, :stacked]
|
|
951
|
+
</p>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
</div>
|
|
955
|
+
</div>
|
|
956
|
+
<div class="tags">
|
|
957
|
+
|
|
958
|
+
<h3>Returns:</h3>
|
|
959
|
+
<ul class="return">
|
|
960
|
+
|
|
961
|
+
<li>
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
</li>
|
|
969
|
+
|
|
970
|
+
</ul>
|
|
971
|
+
|
|
972
|
+
</div><table class="source_code">
|
|
973
|
+
<tr>
|
|
974
|
+
<td>
|
|
975
|
+
<pre class="lines">
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
65
|
|
979
|
+
66
|
|
980
|
+
67</pre>
|
|
981
|
+
</td>
|
|
982
|
+
<td>
|
|
983
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 65</span>
|
|
984
|
+
|
|
985
|
+
<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span>
|
|
986
|
+
<span class='@shape ivar id'>@shape</span>
|
|
987
|
+
<span class='end end kw'>end</span>
|
|
988
|
+
</pre>
|
|
989
|
+
</td>
|
|
990
|
+
</tr>
|
|
991
|
+
</table>
|
|
992
|
+
</div>
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
<span id=""></span>
|
|
996
|
+
<span id="valAxis-instance_method"></span>
|
|
997
|
+
<div class="method_details ">
|
|
998
|
+
<p class="signature " id="valAxis-instance_method">
|
|
999
|
+
|
|
1000
|
+
- (<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>) <strong>valAxis</strong> <span class="extras">(readonly)</span>
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
</p><div class="docstring">
|
|
1005
|
+
<div class="discussion">
|
|
1006
|
+
<p>
|
|
1007
|
+
the category axis
|
|
1008
|
+
</p>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
</div>
|
|
1012
|
+
</div>
|
|
1013
|
+
<div class="tags">
|
|
1014
|
+
|
|
1015
|
+
<h3>Returns:</h3>
|
|
1016
|
+
<ul class="return">
|
|
1017
|
+
|
|
1018
|
+
<li>
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
<span class='type'>(<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>)</span>
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
</li>
|
|
1026
|
+
|
|
1027
|
+
</ul>
|
|
1028
|
+
|
|
1029
|
+
</div><table class="source_code">
|
|
1030
|
+
<tr>
|
|
1031
|
+
<td>
|
|
1032
|
+
<pre class="lines">
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
42
|
|
1036
|
+
43
|
|
1037
|
+
44</pre>
|
|
1038
|
+
</td>
|
|
1039
|
+
<td>
|
|
1040
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 42</span>
|
|
1041
|
+
|
|
1042
|
+
<span class='def def kw'>def</span> <span class='valAxis identifier id'>valAxis</span>
|
|
1043
|
+
<span class='@valAxis ivar id'>@valAxis</span>
|
|
1044
|
+
<span class='end end kw'>end</span>
|
|
1045
|
+
</pre>
|
|
1046
|
+
</td>
|
|
1047
|
+
</tr>
|
|
1048
|
+
</table>
|
|
1049
|
+
</div>
|
|
1050
|
+
|
|
1051
|
+
</div>
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1055
|
+
<h2>Instance Method Details</h2>
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
<div class="method_details first">
|
|
1059
|
+
<p class="signature first" id="to_xml-instance_method">
|
|
1060
|
+
|
|
1061
|
+
- (<tt>String</tt>) <strong>to_xml</strong>
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
</p><div class="docstring">
|
|
1066
|
+
<div class="discussion">
|
|
1067
|
+
<p>
|
|
1068
|
+
Serializes the bar chart
|
|
1069
|
+
</p>
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
</div>
|
|
1073
|
+
</div>
|
|
1074
|
+
<div class="tags">
|
|
1075
|
+
|
|
1076
|
+
<h3>Returns:</h3>
|
|
1077
|
+
<ul class="return">
|
|
1078
|
+
|
|
1079
|
+
<li>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
</li>
|
|
1087
|
+
|
|
1088
|
+
</ul>
|
|
1089
|
+
|
|
1090
|
+
</div><table class="source_code">
|
|
1091
|
+
<tr>
|
|
1092
|
+
<td>
|
|
1093
|
+
<pre class="lines">
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
119
|
|
1097
|
+
120
|
|
1098
|
+
121
|
|
1099
|
+
122
|
|
1100
|
+
123
|
|
1101
|
+
124
|
|
1102
|
+
125
|
|
1103
|
+
126
|
|
1104
|
+
127
|
|
1105
|
+
128
|
|
1106
|
+
129
|
|
1107
|
+
130
|
|
1108
|
+
131
|
|
1109
|
+
132
|
|
1110
|
+
133
|
|
1111
|
+
134
|
|
1112
|
+
135
|
|
1113
|
+
136</pre>
|
|
1114
|
+
</td>
|
|
1115
|
+
<td>
|
|
1116
|
+
<pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 119</span>
|
|
1117
|
+
|
|
1118
|
+
<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span>
|
|
1119
|
+
<span class='super super kw'>super</span><span class='lparen token'>(</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>
|
|
1120
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:bar3DChart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
|
|
1121
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:barDir'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='barDir identifier id'>barDir</span><span class='rparen token'>)</span>
|
|
1122
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:grouping'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='grouping identifier id'>grouping</span><span class='rparen token'>)</span>
|
|
1123
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span>
|
|
1124
|
+
<span class='@series ivar id'>@series</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='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</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>
|
|
1125
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:gapWidth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapWidth ivar id'>@gapWidth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapWidth ivar id'>@gapWidth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
|
1126
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:gapDepth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapDepth ivar id'>@gapDepth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
|
1127
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@shape ivar id'>@shape</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
|
|
1128
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span>
|
|
1129
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span>
|
|
1130
|
+
<span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span>
|
|
1131
|
+
<span class='rbrace token'>}</span>
|
|
1132
|
+
<span class='@catAxis ivar id'>@catAxis</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>
|
|
1133
|
+
<span class='@valAxis ivar id'>@valAxis</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>
|
|
1134
|
+
<span class='end end kw'>end</span>
|
|
1135
|
+
<span class='end end kw'>end</span>
|
|
1136
|
+
</pre>
|
|
1137
|
+
</td>
|
|
1138
|
+
</tr>
|
|
1139
|
+
</table>
|
|
1140
|
+
</div>
|
|
1141
|
+
|
|
1142
|
+
</div>
|
|
1143
|
+
|
|
1144
|
+
</div>
|
|
1145
|
+
|
|
1146
|
+
<div id="footer">
|
|
1147
|
+
Generated on Tue Nov 22 00:27:48 2011 by
|
|
1148
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1149
|
+
0.7.3 (ruby-1.8.7).
|
|
1150
|
+
</div>
|
|
1151
|
+
|
|
1152
|
+
</body>
|
|
1153
|
+
</html>
|