webapp/resources/datatables-1.9.4/extras/Scroller/media/docs/Scroller.oDefaults.html

   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: oDefaults - 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: oDefaults</h1>
  24                                         <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="Scroller.html">Scroller</a>.</span> » oDefaults</h2>
  25                                         <div class="page-info">
  26                                                 Scroller v1.1.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><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 (6)</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 (6)</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>Scroller default settings for initialisation</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">&lt;static> </span></span><span class="type-name"><a href="#boundaryScale">boundaryScale</a></span><span class="type-sig"><span class="type-signature"> :float</span></span></dt><dd class="  even"><p>Scroller uses the boundary scaling factor to decide when to redraw the table - which it
  70 typically does before you reach the end of the currently loaded data set (in order to
  71 allow the data to look continuous to a user scrolling through the data). If given as 0
  72 then the table will be redrawn whenever the viewport is scrolled, while 1 would not
  73 redraw the table until the currently loaded data has all been shown. You will want
  74 something in the middle - the default factor of 0.5 is usually suitable.</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#displayBuffer">displayBuffer</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>The display buffer is what Scroller uses to calculate how many rows it should pre-fetch
  75 for scrolling. Scroller automatically adjusts DataTables' display length to pre-fetch
  76 rows that will be shown in "near scrolling" (i.e. just beyond the current display area).
  77 The value is based upon the number of rows that can be displayed in the viewport (i.e.
  78 a value of 1), and will apply the display range to records before before and after the
  79 current viewport - i.e. a factor of 3 will allow Scroller to pre-fetch 1 viewport's worth
  80 of rows before the current viewport, the current viewport's rows and 1 viewport's worth
  81 of rows after the current viewport. Adjusting this value can be useful for ensuring
  82 smooth scrolling based on your data set.</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#loadingIndicator">loadingIndicator</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class="  even"><p>Show (or not) the loading element in the background of the table. Note that you should
  83 include the dataTables.scroller.css file for this to be displayed correctly.</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#rowHeight">rowHeight</a></span><span class="type-sig"><span class="type-signature"> :int|string</span></span></dt><dd class="  odd"><p>Scroller will attempt to automatically calculate the height of rows for it's internal
  84 calculations. However the height that is used can be overridden using this parameter.</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#serverWait">serverWait</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>When using server-side processing, Scroller will wait a small amount of time to allow
  85 the scrolling to finish before requesting more data from the server. This prevents
  86 you from DoSing your own server! The wait time can be configured by this parameter.</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#trace">trace</a></span><span class="type-sig"><span class="type-signature"> :bool</span></span></dt><dd class="  odd"><p>Indicate if Scroller show show trace information on the console or not. This can be
  87 useful when debugging Scroller or if just curious as to what it is doing, but should
  88 be turned off for production.</p></dd>
  89 </dl></div>
  90                                         </div>
  91
  92
  93
  94
  95                                         <div class="doc_details">
  96                                                 <a name="details"></a>
  97                                                 <h2>Details</h2>
  98                                                 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
  99 <dl>
 100     <dt class="  even"><a name="boundaryScale"></a><a name="boundaryScale_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#boundaryScale">boundaryScale</a></span><span class="type-sig"><span class="type-signature"> :float</span></span></dt><dd class="  even"><p>Scroller uses the boundary scaling factor to decide when to redraw the table - which it
 101 typically does before you reach the end of the currently loaded data set (in order to
 102 allow the data to look continuous to a user scrolling through the data). If given as 0
 103 then the table will be redrawn whenever the viewport is scrolled, while 1 would not
 104 redraw the table until the currently loaded data has all been shown. You will want
 105 something in the middle - the default factor of 0.5 is usually suitable.</p><div class="collapse_details"><dl class="details">
 106
 107 </dl>
 108 <h5>Example</h5>
 109     <div class="example-code">
 110         <pre class="brush: js">   var oTable = $('#example').dataTable( {
 111        "sScrollY": "200px",
 112        "sDom": "frtiS",
 113        "bDeferRender": true,
 114        "oScroller": {
 115          "boundaryScale": 0.75
 116        }
 117    } );</pre>
 118     </div>
 119 </div></dd><dt class="  odd"><a name="displayBuffer"></a><a name="displayBuffer_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#displayBuffer">displayBuffer</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>The display buffer is what Scroller uses to calculate how many rows it should pre-fetch
 120 for scrolling. Scroller automatically adjusts DataTables' display length to pre-fetch
 121 rows that will be shown in "near scrolling" (i.e. just beyond the current display area).
 122 The value is based upon the number of rows that can be displayed in the viewport (i.e.
 123 a value of 1), and will apply the display range to records before before and after the
 124 current viewport - i.e. a factor of 3 will allow Scroller to pre-fetch 1 viewport's worth
 125 of rows before the current viewport, the current viewport's rows and 1 viewport's worth
 126 of rows after the current viewport. Adjusting this value can be useful for ensuring
 127 smooth scrolling based on your data set.</p><div class="collapse_details"><dl class="details">
 128
 129 </dl>
 130 <h5>Example</h5>
 131     <div class="example-code">
 132         <pre class="brush: js">   var oTable = $('#example').dataTable( {
 133        "sScrollY": "200px",
 134        "sDom": "frtiS",
 135        "bDeferRender": true,
 136        "oScroller": {
 137          "displayBuffer": 10
 138        }
 139    } );</pre>
 140     </div>
 141 </div></dd><dt class="  even"><a name="loadingIndicator"></a><a name="loadingIndicator_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#loadingIndicator">loadingIndicator</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class="  even"><p>Show (or not) the loading element in the background of the table. Note that you should
 142 include the dataTables.scroller.css file for this to be displayed correctly.</p><div class="collapse_details"><dl class="details">
 143
 144 </dl>
 145 <h5>Example</h5>
 146     <div class="example-code">
 147         <pre class="brush: js">   var oTable = $('#example').dataTable( {
 148        "sScrollY": "200px",
 149        "sDom": "frtiS",
 150        "bDeferRender": true,
 151        "oScroller": {
 152          "loadingIndicator": true
 153        }
 154    } );</pre>
 155     </div>
 156 </div></dd><dt class="  odd"><a name="rowHeight"></a><a name="rowHeight_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#rowHeight">rowHeight</a></span><span class="type-sig"><span class="type-signature"> :int|string</span></span></dt><dd class="  odd"><p>Scroller will attempt to automatically calculate the height of rows for it's internal
 157 calculations. However the height that is used can be overridden using this parameter.</p><div class="collapse_details"><dl class="details">
 158
 159 </dl>
 160 <h5>Example</h5>
 161     <div class="example-code">
 162         <pre class="brush: js">   var oTable = $('#example').dataTable( {
 163        "sScrollY": "200px",
 164        "sDom": "frtiS",
 165        "bDeferRender": true,
 166        "oScroller": {
 167          "rowHeight": 30
 168        }
 169    } );</pre>
 170     </div>
 171 </div></dd><dt class="  even"><a name="serverWait"></a><a name="serverWait_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#serverWait">serverWait</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>When using server-side processing, Scroller will wait a small amount of time to allow
 172 the scrolling to finish before requesting more data from the server. This prevents
 173 you from DoSing your own server! The wait time can be configured by this parameter.</p><div class="collapse_details"><dl class="details">
 174
 175 </dl>
 176 <h5>Example</h5>
 177     <div class="example-code">
 178         <pre class="brush: js">   var oTable = $('#example').dataTable( {
 179        "sScrollY": "200px",
 180        "sDom": "frtiS",
 181        "bDeferRender": true,
 182        "oScroller": {
 183          "serverWait": 100
 184        }
 185    } );</pre>
 186     </div>
 187 </div></dd><dt class="  odd"><a name="trace"></a><a name="trace_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#trace">trace</a></span><span class="type-sig"><span class="type-signature"> :bool</span></span></dt><dd class="  odd"><p>Indicate if Scroller show show trace information on the console or not. This can be
 188 useful when debugging Scroller or if just curious as to what it is doing, but should
 189 be turned off for production.</p><div class="collapse_details"><dl class="details">
 190
 191 </dl>
 192 <h5>Example</h5>
 193     <div class="example-code">
 194         <pre class="brush: js">   var oTable = $('#example').dataTable( {
 195        "sScrollY": "200px",
 196        "sDom": "frtiS",
 197        "bDeferRender": true,
 198        "oScroller": {
 199          "trace": true
 200        }
 201    } );</pre>
 202     </div>
 203 </div></dd>
 204 </dl></div>
 205                                         </div>
 206
 207                 </div>
 208
 209                 <div class="fw_footer">
 210                         Scroller: Copyright 2011-2012 Allan Jardine, all rights reserved<br>
 211
 212                         Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
 213                         23th Sep 2012 - 14:28
 214                         with the <a href="http://datatables.net/">DataTables</a> template.
 215                 </div>
 216         </body>
 217 </html>