webapp/resources/datatables-1.9.4/extras/Scroller/media/docs/baed189d4a.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: s - 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: s</h1>
  24                                         <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="Scroller.html">Scroller</a>#</span> » s</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 (9)</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 (9)</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>Settings object which contains customisable information for the Scroller instance</p><dl class="details">
  56
  57 </dl>
  58 <h3 class="subsection-title">Extends</h3>
  59 <ul>
  60         <li>Scroller.DEFAULTS</li>
  61 </ul>
  62
  63                                         </div>
  64
  65
  66                                         <div class="doc_summary">
  67                                                 <a name="summary"></a>
  68                                                 <h2>Summary</h2>
  69
  70                                                 <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
  71
  72 <dl>
  73     <dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#autoHeight">autoHeight</a></span><span class="type-sig"><span class="type-signature"> :bool</span></span></dt><dd class="  even"><p>Auto row height or not indicator</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#drawTO">drawTO</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>setTimeout reference for the redraw, used when server-side processing is enabled in the
  74 DataTables in order to prevent DoSing the server</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#dt">dt</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class="  even"><p>DataTables settings object</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</span></span></dt><dd class="  odd"><p>Height of rows in the table</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#stateTO">stateTO</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>setTimeout reference for state saving, used when state saving is enabled in the DataTable
  75 and when the user scrolls the viewport in order to stop the cookie set taking too much
  76 CPU!</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#tableBottom">tableBottom</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>Pixel location of the bottom of the drawn table in the viewport</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#tableTop">tableTop</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>Pixel location of the top of the drawn table in the viewport</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#viewportHeight">viewportHeight</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>Pixel height of the viewport</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#viewportRows">viewportRows</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>Number of rows calculated as visible in the visible viewport</p></dd>
  77 </dl></div>
  78                                         </div>
  79
  80
  81
  82
  83                                         <div class="doc_details">
  84                                                 <a name="details"></a>
  85                                                 <h2>Details</h2>
  86                                                 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
  87 <dl>
  88     <dt class="  even"><a name="autoHeight"></a><a name="autoHeight_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#autoHeight">autoHeight</a></span><span class="type-sig"><span class="type-signature"> :bool</span></span></dt><dd class="  even"><p>Auto row height or not indicator</p><div class="collapse_details"><dl class="details">
  89
  90 </dl>
  91 </div></dd><dt class="  odd"><a name="drawTO"></a><a name="drawTO_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#drawTO">drawTO</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>setTimeout reference for the redraw, used when server-side processing is enabled in the
  92 DataTables in order to prevent DoSing the server</p><div class="collapse_details"><dl class="details">
  93
  94 </dl>
  95 </div></dd><dt class="  even"><a name="dt"></a><a name="dt_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#dt">dt</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class="  even"><p>DataTables settings object</p><div class="collapse_details"><dl class="details">
  96
  97 </dl>
  98 </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</span></span></dt><dd class="  odd"><p>Height of rows in the table</p><div class="collapse_details"><dl class="details">
  99
 100 </dl>
 101 </div></dd><dt class="  even"><a name="stateTO"></a><a name="stateTO_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#stateTO">stateTO</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>setTimeout reference for state saving, used when state saving is enabled in the DataTable
 102 and when the user scrolls the viewport in order to stop the cookie set taking too much
 103 CPU!</p><div class="collapse_details"><dl class="details">
 104
 105 </dl>
 106 </div></dd><dt class="  odd"><a name="tableBottom"></a><a name="tableBottom_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#tableBottom">tableBottom</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>Pixel location of the bottom of the drawn table in the viewport</p><div class="collapse_details"><dl class="details">
 107
 108 </dl>
 109 </div></dd><dt class="  even"><a name="tableTop"></a><a name="tableTop_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#tableTop">tableTop</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>Pixel location of the top of the drawn table in the viewport</p><div class="collapse_details"><dl class="details">
 110
 111 </dl>
 112 </div></dd><dt class="  odd"><a name="viewportHeight"></a><a name="viewportHeight_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#viewportHeight">viewportHeight</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  odd"><p>Pixel height of the viewport</p><div class="collapse_details"><dl class="details">
 113
 114 </dl>
 115 </div></dd><dt class="  even"><a name="viewportRows"></a><a name="viewportRows_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#viewportRows">viewportRows</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class="  even"><p>Number of rows calculated as visible in the visible viewport</p><div class="collapse_details"><dl class="details">
 116
 117 </dl>
 118 </div></dd>
 119 </dl></div>
 120                                         </div>
 121
 122                 </div>
 123
 124                 <div class="fw_footer">
 125                         Scroller: Copyright 2011-2012 Allan Jardine, all rights reserved<br>
 126
 127                         Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
 128                         23th Sep 2012 - 14:28
 129                         with the <a href="http://datatables.net/">DataTables</a> template.
 130                 </div>
 131         </body>
 132 </html>