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">
4 <meta http-equiv=
"content-type" content=
"text/html; charset=utf-8" />
5 <meta name=
"generator" content=
"JsDoc Toolkit" />
7 <title>JsDoc Reference - ColVis#s
</title>
8 <link href=
"../css/default.css" type=
"text/css" rel=
"stylesheet" media=
"all" />
17 <!-- begin publish.classesIndex -->
18 <div align=
"center"><a href=
"../index.html">Class Index
</a> |
<a href=
"../files.html">File Index
</a></div>
20 <h2 class=
"heading1">Classes
</h2>
22 <ul class=
"classList">
24 <li><a href=
"../symbols/_global_.html">_global_
</a></li>
26 <li><a href=
"../symbols/ColVis.html">ColVis
</a></li>
28 <li><a href=
"../symbols/ColVis%23dom.html">ColVis#dom
</a></li>
30 <li><a href=
"../symbols/ColVis%23s.html">ColVis#s
</a></li>
34 <!-- end publish.classesIndex -->
37 <div class=
"fineprint" style=
"clear:both">
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:
46:
55 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>
45 <div class=
"innerContent">
46 <h1 class=
"classTitle">
48 Namespace
<span>ColVis#s
</span>
51 <p class=
"description summary">
56 Settings object which contains customisable information for ColVis instance
59 <br /><em>Defined in:
</em> <a href=
"../symbols/src/js_ColVis.js.html">ColVis.js
</a>.
65 <table class=
"summaryTable" cellspacing=
"0" summary=
"A summary of the constructor documented in the class ColVis#s.">
66 <caption>Namespace Summary
</caption>
69 <th scope=
"col">Constructor Attributes
</th>
70 <th scope=
"col">Constructor Name and Description
</th>
75 <td class=
"attributes"> </td>
76 <td class=
"nameDescription" >
77 <div class=
"fixedFont">
78 <b><a href=
"../symbols/ColVis%23s.html#constructor">ColVis#s
</a></b>
80 <div class=
"description"></div>
92 <table class=
"summaryTable" cellspacing=
"0" summary=
"A summary of the fields documented in the class ColVis#s.">
93 <caption>Field Summary
</caption>
97 <th scope=
"col">Field Attributes
</th>
98 <th scope=
"col">Field Name and Description
</th>
105 <td class=
"attributes"><static
> </td>
106 <td class=
"nameDescription">
107 <div class=
"fixedFont">
108 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.abOriginal">abOriginal
</a></b>
110 <div class=
"description">Store the original viisbility settings so they could be restored
</div>
115 <td class=
"attributes"><static
> </td>
116 <td class=
"nameDescription">
117 <div class=
"fixedFont">
118 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.activate">activate
</a></b>
120 <div class=
"description">Mode of activation.
</div>
125 <td class=
"attributes"><static
> </td>
126 <td class=
"nameDescription">
127 <div class=
"fixedFont">
128 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.aiExclude">aiExclude
</a></b>
130 <div class=
"description">List of columns (integers) which should be excluded from the list
</div>
135 <td class=
"attributes"><static
> </td>
136 <td class=
"nameDescription">
137 <div class=
"fixedFont">
138 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.bRestore">bRestore
</a></b>
140 <div class=
"description">Show restore button
</div>
145 <td class=
"attributes"><static
> </td>
146 <td class=
"nameDescription">
147 <div class=
"fixedFont">
148 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.buttonText">buttonText
</a></b>
150 <div class=
"description">Text used for the button
</div>
155 <td class=
"attributes"><static
> </td>
156 <td class=
"nameDescription">
157 <div class=
"fixedFont">
158 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.dt">dt
</a></b>
160 <div class=
"description">DataTables settings object
</div>
165 <td class=
"attributes"><static
> </td>
166 <td class=
"nameDescription">
167 <div class=
"fixedFont">
168 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.fnLabel">fnLabel
</a></b>
170 <div class=
"description">Label callback for column names.
</div>
175 <td class=
"attributes"><static
> </td>
176 <td class=
"nameDescription">
177 <div class=
"fixedFont">
178 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.fnStateChange">fnStateChange
</a></b>
180 <div class=
"description">Callback function to tell the user when the state has changed
</div>
185 <td class=
"attributes"><static
> </td>
186 <td class=
"nameDescription">
187 <div class=
"fixedFont">
188 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.hidden">hidden
</a></b>
190 <div class=
"description">Flag to say if the collection is hidden
</div>
195 <td class=
"attributes"><static
> </td>
196 <td class=
"nameDescription">
197 <div class=
"fixedFont">
198 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.iOverlayFade">iOverlayFade
</a></b>
200 <div class=
"description">Overlay animation duration in mS
</div>
205 <td class=
"attributes"><static
> </td>
206 <td class=
"nameDescription">
207 <div class=
"fixedFont">
208 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.oInit">oInit
</a></b>
210 <div class=
"description">Customisation object
</div>
215 <td class=
"attributes"><static
> </td>
216 <td class=
"nameDescription">
217 <div class=
"fixedFont">
218 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.sAlign">sAlign
</a></b>
220 <div class=
"description">Position of the collection menu when shown - align
"left" or
"right"</div>
225 <td class=
"attributes"><static
> </td>
226 <td class=
"nameDescription">
227 <div class=
"fixedFont">
228 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.sRestore">sRestore
</a></b>
230 <div class=
"description">Restore button text
</div>
235 <td class=
"attributes"><static
> </td>
236 <td class=
"nameDescription">
237 <div class=
"fixedFont">
238 ColVis#s.
<b><a href=
"../symbols/ColVis%23s.html#.sSize">sSize
</a></b>
240 <div class=
"description">Indicate if ColVis should automatically calculate the size of buttons or not.
</div>
263 #### CONSTRUCTOR DETAILS
266 <div class=
"details props">
267 <div class=
"innerProps">
268 <a name=
"constructor"></a>
270 <div class=
"sectionTitle">
274 <div class=
"fixedFont">
278 <div class=
"description">
296 <div class=
"details props">
297 <div class=
"innerProps">
299 <div class=
"sectionTitle">
304 <a name=
".abOriginal"></a>
306 <div class=
"fixedFont heading">
307 <span class='lighter'
>
311 <span class=
"light">{Array}
</span>
313 <span class=
"light">ColVis#s.
</span><b>abOriginal
</b>
316 <div class=
"description">
317 Store the original viisbility settings so they could be restored
326 <dl class=
"detailList nomargin">
332 <dt class=
"heading">Default Value:
</dt>
340 <div class=
"hr"></div>
342 <a name=
".activate"></a>
344 <div class=
"fixedFont heading">
345 <span class='lighter'
>
349 <span class=
"light">{String}
</span>
351 <span class=
"light">ColVis#s.
</span><b>activate
</b>
354 <div class=
"description">
355 Mode of activation. Can be 'click' or 'mouseover'
364 <dl class=
"detailList nomargin">
370 <dt class=
"heading">Default Value:
</dt>
378 <div class=
"hr"></div>
380 <a name=
".aiExclude"></a>
382 <div class=
"fixedFont heading">
383 <span class='lighter'
>
387 <span class=
"light">{Array}
</span>
389 <span class=
"light">ColVis#s.
</span><b>aiExclude
</b>
392 <div class=
"description">
393 List of columns (integers) which should be excluded from the list
402 <dl class=
"detailList nomargin">
408 <dt class=
"heading">Default Value:
</dt>
416 <div class=
"hr"></div>
418 <a name=
".bRestore"></a>
420 <div class=
"fixedFont heading">
421 <span class='lighter'
>
425 <span class=
"light">{Array}
</span>
427 <span class=
"light">ColVis#s.
</span><b>bRestore
</b>
430 <div class=
"description">
440 <dl class=
"detailList nomargin">
446 <dt class=
"heading">Default Value:
</dt>
454 <div class=
"hr"></div>
456 <a name=
".buttonText"></a>
458 <div class=
"fixedFont heading">
459 <span class='lighter'
>
463 <span class=
"light">{String}
</span>
465 <span class=
"light">ColVis#s.
</span><b>buttonText
</b>
468 <div class=
"description">
469 Text used for the button
478 <dl class=
"detailList nomargin">
484 <dt class=
"heading">Default Value:
</dt>
492 <div class=
"hr"></div>
496 <div class=
"fixedFont heading">
497 <span class='lighter'
>
501 <span class=
"light">{Object}
</span>
503 <span class=
"light">ColVis#s.
</span><b>dt
</b>
506 <div class=
"description">
507 DataTables settings object
516 <dl class=
"detailList nomargin">
522 <dt class=
"heading">Default Value:
</dt>
530 <div class=
"hr"></div>
532 <a name=
".fnLabel"></a>
534 <div class=
"fixedFont heading">
535 <span class='lighter'
>
539 <span class=
"light">{Function}
</span>
541 <span class=
"light">ColVis#s.
</span><b>fnLabel
</b>
544 <div class=
"description">
545 Label callback for column names. Takes three parameters:
1. the column index,
2. the column
546 title detected by DataTables and
3. the TH node for the column
555 <dl class=
"detailList nomargin">
561 <dt class=
"heading">Default Value:
</dt>
569 <div class=
"hr"></div>
571 <a name=
".fnStateChange"></a>
573 <div class=
"fixedFont heading">
574 <span class='lighter'
>
578 <span class=
"light">{function}
</span>
580 <span class=
"light">ColVis#s.
</span><b>fnStateChange
</b>
583 <div class=
"description">
584 Callback function to tell the user when the state has changed
593 <dl class=
"detailList nomargin">
599 <dt class=
"heading">Default Value:
</dt>
607 <div class=
"hr"></div>
609 <a name=
".hidden"></a>
611 <div class=
"fixedFont heading">
612 <span class='lighter'
>
616 <span class=
"light">{boolean}
</span>
618 <span class=
"light">ColVis#s.
</span><b>hidden
</b>
621 <div class=
"description">
622 Flag to say if the collection is hidden
631 <dl class=
"detailList nomargin">
637 <dt class=
"heading">Default Value:
</dt>
645 <div class=
"hr"></div>
647 <a name=
".iOverlayFade"></a>
649 <div class=
"fixedFont heading">
650 <span class='lighter'
>
654 <span class=
"light">{Integer}
</span>
656 <span class=
"light">ColVis#s.
</span><b>iOverlayFade
</b>
659 <div class=
"description">
660 Overlay animation duration in mS
669 <dl class=
"detailList nomargin">
675 <dt class=
"heading">Default Value:
</dt>
683 <div class=
"hr"></div>
685 <a name=
".oInit"></a>
687 <div class=
"fixedFont heading">
688 <span class='lighter'
>
692 <span class=
"light">{Object}
</span>
694 <span class=
"light">ColVis#s.
</span><b>oInit
</b>
697 <div class=
"description">
707 <dl class=
"detailList nomargin">
713 <dt class=
"heading">Default Value:
</dt>
721 <div class=
"hr"></div>
723 <a name=
".sAlign"></a>
725 <div class=
"fixedFont heading">
726 <span class='lighter'
>
730 <span class=
"light">{String}
</span>
732 <span class=
"light">ColVis#s.
</span><b>sAlign
</b>
735 <div class=
"description">
736 Position of the collection menu when shown - align
"left" or
"right"
745 <dl class=
"detailList nomargin">
751 <dt class=
"heading">Default Value:
</dt>
759 <div class=
"hr"></div>
761 <a name=
".sRestore"></a>
763 <div class=
"fixedFont heading">
764 <span class='lighter'
>
768 <span class=
"light">{String}
</span>
770 <span class=
"light">ColVis#s.
</span><b>sRestore
</b>
773 <div class=
"description">
783 <dl class=
"detailList nomargin">
789 <dt class=
"heading">Default Value:
</dt>
797 <div class=
"hr"></div>
799 <a name=
".sSize"></a>
801 <div class=
"fixedFont heading">
802 <span class='lighter'
>
806 <span class=
"light">{String}
</span>
808 <span class=
"light">ColVis#s.
</span><b>sSize
</b>
811 <div class=
"description">
812 Indicate if ColVis should automatically calculate the size of buttons or not. The default
813 is for it to do so. Set to
"css" to disable the automatic sizing
822 <dl class=
"detailList nomargin">
828 <dt class=
"heading">Default Value:
</dt>