ColVis.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  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>Class: ColVis - 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">Class: ColVis</h1>
  21. <p class="class-description"><p>ColVis</p></p>
  22. <div class="page-info">
  23. </div>
  24. </div>
  25. <div class="fw_nav">
  26. <h2>Navigation</h2>
  27. <ul>
  28. <li><a href="#top">Overview</a></li>
  29. <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 (1)</a></td></tr><tr><td><a href="#summary_methods">Methods (1)</a></td><td><a href="#summary_methods_static">Static methods (1)</a></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 (1)</a></td></tr><tr><td><a href="#summary_methods">Methods (1)</a></td><td><a href="#summary_methods_static">Static methods (1)</a></td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li></ul>
  30. <div style="margin-top: 10px;">
  31. <input type="hidden" name="show_private" value="0">
  32. <span id="private_label">Hiding</span> private elements
  33. (<a id="private_toggle" href="">toggle</a>)
  34. </span>
  35. </div>
  36. <div>
  37. <input type="hidden" name="show_extended" value="1">
  38. <span id="extended_label">Showing</span> extended elements
  39. (<a id="extended_toggle" href="">toggle</a>)
  40. </span>
  41. </div>
  42. </div>
  43. <div class="fw_content">
  44. <a name="overview"></a>
  45. <div class="doc_overview">
  46. <div class="nav_blocker"></div>
  47. <dl><dt id="ColVis" class=" even"><a name="ColVis"></a><a name="ColVis_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>new ColVis</a></span><span class="type-sig"><span class="signature">(DataTables)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>ColVis provides column visiblity control for DataTables</p><div class="collapse_details"><h3>Constructor</h3><dl class="details">
  48. </dl>
  49. <h5>Parameters:</h5>
  50. <table class="params">
  51. <thead>
  52. <tr>
  53. <th width="20"></th>
  54. <th width="12%" class="bottom_border name">Name</th>
  55. <th width="10%" class="bottom_border">Type</th>
  56. <th width="10%" class="bottom_border">Attributes</th>
  57. <th width="10%" class="bottom_border">Default</th>
  58. <th class="last bottom_border">Description</th>
  59. </tr>
  60. </thead>
  61. <tbody>
  62. <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">DataTables</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>settings object</p></td></tr>
  63. </tbody>
  64. </table></div>
  65. </dl>
  66. </div>
  67. <div class="doc_summary">
  68. <a name="summary"></a>
  69. <h2>Summary</h2>
  70. <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
  71. <dl>
  72. <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#aInstances">aInstances</a></span><span class="type-sig"><span class="type-signature"> :Array</span></span></dt><dd class=" even"><p>Collection of all ColVis instances</p></dd>
  73. </dl></div><div class="doc_group"><a name="summary_methods"></a><h3 class="subsection-title">Methods - instance</h3>
  74. <dl>
  75. <dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnAdjustOpenRows">_fnAdjustOpenRows</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Alter the colspan on any fnOpen rows</p></dd>
  76. </dl>
  77. </div><div class="doc_group"><a name="summary_methods_static"></a><h3 class="subsection-title">Methods - static</h3>
  78. <dl>
  79. <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnRebuild">fnRebuild</a></span><span class="type-sig"><span class="signature">(object)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Rebuild the collection for a given table, or all tables if no parameter given</p></dd>
  80. </dl>
  81. </div>
  82. </div>
  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="aInstances"></a><a name="aInstances_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#aInstances">aInstances</a></span><span class="type-sig"><span class="type-signature"> :Array</span></span></dt><dd class=" even"><p>Collection of all ColVis instances</p><div class="collapse_details"><dl class="details">
  89. </dl>
  90. <h5>Properties:</h5>
  91. <table class="params">
  92. <thead>
  93. <tr>
  94. <th width="20"></th>
  95. <th width="12%" class="bottom_border name">Name</th>
  96. <th width="10%" class="bottom_border">Type</th>
  97. <th width="10%" class="bottom_border">Attributes</th>
  98. <th width="10%" class="bottom_border">Default</th>
  99. <th class="last bottom_border">Description</th>
  100. </tr>
  101. </thead>
  102. <tbody>
  103. <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">ColVis.aInstances</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"></td></tr>
  104. </tbody>
  105. </table></div></dd>
  106. </dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - instance</h3>
  107. <dl>
  108. <dt id="ColVis#_fnAdjustOpenRows" class=" even"><a name="_fnAdjustOpenRows"></a><a name="_fnAdjustOpenRows_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnAdjustOpenRows</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Alter the colspan on any fnOpen rows</p><div class="collapse_details"><dl class="details">
  109. </dl>
  110. </div>
  111. </dd>
  112. </div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - static</h3>
  113. <dl>
  114. <dt id="ColVis.fnRebuild" class=" even"><a name="fnRebuild"></a><a name="fnRebuild_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnRebuild</a></span><span class="type-sig"><span class="signature">(object)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Rebuild the collection for a given table, or all tables if no parameter given</p><div class="collapse_details"><dl class="details">
  115. </dl>
  116. <h5>Parameters:</h5>
  117. <table class="params">
  118. <thead>
  119. <tr>
  120. <th width="20"></th>
  121. <th width="12%" class="bottom_border name">Name</th>
  122. <th width="10%" class="bottom_border">Type</th>
  123. <th width="10%" class="bottom_border">Attributes</th>
  124. <th width="10%" class="bottom_border">Default</th>
  125. <th class="last bottom_border">Description</th>
  126. </tr>
  127. </thead>
  128. <tbody>
  129. <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">object</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>oTable DataTable instance to consider - optional</p></td></tr>
  130. </tbody>
  131. </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
  132. </dd>
  133. </div>
  134. </div>
  135. </div>
  136. <div class="fw_footer">
  137. Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
  138. 23th Sep 2012 - 14:27
  139. with the <a href="http://datatables.net/">DataTables</a> template.
  140. </div>
  141. </body>
  142. </html>