webapp/resources/datatables-1.9.4/extras/ColVis/media/docs/ColVis.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>Class: ColVis - 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">Class: ColVis</h1>
  24                                         <p class="class-description"><p>ColVis</p></p>
  25                                         <div class="page-info">
  26
  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 (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>
  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                                                 <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">
  56
  57 </dl>
  58 <h5>Parameters:</h5>
  59
  60 <table class="params">
  61     <thead>
  62         <tr>
  63         <th width="20"></th>
  64         <th width="12%" class="bottom_border name">Name</th>
  65                 <th width="10%" class="bottom_border">Type</th>
  66                 <th width="10%" class="bottom_border">Attributes</th>
  67                 <th width="10%" class="bottom_border">Default</th>
  68                 <th class="last bottom_border">Description</th>
  69         </tr>
  70         </thead>
  71
  72         <tbody>
  73         <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>
  74         </tbody>
  75 </table></div>
  76 </dl>
  77                                         </div>
  78
  79
  80                                         <div class="doc_summary">
  81                                                 <a name="summary"></a>
  82                                                 <h2>Summary</h2>
  83
  84                                                 <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
  85
  86 <dl>
  87     <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>
  88 </dl></div><div class="doc_group"><a name="summary_methods"></a><h3 class="subsection-title">Methods - instance</h3>
  89
  90 <dl>
  91     <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>
  92 </dl>
  93 </div><div class="doc_group"><a name="summary_methods_static"></a><h3 class="subsection-title">Methods - static</h3>
  94
  95 <dl>
  96     <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>
  97 </dl>
  98 </div>
  99                                         </div>
 100
 101
 102
 103
 104                                         <div class="doc_details">
 105                                                 <a name="details"></a>
 106                                                 <h2>Details</h2>
 107                                                 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
 108 <dl>
 109     <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">
 110
 111 </dl>
 112 <h5>Properties:</h5>
 113
 114 <table class="params">
 115     <thead>
 116         <tr>
 117         <th width="20"></th>
 118         <th width="12%" class="bottom_border name">Name</th>
 119                 <th width="10%" class="bottom_border">Type</th>
 120                 <th width="10%" class="bottom_border">Attributes</th>
 121                 <th width="10%" class="bottom_border">Default</th>
 122                 <th class="last bottom_border">Description</th>
 123         </tr>
 124         </thead>
 125
 126         <tbody>
 127         <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>
 128         </tbody>
 129 </table></div></dd>
 130 </dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - instance</h3>
 131 <dl>
 132     <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">
 133
 134 </dl>
 135 </div>
 136
 137 </dd>
 138 </div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - static</h3>
 139 <dl>
 140     <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">
 141
 142 </dl>
 143 <h5>Parameters:</h5>
 144
 145 <table class="params">
 146     <thead>
 147         <tr>
 148         <th width="20"></th>
 149         <th width="12%" class="bottom_border name">Name</th>
 150                 <th width="10%" class="bottom_border">Type</th>
 151                 <th width="10%" class="bottom_border">Attributes</th>
 152                 <th width="10%" class="bottom_border">Default</th>
 153                 <th class="last bottom_border">Description</th>
 154         </tr>
 155         </thead>
 156
 157         <tbody>
 158         <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>
 159         </tbody>
 160 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 161
 162 </dd>
 163 </div>
 164                                         </div>
 165
 166                 </div>
 167
 168                 <div class="fw_footer">
 169
 170
 171                         Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
 172                         23th Sep 2012 - 14:27
 173                         with the <a href="http://datatables.net/">DataTables</a> template.
 174                 </div>
 175         </body>
 176 </html>