FixedColumns.defaults.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  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: defaults - documentation</title>
  6. <style type="text/css" media="screen">
  7. @import "media/css/doc.css";
  8. @import "media/css/shCore.css";
  9. @import "media/css/shThemeDataTables.css";
  10. </style>
  11. <script type="text/javascript" src="media/js/shCore.js"></script>
  12. <script type="text/javascript" src="media/js/shBrushJScript.js"></script>
  13. <script type="text/javascript" src="media/js/jquery.js"></script>
  14. <script type="text/javascript" src="media/js/doc.js"></script>
  15. </head>
  16. <body>
  17. <div class="fw_container">
  18. <a name="top"></a>
  19. <div class="fw_header">
  20. <h1 class="page-title">Namespace: defaults</h1>
  21. <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="FixedColumns.html">FixedColumns</a>.</span> » defaults</h2>
  22. <div class="page-info">
  23. FixedColumns v2.0.3 documentation
  24. </div>
  25. </div>
  26. <div class="fw_nav">
  27. <h2>Navigation</h2>
  28. <ul>
  29. <li><a href="#top">Overview</a></li>
  30. <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>
  31. <div style="margin-top: 10px;">
  32. <input type="hidden" name="show_private" value="0">
  33. <span id="private_label">Hiding</span> private elements
  34. (<a id="private_toggle" href="">toggle</a>)
  35. </span>
  36. </div>
  37. <div>
  38. <input type="hidden" name="show_extended" value="1">
  39. <span id="extended_label">Showing</span> extended elements
  40. (<a id="extended_toggle" href="">toggle</a>)
  41. </span>
  42. </div>
  43. </div>
  44. <div class="fw_content">
  45. <a name="overview"></a>
  46. <div class="doc_overview">
  47. <div class="nav_blocker"></div>
  48. <p>FixedColumns default settings for initialisation</p><dl class="details">
  49. </dl>
  50. </div>
  51. <div class="doc_summary">
  52. <a name="summary"></a>
  53. <h2>Summary</h2>
  54. <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
  55. <dl>
  56. <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnDrawCallback">fnDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :function(object, object):void</span></span></dt><dd class=" even"><p>Draw callback function which is called when FixedColumns has redrawn the fixed assets</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iLeftColumns">iLeftColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of left hand columns to fix in position</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iLeftWidth">iLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the left fixed column(s) - note that the behaviour of this
  57. property is directly effected by the sLeftWidth property. If not defined then this property
  58. is calculated automatically from what has been assigned by DataTables.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iRightColumns">iRightColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of right hand columns to fix in position</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iRightWidth">iRightWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the right fixed column(s) - note that the behaviour of this
  59. property is directly effected by the sRightWidth property. If not defined then this property
  60. is calculated automatically from what has been assigned by DataTables.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sHeightMatch">sHeightMatch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Height matching algorthim to use. This can be "none" which will result in no height
  61. matching being applied by FixedColumns (height matching could be forced by CSS in this
  62. case), "semiauto" whereby the height calculation will be performed once, and the result
  63. cached to be used again (fnRecalculateHeight can be used to force recalculation), or
  64. "auto" when height matching is performed on every draw (slowest but must accurate)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sLeftWidth">sLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth
  65. value will be treated as a pixel value, or "relative" for which case iLeftWidth will be
  66. treated as a percentage value.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sRightWidth">sRightWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Type of right column size calculation. Can take the values of "fixed", whereby the
  67. iRightWidth value will be treated as a pixel value, or "relative" for which case
  68. iRightWidth will be treated as a percentage value.</p></dd>
  69. </dl></div>
  70. </div>
  71. <div class="doc_details">
  72. <a name="details"></a>
  73. <h2>Details</h2>
  74. <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
  75. <dl>
  76. <dt class=" even"><a name="fnDrawCallback"></a><a name="fnDrawCallback_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnDrawCallback">fnDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :function(object, object):void</span></span></dt><dd class=" even"><p>Draw callback function which is called when FixedColumns has redrawn the fixed assets</p><div class="collapse_details"><dl class="details">
  77. </dl>
  78. <h5>Example</h5>
  79. <div class="example-code">
  80. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  81. "sScrollX": "100%"
  82. } );
  83. new FixedColumns( oTable, {
  84. "fnDrawCallback": function () {
  85. alert( "FixedColumns redraw" );
  86. }
  87. } );</pre>
  88. </div>
  89. </div></dd><dt class=" odd"><a name="iLeftColumns"></a><a name="iLeftColumns_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iLeftColumns">iLeftColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of left hand columns to fix in position</p><div class="collapse_details"><dl class="details">
  90. </dl>
  91. <h5>Example</h5>
  92. <div class="example-code">
  93. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  94. "sScrollX": "100%"
  95. } );
  96. new FixedColumns( oTable, {
  97. "iLeftColumns": 2
  98. } );</pre>
  99. </div>
  100. </div></dd><dt class=" even"><a name="iLeftWidth"></a><a name="iLeftWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iLeftWidth">iLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the left fixed column(s) - note that the behaviour of this
  101. property is directly effected by the sLeftWidth property. If not defined then this property
  102. is calculated automatically from what has been assigned by DataTables.</p><div class="collapse_details"><dl class="details">
  103. </dl>
  104. <h5>Example</h5>
  105. <div class="example-code">
  106. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  107. "sScrollX": "100%"
  108. } );
  109. new FixedColumns( oTable, {
  110. "iLeftWidth": 100 // pixels
  111. } );</pre>
  112. </div>
  113. </div></dd><dt class=" odd"><a name="iRightColumns"></a><a name="iRightColumns_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iRightColumns">iRightColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of right hand columns to fix in position</p><div class="collapse_details"><dl class="details">
  114. </dl>
  115. <h5>Example</h5>
  116. <div class="example-code">
  117. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  118. "sScrollX": "100%"
  119. } );
  120. new FixedColumns( oTable, {
  121. "iRightColumns": 1
  122. } );</pre>
  123. </div>
  124. </div></dd><dt class=" even"><a name="iRightWidth"></a><a name="iRightWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#iRightWidth">iRightWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the right fixed column(s) - note that the behaviour of this
  125. property is directly effected by the sRightWidth property. If not defined then this property
  126. is calculated automatically from what has been assigned by DataTables.</p><div class="collapse_details"><dl class="details">
  127. </dl>
  128. <h5>Example</h5>
  129. <div class="example-code">
  130. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  131. "sScrollX": "100%"
  132. } );
  133. new FixedColumns( oTable, {
  134. "iRightWidth": 200 // pixels
  135. } );</pre>
  136. </div>
  137. </div></dd><dt class=" odd"><a name="sHeightMatch"></a><a name="sHeightMatch_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sHeightMatch">sHeightMatch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Height matching algorthim to use. This can be "none" which will result in no height
  138. matching being applied by FixedColumns (height matching could be forced by CSS in this
  139. case), "semiauto" whereby the height calculation will be performed once, and the result
  140. cached to be used again (fnRecalculateHeight can be used to force recalculation), or
  141. "auto" when height matching is performed on every draw (slowest but must accurate)</p><div class="collapse_details"><dl class="details">
  142. </dl>
  143. <h5>Example</h5>
  144. <div class="example-code">
  145. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  146. "sScrollX": "100%"
  147. } );
  148. new FixedColumns( oTable, {
  149. "sHeightMatch": "auto"
  150. } );</pre>
  151. </div>
  152. </div></dd><dt class=" even"><a name="sLeftWidth"></a><a name="sLeftWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sLeftWidth">sLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth
  153. value will be treated as a pixel value, or "relative" for which case iLeftWidth will be
  154. treated as a percentage value.</p><div class="collapse_details"><dl class="details">
  155. </dl>
  156. <h5>Example</h5>
  157. <div class="example-code">
  158. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  159. "sScrollX": "100%"
  160. } );
  161. new FixedColumns( oTable, {
  162. "sLeftWidth": "relative",
  163. "iLeftWidth": 10 // percentage
  164. } );</pre>
  165. </div>
  166. </div></dd><dt class=" odd"><a name="sRightWidth"></a><a name="sRightWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sRightWidth">sRightWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Type of right column size calculation. Can take the values of "fixed", whereby the
  167. iRightWidth value will be treated as a pixel value, or "relative" for which case
  168. iRightWidth will be treated as a percentage value.</p><div class="collapse_details"><dl class="details">
  169. </dl>
  170. <h5>Example</h5>
  171. <div class="example-code">
  172. <pre class="brush: js"> var oTable = $('#example').dataTable( {
  173. "sScrollX": "100%"
  174. } );
  175. new FixedColumns( oTable, {
  176. "sRightWidth": "relative",
  177. "iRightWidth": 10 // percentage
  178. } );</pre>
  179. </div>
  180. </div></dd>
  181. </dl></div>
  182. </div>
  183. </div>
  184. <div class="fw_footer">
  185. FixedColumns: Copyright 2010-2011 Allan Jardine, all rights reserved<br>
  186. Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
  187. 23th Sep 2012 - 14:27
  188. with the <a href="http://datatables.net/">DataTables</a> template.
  189. </div>
  190. </body>
  191. </html>