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>Namespace: oScroll - 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">Namespace: oScroll</h1> |
24 |
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a> » <a href="DataTable.models.oSettings.html">.oSettings</a>.</span> » oScroll</h2> |
25 |
<div class="page-info"> |
26 |
DataTables v1.9.4 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><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Classes (0)</td><td>Namespaces (0)</td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (8)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li><li><a href="#details">Details</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (8)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></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 |
<p>Scrolling settings for a table.</p><dl class="details"> |
56 |
|
57 |
</dl> |
58 |
|
59 |
</div> |
60 |
|
61 |
|
62 |
<div class="doc_summary"> |
63 |
<a name="summary"></a> |
64 |
<h2>Summary</h2> |
65 |
|
66 |
<div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3> |
67 |
|
68 |
<dl> |
69 |
<dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAutoCss">bAutoCss</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if DataTables should be allowed to set the padding / margin |
70 |
etc for the scrolling header elements or not. Typically you will want |
71 |
this. |
72 |
Note that this parameter will be set by the initialisation routine. To |
73 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bCollapse">bCollapse</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>When the table is shorter in height than sScrollY, collapse the |
74 |
table container down to the height of the table (when true). |
75 |
Note that this parameter will be set by the initialisation routine. To |
76 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInfinite">bInfinite</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Infinite scrolling enablement flag. Now deprecated in favour of |
77 |
using the Scroller plug-in. |
78 |
Note that this parameter will be set by the initialisation routine. To |
79 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iBarWidth">iBarWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Width of the scrollbar for the web-browser's platform. Calculated |
80 |
during table initialisation.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLoadGap">iLoadGap</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Space (in pixels) between the bottom of the scrolling container and |
81 |
the bottom of the scrolling viewport before the next page is loaded |
82 |
when using infinite scrolling. |
83 |
Note that this parameter will be set by the initialisation routine. To |
84 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sX">sX</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport width for horizontal scrolling. Horizontal scrolling is |
85 |
disabled if an empty string. |
86 |
Note that this parameter will be set by the initialisation routine. To |
87 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sXInner">sXInner</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width to expand the table to when using x-scrolling. Typically you |
88 |
should not need to use this. |
89 |
Note that this parameter will be set by the initialisation routine. To |
90 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sY">sY</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport height for vertical scrolling. Vertical scrolling is disabled |
91 |
if an empty string. |
92 |
Note that this parameter will be set by the initialisation routine. To |
93 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd> |
94 |
</dl></div> |
95 |
</div> |
96 |
|
97 |
|
98 |
|
99 |
|
100 |
<div class="doc_details"> |
101 |
<a name="details"></a> |
102 |
<h2>Details</h2> |
103 |
<div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3> |
104 |
<dl> |
105 |
<dt class=" even"><a name="bAutoCss"></a><a name="bAutoCss_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAutoCss">bAutoCss</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if DataTables should be allowed to set the padding / margin |
106 |
etc for the scrolling header elements or not. Typically you will want |
107 |
this. |
108 |
Note that this parameter will be set by the initialisation routine. To |
109 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
110 |
|
111 |
</dl> |
112 |
</div></dd><dt class=" odd"><a name="bCollapse"></a><a name="bCollapse_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bCollapse">bCollapse</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>When the table is shorter in height than sScrollY, collapse the |
113 |
table container down to the height of the table (when true). |
114 |
Note that this parameter will be set by the initialisation routine. To |
115 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
116 |
|
117 |
</dl> |
118 |
</div></dd><dt class=" even"><a name="bInfinite"></a><a name="bInfinite_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInfinite">bInfinite</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Infinite scrolling enablement flag. Now deprecated in favour of |
119 |
using the Scroller plug-in. |
120 |
Note that this parameter will be set by the initialisation routine. To |
121 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
122 |
|
123 |
</dl> |
124 |
</div></dd><dt class=" odd"><a name="iBarWidth"></a><a name="iBarWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iBarWidth">iBarWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Width of the scrollbar for the web-browser's platform. Calculated |
125 |
during table initialisation.</p><div class="collapse_details"><dl class="details"> |
126 |
|
127 |
</dl> |
128 |
</div></dd><dt class=" even"><a name="iLoadGap"></a><a name="iLoadGap_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLoadGap">iLoadGap</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Space (in pixels) between the bottom of the scrolling container and |
129 |
the bottom of the scrolling viewport before the next page is loaded |
130 |
when using infinite scrolling. |
131 |
Note that this parameter will be set by the initialisation routine. To |
132 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
133 |
|
134 |
</dl> |
135 |
</div></dd><dt class=" odd"><a name="sX"></a><a name="sX_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sX">sX</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport width for horizontal scrolling. Horizontal scrolling is |
136 |
disabled if an empty string. |
137 |
Note that this parameter will be set by the initialisation routine. To |
138 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
139 |
|
140 |
</dl> |
141 |
</div></dd><dt class=" even"><a name="sXInner"></a><a name="sXInner_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sXInner">sXInner</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width to expand the table to when using x-scrolling. Typically you |
142 |
should not need to use this. |
143 |
Note that this parameter will be set by the initialisation routine. To |
144 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
145 |
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd> |
146 |
</dl> |
147 |
</div></dd><dt class=" odd"><a name="sY"></a><a name="sY_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sY">sY</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport height for vertical scrolling. Vertical scrolling is disabled |
148 |
if an empty string. |
149 |
Note that this parameter will be set by the initialisation routine. To |
150 |
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
151 |
|
152 |
</dl> |
153 |
</div></dd> |
154 |
</dl></div> |
155 |
</div> |
156 |
|
157 |
</div> |
158 |
|
159 |
<div class="fw_footer"> |
160 |
DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br> |
161 |
|
162 |
Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on |
163 |
23th Sep 2012 - 14:27 |
164 |
with the <a href="http://datatables.net/">DataTables</a> template. |
165 |
</div> |
166 |
</body> |
167 |
</html> |