crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/packages/jquery/plugins/DataTables/extras/ColVis/media/docs/symbols/ColVis.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3         <head>
   4                 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   5                 <meta name="generator" content="JsDoc Toolkit" />
   6
   7                 <title>JsDoc Reference - ColVis</title>
   8                 <link href="../css/default.css" type="text/css" rel="stylesheet" media="all" />
   9         </head>
  10
  11         <body>
  12                 <div id="header">
  13 </div>
  14
  15                 <div class="index">
  16                         <div class="menu">
  17                                 <!-- begin publish.classesIndex -->
  18                                 <div align="center"><a href="../index.html">Class Index</a> | <a href="../files.html">File Index</a></div>
  19
  20 <h2 class="heading1">Classes</h2>
  21
  22 <ul class="classList">
  23
  24                 <li><a href="../symbols/_global_.html">_global_</a></li>
  25
  26                 <li><a href="../symbols/ColVis.html">ColVis</a></li>
  27
  28                 <li><a href="../symbols/ColVis%23dom.html">ColVis#dom</a></li>
  29
  30                 <li><a href="../symbols/ColVis%23s.html">ColVis#s</a></li>
  31
  32 </ul>
  33
  34                                 <!-- end publish.classesIndex -->
  35                         </div>
  36
  37                         <div class="fineprint" style="clear:both">
  38
  39                                 Generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sat Sep 10 2011 10:45:04 GMT+0100 (BST)<br />
  40                                 HTML template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a>
  41                         </div>
  42                 </div>
  43
  44                 <div class="content">
  45                         <div class="innerContent">
  46                                 <h1 class="classTitle">
  47
  48                                         Class <span>ColVis</span>
  49                                 </h1>
  50
  51                                 <p class="description summary">
  52
  53
  54
  55
  56                                         ColVis
  57
  58
  59                                                 <br /><em>Defined in: </em> <a href="../symbols/src/js_ColVis.js.html">ColVis.js</a>.
  60
  61                                 </p>
  62
  63
  64                                         <div class="props">
  65                                                 <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class ColVis.">
  66                                                         <caption>Class Summary</caption>
  67                                                         <thead>
  68                                                                 <tr>
  69                                                                         <th scope="col">Constructor Attributes</th>
  70                                                                         <th scope="col">Constructor Name and Description</th>
  71                                                                 </tr>
  72                                                         </thead>
  73                                                         <tbody>
  74                                                                 <tr>
  75                                                                         <td class="attributes">&nbsp;</td>
  76                                                                         <td class="nameDescription" >
  77                                                                                 <div class="fixedFont">
  78                                                                                         <b><a href="../symbols/ColVis.html#constructor">ColVis</a></b>(DataTables, oInit)
  79                                                                                 </div>
  80                                                                                 <div class="description">ColVis provides column visiblity control for DataTables</div>
  81                                                                         </td>
  82                                                                 </tr>
  83                                                         </tbody>
  84                                                 </table>
  85                                         </div>
  86
  87
  88
  89
  90
  91                                                 <div class="props">
  92                                                         <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class ColVis.">
  93                                                                 <caption>Field Summary</caption>
  94
  95                                                                 <thead>
  96                                                                         <tr>
  97                                                                                 <th scope="col">Field Attributes</th>
  98                                                                                 <th scope="col">Field Name and Description</th>
  99                                                                         </tr>
 100                                                                 </thead>
 101
 102                                                                 <tbody>
 103
 104                                                                                 <tr>
 105                                                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 106                                                                                         <td class="nameDescription">
 107                                                                                                 <div class="fixedFont">
 108                                                                                                 ColVis.<b><a href="../symbols/ColVis.html#.aInstances">aInstances</a></b>
 109                                                                                                 </div>
 110                                                                                                 <div class="description">Collection of all ColVis instances</div>
 111                                                                                         </td>
 112                                                                                 </tr>
 113
 114                                                                                 <tr>
 115                                                                                         <td class="attributes">&lt;constant&gt; &nbsp;</td>
 116                                                                                         <td class="nameDescription">
 117                                                                                                 <div class="fixedFont">
 118                                                                                                 <b><a href="../symbols/ColVis.html#CLASS">CLASS</a></b>
 119                                                                                                 </div>
 120                                                                                                 <div class="description">Name of this class</div>
 121                                                                                         </td>
 122                                                                                 </tr>
 123
 124                                                                                 <tr>
 125                                                                                         <td class="attributes">&lt;static&gt; &lt;constant&gt; &nbsp;</td>
 126                                                                                         <td class="nameDescription">
 127                                                                                                 <div class="fixedFont">
 128                                                                                                 ColVis.<b><a href="../symbols/ColVis.html#.VERSION">VERSION</a></b>
 129                                                                                                 </div>
 130                                                                                                 <div class="description">ColVis version</div>
 131                                                                                         </td>
 132                                                                                 </tr>
 133
 134                                                                 </tbody>
 135                                                         </table>
 136                                                 </div>
 137
 138
 139
 140
 141
 142         <!--
 143         #### METHODS SUMMARY
 144         -->
 145
 146
 147
 148                                                 <div class="props">
 149                                                         <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class ColVis.">
 150                                                                 <caption>Method Summary</caption>
 151
 152                                                                 <thead>
 153                                                                         <tr>
 154                                                                                 <th scope="col">Method Attributes</th>
 155                                                                                 <th scope="col">Method Name and Description</th>
 156                                                                         </tr>
 157                                                                 </thead>
 158
 159                                                                 <tbody>
 160
 161                                                                                 <tr>
 162                                                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 163                                                                                         <td class="nameDescription">
 164                                                                                                 <div class="fixedFont">ColVis.<b><a href="../symbols/ColVis.html#.fnRebuild">fnRebuild</a></b>(object)
 165                                                                                                 </div>
 166                                                                                                 <div class="description">Rebuild the collection for a given table, or all tables if no parameter given</div>
 167                                                                                         </td>
 168                                                                                 </tr>
 169
 170                                                                                 <tr>
 171                                                                                         <td class="attributes">&nbsp;</td>
 172                                                                                         <td class="nameDescription">
 173                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#fnRebuild">fnRebuild</a></b>()
 174                                                                                                 </div>
 175                                                                                                 <div class="description">Rebuild the list of buttons for this instance (i.e.</div>
 176                                                                                         </td>
 177                                                                                 </tr>
 178
 179                                                                 </tbody>
 180                                                         </table>
 181                                                 </div>
 182
 183
 184
 185
 186
 187         <!--
 188         #### EVENTS SUMMARY
 189         -->
 190
 191
 192         <!--
 193         #### CONSTRUCTOR DETAILS
 194         -->
 195
 196                                         <div class="details props">
 197                                                 <div class="innerProps">
 198                                                         <a name="constructor"></a>
 199
 200                                                         <div class="sectionTitle">
 201                                                                 Class Detail
 202                                                         </div>
 203
 204                                                         <div class="fixedFont">
 205                                                                 <b>ColVis</b>(DataTables, oInit)
 206                                                         </div>
 207
 208                                                         <div class="description">
 209                                                                 ColVis provides column visiblity control for DataTables
 210
 211                                                         </div>
 212
 213
 214
 215
 216                                                                 <dl class="detailList params">
 217                                                                         <dt class="heading">Parameters:</dt>
 218
 219                                                                                 <dt>
 220                                                                                         <span class="light fixedFont">{object}</span>  <b>DataTables</b>
 221
 222                                                                                 </dt>
 223                                                                                 <dd>settings object</dd>
 224
 225                                                                                 <dt>
 226                                                                                          <b>oInit</b>
 227
 228                                                                                 </dt>
 229                                                                                 <dd></dd>
 230
 231                                                                 </dl>
 232
 233
 234
 235                                                 </div>
 236                                         </div>
 237
 238
 239         <!--
 240         #### FIELD DETAILS
 241         -->
 242
 243                                         <div class="details props">
 244                                                 <div class="innerProps">
 245
 246                                                         <div class="sectionTitle">
 247                                                                 Field Detail
 248                                                         </div>
 249
 250
 251                                                                 <a name=".aInstances"></a>
 252
 253                                                                 <div class="fixedFont heading">
 254                                                                         <span class='lighter'>
 255                                                                         &lt;static&gt;
 256                                                                         </span>
 257
 258                                                                         <span class="light">{Array}</span>
 259
 260                                                                         <span class="light">ColVis.</span><b>aInstances</b>
 261                                                                 </div>
 262
 263                                                                 <div class="description">
 264                                                                         Collection of all ColVis instances
 265
 266
 267
 268                                                                 </div>
 269
 270
 271
 272
 273                                                                         <dl class="detailList nomargin">
 274
 275
 276
 277
 278
 279                                                                                         <dt class="heading">Default Value:</dt>
 280                                                                                         <dd>
 281                                                                                                 []
 282                                                                                         </dd>
 283
 284                                                                         </dl>
 285
 286
 287                                                                 <div class="hr"></div>
 288
 289                                                                 <a name="CLASS"></a>
 290
 291                                                                 <div class="fixedFont heading">
 292                                                                         <span class='lighter'>
 293                                                                         &lt;constant&gt;
 294                                                                         </span>
 295
 296                                                                         <span class="light">{String}</span>
 297
 298                                                                         <b>CLASS</b>
 299                                                                 </div>
 300
 301                                                                 <div class="description">
 302                                                                         Name of this class
 303
 304
 305
 306                                                                 </div>
 307
 308
 309
 310
 311                                                                         <dl class="detailList nomargin">
 312
 313
 314
 315
 316
 317                                                                                         <dt class="heading">Default Value:</dt>
 318                                                                                         <dd>
 319                                                                                                 ColVis
 320                                                                                         </dd>
 321
 322                                                                         </dl>
 323
 324
 325                                                                 <div class="hr"></div>
 326
 327                                                                 <a name=".VERSION"></a>
 328
 329                                                                 <div class="fixedFont heading">
 330                                                                         <span class='lighter'>
 331                                                                         &lt;static&gt; &lt;constant&gt;
 332                                                                         </span>
 333
 334                                                                         <span class="light">{String}</span>
 335
 336                                                                         <span class="light">ColVis.</span><b>VERSION</b>
 337                                                                 </div>
 338
 339                                                                 <div class="description">
 340                                                                         ColVis version
 341
 342
 343
 344                                                                 </div>
 345
 346
 347
 348
 349                                                                         <dl class="detailList nomargin">
 350
 351
 352
 353
 354
 355                                                                                         <dt class="heading">Default Value:</dt>
 356                                                                                         <dd>
 357                                                                                                 See code
 358                                                                                         </dd>
 359
 360                                                                         </dl>
 361
 362
 363
 364
 365                                                 </div>
 366                                         </div>
 367
 368
 369         <!--
 370         #### METHOD DETAILS
 371         -->
 372
 373                                         <div class="details props">
 374                                                 <div class="innerProps">
 375                                                         <div class="sectionTitle">
 376                                                                 Method Detail
 377                                                         </div>
 378
 379
 380                                                                 <a name=".fnRebuild"></a>
 381
 382                                                                 <div class="fixedFont heading">
 383                                                                         <span class='lighter'>
 384                                                                         &lt;static&gt;
 385                                                                         </span>
 386
 387
 388
 389                                                                         <span class="light">ColVis.</span><b>fnRebuild</b>(object)
 390                                                                 </div>
 391
 392                                                                 <div class="description">
 393                                                                         Rebuild the collection for a given table, or all tables if no parameter given
 394
 395
 396
 397
 398                                                                 </div>
 399
 400
 401
 402
 403                                                                         <dl class="detailList params">
 404                                                                                 <dt class="heading">Parameters:</dt>
 405
 406                                                                                         <dt>
 407                                                                                                 <b>object</b>
 408
 409                                                                                         </dt>
 410                                                                                         <dd>oTable DataTable instance to consider - optional</dd>
 411
 412                                                                         </dl>
 413
 414
 415
 416                                                                         <dl class="detailList nomargin">
 417
 418
 419
 420
 421
 422
 423
 424
 425                                                                                         <dt class="heading">Returns:</dt>
 426
 427                                                                                                 <dd>void</dd>
 428
 429
 430
 431
 432
 433
 434
 435                                                                         </dl>
 436
 437
 438                                                                 <div class="hr"></div>
 439
 440                                                                 <a name="fnRebuild"></a>
 441
 442                                                                 <div class="fixedFont heading">
 443                                                                         <span class='lighter'>
 444
 445                                                                         </span>
 446
 447
 448
 449                                                                         <b>fnRebuild</b>()
 450                                                                 </div>
 451
 452                                                                 <div class="description">
 453                                                                         Rebuild the list of buttons for this instance (i.e. if there is a column header update)
 454
 455
 456
 457
 458                                                                 </div>
 459
 460
 461
 462
 463
 464
 465                                                                         <dl class="detailList nomargin">
 466
 467
 468
 469
 470
 471
 472
 473
 474                                                                                         <dt class="heading">Returns:</dt>
 475
 476                                                                                                 <dd>void</dd>
 477
 478
 479
 480
 481
 482
 483
 484                                                                         </dl>
 485
 486
 487
 488
 489                                                 </div>
 490                                         </div>
 491
 492
 493         <!--
 494         #### EVENT DETAILS
 495         -->
 496
 497                         </div>
 498                 </div>
 499         </body>
 500 </html>