webapp/resources/datatables-1.9.4/extras/ColReorder/media/docs/global.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>Global - 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">Global</h1>
  24
  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><a href="#summary_classes">Classes (1)</a></td><td>Namespaces (0)</td></tr><tr><td><a href="#summary_properties">Properties (2)</a></td><td>Static properties (0)</td></tr><tr><td><a href="#summary_methods">Methods (3)</a></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><a href="#summary_properties">Properties (2)</a></td><td>Static properties (0)</td></tr><tr><td><a href="#summary_methods">Methods (3)</a></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                                                 <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_classes"></a><h3 class="subsection-title">Classes</h3>
  67 <dl>
  68         <dt class="even"><span class="type-name"><a href="ColReorder.html">ColReorder</a></span></dt><dd class="even"><p>ColReorder provides column visiblity control for DataTables</p></dd>
  69 </dl></div><div class="doc_group"><a name="summary_properties"></a><h3 class="subsection-title">Properties - instance</h3>
  70
  71 <dl>
  72     <dt class="  even"><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#CLASS">CLASS</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  even"><p>Name of this class</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#VERSION">VERSION</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  odd"><p>ColReorder version</p></dd>
  73 </dl></div><div class="doc_group"><a name="summary_methods"></a><h3 class="subsection-title">Methods - instance</h3>
  74
  75 <dl>
  76     <dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnArraySwitch">fnArraySwitch</a></span><span class="type-sig"><span class="signature">(array, int, int)</span><span class="type-signature"></span></span></dt><dd class="  even"><p>Modify an array by switching the position of two elements</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnDomSwitch">fnDomSwitch</a></span><span class="type-sig"><span class="signature">(string, int, int)</span><span class="type-signature"></span></span></dt><dd class="  odd"><p>Switch the positions of nodes in a parent node (note this is specifically designed for
  77 table rows). Note this function considers all element nodes under the parent!</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnInvertKeyValues">fnInvertKeyValues</a></span><span class="type-sig"><span class="signature">(array)</span><span class="type-signature"></span></span></dt><dd class="  even"><p>Switch the key value pairing of an index array to be value key (i.e. the old value is now the
  78 key). For example consider [ 2, 0, 1 ] this would be returned as [ 1, 2, 0 ].</p></dd>
  79 </dl>
  80 </div>
  81                                         </div>
  82
  83
  84
  85
  86                                         <div class="doc_details">
  87                                                 <a name="details"></a>
  88                                                 <h2>Details</h2>
  89                                                 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - instance</h3>
  90 <dl>
  91     <dt class="  even"><a name="CLASS"></a><a name="CLASS_details"></a><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#CLASS">CLASS</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  even"><p>Name of this class</p><div class="collapse_details"><dl class="details">
  92
  93 </dl>
  94 </div></dd><dt class="  odd"><a name="VERSION"></a><a name="VERSION_details"></a><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#VERSION">VERSION</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  odd"><p>ColReorder version</p><div class="collapse_details"><dl class="details">
  95
  96 </dl>
  97 </div></dd>
  98 </dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - instance</h3>
  99 <dl>
 100     <dt id="fnArraySwitch" class="  even"><a name="fnArraySwitch"></a><a name="fnArraySwitch_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnArraySwitch</a></span><span class="type-sig"><span class="signature">(array, int, int)</span><span class="type-signature"></span></span></span></dt><dd class="  even"><p>Modify an array by switching the position of two elements</p><div class="collapse_details"><dl class="details">
 101
 102 </dl>
 103 <h5>Parameters:</h5>
 104
 105 <table class="params">
 106     <thead>
 107         <tr>
 108         <th width="20"></th>
 109         <th width="12%" class="bottom_border name">Name</th>
 110                 <th width="10%" class="bottom_border">Type</th>
 111                 <th width="10%" class="bottom_border">Attributes</th>
 112                 <th width="10%" class="bottom_border">Default</th>
 113                 <th class="last bottom_border">Description</th>
 114         </tr>
 115         </thead>
 116
 117         <tbody>
 118         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aArray Array to consider, will be modified by reference (i.e. no return)</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">int</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>iFrom From point</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">int</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>iTo Insert point</p></td></tr>
 119         </tbody>
 120 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 121 <dt id="fnDomSwitch" class="  odd"><a name="fnDomSwitch"></a><a name="fnDomSwitch_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnDomSwitch</a></span><span class="type-sig"><span class="signature">(string, int, int)</span><span class="type-signature"></span></span></span></dt><dd class="  odd"><p>Switch the positions of nodes in a parent node (note this is specifically designed for
 122 table rows). Note this function considers all element nodes under the parent!</p><div class="collapse_details"><dl class="details">
 123
 124 </dl>
 125 <h5>Parameters:</h5>
 126
 127 <table class="params">
 128     <thead>
 129         <tr>
 130         <th width="20"></th>
 131         <th width="12%" class="bottom_border name">Name</th>
 132                 <th width="10%" class="bottom_border">Type</th>
 133                 <th width="10%" class="bottom_border">Attributes</th>
 134                 <th width="10%" class="bottom_border">Default</th>
 135                 <th class="last bottom_border">Description</th>
 136         </tr>
 137         </thead>
 138
 139         <tbody>
 140         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">string</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>sTag Tag to consider</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">int</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>iFrom Element to move</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">int</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Point to element the element to (before this point), can be null for append</p></td></tr>
 141         </tbody>
 142 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 143 <dt id="fnInvertKeyValues" class="  even"><a name="fnInvertKeyValues"></a><a name="fnInvertKeyValues_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnInvertKeyValues</a></span><span class="type-sig"><span class="signature">(array)</span><span class="type-signature"></span></span></span></dt><dd class="  even"><p>Switch the key value pairing of an index array to be value key (i.e. the old value is now the
 144 key). For example consider [ 2, 0, 1 ] this would be returned as [ 1, 2, 0 ].</p><div class="collapse_details"><dl class="details">
 145
 146 </dl>
 147 <h5>Parameters:</h5>
 148
 149 <table class="params">
 150     <thead>
 151         <tr>
 152         <th width="20"></th>
 153         <th width="12%" class="bottom_border name">Name</th>
 154                 <th width="10%" class="bottom_border">Type</th>
 155                 <th width="10%" class="bottom_border">Attributes</th>
 156                 <th width="10%" class="bottom_border">Default</th>
 157                 <th class="last bottom_border">Description</th>
 158         </tr>
 159         </thead>
 160
 161         <tbody>
 162         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aIn Array to switch around</p></td></tr>
 163         </tbody>
 164 </table><h5>Returns:</h5><p class="returns"><p>array</p></p></div>
 165
 166 </dd>
 167 </div>
 168                                         </div>
 169
 170                 </div>
 171
 172                 <div class="fw_footer">
 173
 174
 175                         Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
 176                         23th Sep 2012 - 14:28
 177                         with the <a href="http://datatables.net/">DataTables</a> template.
 178                 </div>
 179         </body>
 180 </html>