| 2629 |
vikas |
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
|
2 |
<html>
|
|
|
3 |
<head>
|
|
|
4 |
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
|
|
|
5 |
<title>Global - documentation</title>
|
|
|
6 |
|
|
|
7 |
<style type="text/css" media="screen">
|
|
|
8 |
@import "media/css/doc.css";
|
|
|
9 |
@import "media/css/shCore.css";
|
|
|
10 |
@import "media/css/shThemeDataTables.css";
|
|
|
11 |
</style>
|
|
|
12 |
|
|
|
13 |
<script type="text/javascript" src="media/js/shCore.js"></script>
|
|
|
14 |
<script type="text/javascript" src="media/js/shBrushJScript.js"></script>
|
|
|
15 |
<script type="text/javascript" src="media/js/jquery.js"></script>
|
|
|
16 |
<script type="text/javascript" src="media/js/doc.js"></script>
|
|
|
17 |
</head>
|
|
|
18 |
<body>
|
|
|
19 |
<div class="fw_container">
|
|
|
20 |
|
|
|
21 |
<a name="top"></a>
|
|
|
22 |
<div class="fw_header">
|
|
|
23 |
<h1 class="page-title">Global</h1>
|
|
|
24 |
|
|
|
25 |
<div class="page-info">
|
|
|
26 |
Scroller v1.0.0 documentation
|
|
|
27 |
</div>
|
|
|
28 |
</div>
|
|
|
29 |
|
|
|
30 |
|
|
|
31 |
|
|
|
32 |
<div class="fw_nav">
|
|
|
33 |
<h2>Navigation</h2>
|
|
|
34 |
<ul>
|
|
|
35 |
<li><a href="#top">Overview</a></li>
|
|
|
36 |
<li><a href="#summary">Summary</a><div><a href="#summary_properties">Properties</a></div></li><li><a href="#details">Details</a><div><a href="#details_properties">Properties</a></div></li></ul>
|
|
|
37 |
<div style="margin-top: 10px;">
|
|
|
38 |
<input type="hidden" name="show_private" value="0">
|
|
|
39 |
<span id="private_label">Hiding</span> private elements
|
|
|
40 |
(<a id="private_toggle" href="">toggle</a>)
|
|
|
41 |
</span>
|
|
|
42 |
</div>
|
|
|
43 |
<div>
|
|
|
44 |
<input type="hidden" name="show_extended" value="1">
|
|
|
45 |
<span id="extended_label">Showing</span> extended elements
|
|
|
46 |
(<a id="extended_toggle" href="">toggle</a>)
|
|
|
47 |
</span>
|
|
|
48 |
</div>
|
|
|
49 |
</div>
|
|
|
50 |
|
|
|
51 |
<div class="fw_content">
|
|
|
52 |
<a name="overview"></a>
|
|
|
53 |
<div class="doc_overview">
|
|
|
54 |
<div class="nav_blocker"></div>
|
|
|
55 |
<dl class="details">
|
|
|
56 |
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
|
|
|
62 |
|
|
|
63 |
|
|
|
64 |
|
|
|
65 |
|
|
|
66 |
|
|
|
67 |
|
|
|
68 |
|
|
|
69 |
</dl>
|
|
|
70 |
</div>
|
|
|
71 |
|
|
|
72 |
<div class="doc_summary">
|
|
|
73 |
<a name="summary"></a>
|
|
|
74 |
<h2>Summary</h2>
|
|
|
75 |
|
|
|
76 |
<div class="doc_group"><a name="summary_properties"></a><h3 class="subsection-title">Properties</h3>
|
|
|
77 |
|
|
|
78 |
<dl>
|
|
|
79 |
<dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#drawTO_details">drawTO</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even">setTimeout reference for the redraw, used when server-side processing is enabled in the
|
|
|
80 |
DataTables in order to prevent DoSing the server</dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#dt_details">dt</a></span><span class="type-sig"> :<span class="type-signature">object</span></span></dt><dd class=" odd">DataTables settings object</dd><dt class="private even"><span class="type-attr"><private> </span><span class="type-name"><a href="#redrawBottom_details">redrawBottom</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class="private even">Pixel location of the boundary for when the next data set should be loaded and drawn
|
|
|
81 |
when scrolling down the way. Note that this is actually caluated as the offset from
|
|
|
82 |
the top.</dd><dt class="private odd"><span class="type-attr"><private> </span><span class="type-name"><a href="#redrawTop_details">redrawTop</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class="private odd">Pixel location of the boundary for when the next data set should be loaded and drawn
|
|
|
83 |
when scrolling up the way.</dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#rowHeight_details">rowHeight</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even">Height of rows in the table</dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#stateTO_details">stateTO</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" odd">setTimeout reference for state saving, used when state saving is enabled in the DataTable
|
|
|
84 |
and when the user scrolls the viewport in order to stop the cookie set taking too much
|
|
|
85 |
CPU!</dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#tableBottom_details">tableBottom</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even">Pixel location of the bottom of the drawn table in the viewport</dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#tableTop_details">tableTop</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" odd">Pixel location of the top of the drawn table in the viewport</dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#viewportHeight_details">viewportHeight</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even">Pixel height of the viewport</dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#viewportRows_details">viewportRows</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" odd">Number of rows calculated as visible in the visible viewport</dd>
|
|
|
86 |
</dl></div>
|
|
|
87 |
</div>
|
|
|
88 |
|
|
|
89 |
|
|
|
90 |
<div class="doc_details">
|
|
|
91 |
<a name="details"></a>
|
|
|
92 |
<h2>Details</h2>
|
|
|
93 |
<div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties</h3>
|
|
|
94 |
<dl>
|
|
|
95 |
<dt class=" even"><a name="drawTO_details"></a><span class="type-attr"></span><span class="type-name"><a href="#drawTO_details">drawTO</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even"><p class="description">setTimeout reference for the redraw, used when server-side processing is enabled in the
|
|
|
96 |
DataTables in order to prevent DoSing the server</p><dl class="details">
|
|
|
97 |
|
|
|
98 |
|
|
|
99 |
|
|
|
100 |
|
|
|
101 |
|
|
|
102 |
|
|
|
103 |
|
|
|
104 |
|
|
|
105 |
|
|
|
106 |
|
|
|
107 |
|
|
|
108 |
|
|
|
109 |
|
|
|
110 |
</dl></dd><dt class=" odd"><a name="dt_details"></a><span class="type-attr"></span><span class="type-name"><a href="#dt_details">dt</a></span><span class="type-sig"> :<span class="type-signature">object</span></span></dt><dd class=" odd"><p class="description">DataTables settings object</p><dl class="details">
|
|
|
111 |
|
|
|
112 |
|
|
|
113 |
|
|
|
114 |
|
|
|
115 |
|
|
|
116 |
|
|
|
117 |
|
|
|
118 |
|
|
|
119 |
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
|
|
|
123 |
|
|
|
124 |
</dl></dd><dt class="private even"><a name="redrawBottom_details"></a><span class="type-attr"><private> </span><span class="type-name"><a href="#redrawBottom_details">redrawBottom</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class="private even"><p class="description">Pixel location of the boundary for when the next data set should be loaded and drawn
|
|
|
125 |
when scrolling down the way. Note that this is actually caluated as the offset from
|
|
|
126 |
the top.</p><dl class="details">
|
|
|
127 |
|
|
|
128 |
|
|
|
129 |
|
|
|
130 |
|
|
|
131 |
|
|
|
132 |
|
|
|
133 |
|
|
|
134 |
|
|
|
135 |
|
|
|
136 |
|
|
|
137 |
|
|
|
138 |
|
|
|
139 |
|
|
|
140 |
</dl></dd><dt class="private odd"><a name="redrawTop_details"></a><span class="type-attr"><private> </span><span class="type-name"><a href="#redrawTop_details">redrawTop</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class="private odd"><p class="description">Pixel location of the boundary for when the next data set should be loaded and drawn
|
|
|
141 |
when scrolling up the way.</p><dl class="details">
|
|
|
142 |
|
|
|
143 |
|
|
|
144 |
|
|
|
145 |
|
|
|
146 |
|
|
|
147 |
|
|
|
148 |
|
|
|
149 |
|
|
|
150 |
|
|
|
151 |
|
|
|
152 |
|
|
|
153 |
|
|
|
154 |
|
|
|
155 |
</dl></dd><dt class=" even"><a name="rowHeight_details"></a><span class="type-attr"></span><span class="type-name"><a href="#rowHeight_details">rowHeight</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even"><p class="description">Height of rows in the table</p><dl class="details">
|
|
|
156 |
|
|
|
157 |
|
|
|
158 |
|
|
|
159 |
|
|
|
160 |
|
|
|
161 |
|
|
|
162 |
|
|
|
163 |
|
|
|
164 |
|
|
|
165 |
|
|
|
166 |
|
|
|
167 |
|
|
|
168 |
|
|
|
169 |
</dl></dd><dt class=" odd"><a name="stateTO_details"></a><span class="type-attr"></span><span class="type-name"><a href="#stateTO_details">stateTO</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" odd"><p class="description">setTimeout reference for state saving, used when state saving is enabled in the DataTable
|
|
|
170 |
and when the user scrolls the viewport in order to stop the cookie set taking too much
|
|
|
171 |
CPU!</p><dl class="details">
|
|
|
172 |
|
|
|
173 |
|
|
|
174 |
|
|
|
175 |
|
|
|
176 |
|
|
|
177 |
|
|
|
178 |
|
|
|
179 |
|
|
|
180 |
|
|
|
181 |
|
|
|
182 |
|
|
|
183 |
|
|
|
184 |
|
|
|
185 |
</dl></dd><dt class=" even"><a name="tableBottom_details"></a><span class="type-attr"></span><span class="type-name"><a href="#tableBottom_details">tableBottom</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even"><p class="description">Pixel location of the bottom of the drawn table in the viewport</p><dl class="details">
|
|
|
186 |
|
|
|
187 |
|
|
|
188 |
|
|
|
189 |
|
|
|
190 |
|
|
|
191 |
|
|
|
192 |
|
|
|
193 |
|
|
|
194 |
|
|
|
195 |
|
|
|
196 |
|
|
|
197 |
|
|
|
198 |
|
|
|
199 |
</dl></dd><dt class=" odd"><a name="tableTop_details"></a><span class="type-attr"></span><span class="type-name"><a href="#tableTop_details">tableTop</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" odd"><p class="description">Pixel location of the top of the drawn table in the viewport</p><dl class="details">
|
|
|
200 |
|
|
|
201 |
|
|
|
202 |
|
|
|
203 |
|
|
|
204 |
|
|
|
205 |
|
|
|
206 |
|
|
|
207 |
|
|
|
208 |
|
|
|
209 |
|
|
|
210 |
|
|
|
211 |
|
|
|
212 |
|
|
|
213 |
</dl></dd><dt class=" even"><a name="viewportHeight_details"></a><span class="type-attr"></span><span class="type-name"><a href="#viewportHeight_details">viewportHeight</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" even"><p class="description">Pixel height of the viewport</p><dl class="details">
|
|
|
214 |
|
|
|
215 |
|
|
|
216 |
|
|
|
217 |
|
|
|
218 |
|
|
|
219 |
|
|
|
220 |
|
|
|
221 |
|
|
|
222 |
|
|
|
223 |
|
|
|
224 |
|
|
|
225 |
|
|
|
226 |
|
|
|
227 |
</dl></dd><dt class=" odd"><a name="viewportRows_details"></a><span class="type-attr"></span><span class="type-name"><a href="#viewportRows_details">viewportRows</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" odd"><p class="description">Number of rows calculated as visible in the visible viewport</p><dl class="details">
|
|
|
228 |
|
|
|
229 |
|
|
|
230 |
|
|
|
231 |
|
|
|
232 |
|
|
|
233 |
|
|
|
234 |
|
|
|
235 |
|
|
|
236 |
|
|
|
237 |
|
|
|
238 |
|
|
|
239 |
|
|
|
240 |
|
|
|
241 |
</dl></dd>
|
|
|
242 |
</dl></div>
|
|
|
243 |
</div>
|
|
|
244 |
</div>
|
|
|
245 |
|
|
|
246 |
</div>
|
|
|
247 |
|
|
|
248 |
<div class="fw_footer">
|
|
|
249 |
Scroller: Copyright 2011 Allan Jardine, all rights reserved<br>
|
|
|
250 |
|
|
|
251 |
Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
|
|
|
252 |
26th Jun 2011 - 09:41
|
|
|
253 |
with the <a href="http://datatables.net/">DataTables</a> template.
|
|
|
254 |
</div>
|
|
|
255 |
</body>
|
|
|
256 |
</html>
|