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
</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:
44:
59 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 Class
<span>ColVis
</span>
51 <p class=
"description summary">
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.">
66 <caption>Class 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.html#constructor">ColVis
</a></b>(DataTables, oInit)
80 <div class=
"description">ColVis provides column visiblity control for DataTables
</div>
92 <table class=
"summaryTable" cellspacing=
"0" summary=
"A summary of the fields documented in the class ColVis.">
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.
<b><a href=
"../symbols/ColVis.html#.aInstances">aInstances
</a></b>
110 <div class=
"description">Collection of all ColVis instances
</div>
115 <td class=
"attributes"><constant
> </td>
116 <td class=
"nameDescription">
117 <div class=
"fixedFont">
118 <b><a href=
"../symbols/ColVis.html#CLASS">CLASS
</a></b>
120 <div class=
"description">Name of this class
</div>
125 <td class=
"attributes"><static
> <constant
> </td>
126 <td class=
"nameDescription">
127 <div class=
"fixedFont">
128 ColVis.
<b><a href=
"../symbols/ColVis.html#.VERSION">VERSION
</a></b>
130 <div class=
"description">ColVis version
</div>
149 <table class=
"summaryTable" cellspacing=
"0" summary=
"A summary of the methods documented in the class ColVis.">
150 <caption>Method Summary
</caption>
154 <th scope=
"col">Method Attributes
</th>
155 <th scope=
"col">Method Name and Description
</th>
162 <td class=
"attributes"><private
> </td>
163 <td class=
"nameDescription">
164 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnAddButtons">_fnAddButtons
</a></b>()
166 <div class=
"description">Loop through the columns in the table and as a new button for each one.
</div>
171 <td class=
"attributes"><private
> </td>
172 <td class=
"nameDescription">
173 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnApplyCustomisation">_fnApplyCustomisation
</a></b>()
175 <div class=
"description">Apply any customisation to the settings from the DataTables initialisation
</div>
180 <td class=
"attributes"><private
> </td>
181 <td class=
"nameDescription">
182 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnCollectionHide">_fnCollectionHide
</a></b>()
184 <div class=
"description">Hide the show / hide list and the background
</div>
189 <td class=
"attributes"><private
> </td>
190 <td class=
"nameDescription">
191 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnCollectionShow">_fnCollectionShow
</a></b>()
193 <div class=
"description">Show the show / hide list and the background
</div>
198 <td class=
"attributes"><private
> </td>
199 <td class=
"nameDescription">
200 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnConstruct">_fnConstruct
</a></b>()
202 <div class=
"description">Constructor logic
</div>
207 <td class=
"attributes"><private
> </td>
208 <td class=
"nameDescription">
209 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDataTablesApiIndex">_fnDataTablesApiIndex
</a></b>()
211 <div class=
"description">Get the position in the DataTables instance array of the table for this instance of ColVis
</div>
216 <td class=
"attributes"><private
> </td>
217 <td class=
"nameDescription">
218 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDomBackground">_fnDomBackground
</a></b>()
220 <div class=
"description">Create the element used to shade the background, and capture hide events (it is shown and
221 hidden as needed)
</div>
226 <td class=
"attributes"><private
> </td>
227 <td class=
"nameDescription">
228 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDomBaseButton">_fnDomBaseButton
</a></b>(text)
230 <div class=
"description">Create the DOM needed for the button and apply some base properties.
</div>
235 <td class=
"attributes"><private
> </td>
236 <td class=
"nameDescription">
237 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDomCatcher">_fnDomCatcher
</a></b>()
239 <div class=
"description">An element to be placed on top of the activate button to catch events
</div>
244 <td class=
"attributes"><private
> </td>
245 <td class=
"nameDescription">
246 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDomCollection">_fnDomCollection
</a></b>()
248 <div class=
"description">Create the element used to contain list the columns (it is shown and hidden as needed)
</div>
253 <td class=
"attributes"><private
> </td>
254 <td class=
"nameDescription">
255 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDomColumnButton">_fnDomColumnButton
</a></b>(i)
257 <div class=
"description">Create the DOM for a show / hide button
</div>
262 <td class=
"attributes"><private
> </td>
263 <td class=
"nameDescription">
264 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDomRestoreButton">_fnDomRestoreButton
</a></b>()
266 <div class=
"description">Create a button which allows a
"restore" action
</div>
271 <td class=
"attributes"><private
> </td>
272 <td class=
"nameDescription">
273 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#_fnDrawCallback">_fnDrawCallback
</a></b>()
275 <div class=
"description">On each table draw, check the visiblity checkboxes as needed.
</div>
280 <td class=
"attributes"><static
> </td>
281 <td class=
"nameDescription">
282 <div class=
"fixedFont">ColVis.
<b><a href=
"../symbols/ColVis.html#.fnRebuild">fnRebuild
</a></b>(object)
284 <div class=
"description">Rebuild the collection for a given table, or all tables if no parameter given
</div>
289 <td class=
"attributes"> </td>
290 <td class=
"nameDescription">
291 <div class=
"fixedFont"><b><a href=
"../symbols/ColVis.html#fnRebuild">fnRebuild
</a></b>()
293 <div class=
"description">Rebuild the list of buttons for this instance (i.e.
</div>
311 #### CONSTRUCTOR DETAILS
314 <div class=
"details props">
315 <div class=
"innerProps">
316 <a name=
"constructor"></a>
318 <div class=
"sectionTitle">
322 <div class=
"fixedFont">
323 <b>ColVis
</b>(DataTables, oInit)
326 <div class=
"description">
327 ColVis provides column visiblity control for DataTables
334 <dl class=
"detailList params">
335 <dt class=
"heading">Parameters:
</dt>
338 <span class=
"light fixedFont">{object}
</span> <b>DataTables
</b>
341 <dd>settings object
</dd>
361 <div class=
"details props">
362 <div class=
"innerProps">
364 <div class=
"sectionTitle">
369 <a name=
".aInstances"></a>
371 <div class=
"fixedFont heading">
372 <span class='lighter'
>
376 <span class=
"light">{Array}
</span>
378 <span class=
"light">ColVis.
</span><b>aInstances
</b>
381 <div class=
"description">
382 Collection of all ColVis instances
391 <dl class=
"detailList nomargin">
397 <dt class=
"heading">Default Value:
</dt>
405 <div class=
"hr"></div>
409 <div class=
"fixedFont heading">
410 <span class='lighter'
>
414 <span class=
"light">{String}
</span>
419 <div class=
"description">
429 <dl class=
"detailList nomargin">
435 <dt class=
"heading">Default Value:
</dt>
443 <div class=
"hr"></div>
445 <a name=
".VERSION"></a>
447 <div class=
"fixedFont heading">
448 <span class='lighter'
>
449 <static
> <constant
>
452 <span class=
"light">{String}
</span>
454 <span class=
"light">ColVis.
</span><b>VERSION
</b>
457 <div class=
"description">
467 <dl class=
"detailList nomargin">
473 <dt class=
"heading">Default Value:
</dt>
491 <div class=
"details props">
492 <div class=
"innerProps">
493 <div class=
"sectionTitle">
498 <a name=
"_fnAddButtons"></a>
500 <div class=
"fixedFont heading">
501 <span class='lighter'
>
507 <b>_fnAddButtons
</b>()
510 <div class=
"description">
511 Loop through the columns in the table and as a new button for each one.
523 <dl class=
"detailList nomargin">
532 <dt class=
"heading">Returns:
</dt>
545 <div class=
"hr"></div>
547 <a name=
"_fnApplyCustomisation"></a>
549 <div class=
"fixedFont heading">
550 <span class='lighter'
>
556 <b>_fnApplyCustomisation
</b>()
559 <div class=
"description">
560 Apply any customisation to the settings from the DataTables initialisation
572 <dl class=
"detailList nomargin">
581 <dt class=
"heading">Returns:
</dt>
594 <div class=
"hr"></div>
596 <a name=
"_fnCollectionHide"></a>
598 <div class=
"fixedFont heading">
599 <span class='lighter'
>
605 <b>_fnCollectionHide
</b>()
608 <div class=
"description">
609 Hide the show / hide list and the background
621 <dl class=
"detailList nomargin">
630 <dt class=
"heading">Returns:
</dt>
643 <div class=
"hr"></div>
645 <a name=
"_fnCollectionShow"></a>
647 <div class=
"fixedFont heading">
648 <span class='lighter'
>
654 <b>_fnCollectionShow
</b>()
657 <div class=
"description">
658 Show the show / hide list and the background
670 <dl class=
"detailList nomargin">
679 <dt class=
"heading">Returns:
</dt>
692 <div class=
"hr"></div>
694 <a name=
"_fnConstruct"></a>
696 <div class=
"fixedFont heading">
697 <span class='lighter'
>
703 <b>_fnConstruct
</b>()
706 <div class=
"description">
719 <dl class=
"detailList nomargin">
728 <dt class=
"heading">Returns:
</dt>
741 <div class=
"hr"></div>
743 <a name=
"_fnDataTablesApiIndex"></a>
745 <div class=
"fixedFont heading">
746 <span class='lighter'
>
750 <span class=
"light">{int}
</span>
752 <b>_fnDataTablesApiIndex
</b>()
755 <div class=
"description">
756 Get the position in the DataTables instance array of the table for this instance of ColVis
768 <dl class=
"detailList nomargin">
777 <dt class=
"heading">Returns:
</dt>
779 <dd><span class=
"light fixedFont">{int}
</span> Index
</dd>
790 <div class=
"hr"></div>
792 <a name=
"_fnDomBackground"></a>
794 <div class=
"fixedFont heading">
795 <span class='lighter'
>
799 <span class=
"light">{Node}
</span>
801 <b>_fnDomBackground
</b>()
804 <div class=
"description">
805 Create the element used to shade the background, and capture hide events (it is shown and
818 <dl class=
"detailList nomargin">
827 <dt class=
"heading">Returns:
</dt>
829 <dd><span class=
"light fixedFont">{Node}
</span> div container for the background
</dd>
840 <div class=
"hr"></div>
842 <a name=
"_fnDomBaseButton"></a>
844 <div class=
"fixedFont heading">
845 <span class='lighter'
>
849 <span class=
"light">{Node}
</span>
851 <b>_fnDomBaseButton
</b>(text)
854 <div class=
"description">
855 Create the DOM needed for the button and apply some base properties. All buttons start here
865 <dl class=
"detailList params">
866 <dt class=
"heading">Parameters:
</dt>
869 <span class=
"light fixedFont">{String}
</span> <b>text
</b>
878 <dl class=
"detailList nomargin">
887 <dt class=
"heading">Returns:
</dt>
889 <dd><span class=
"light fixedFont">{Node}
</span> DIV element for the button
</dd>
900 <div class=
"hr"></div>
902 <a name=
"_fnDomCatcher"></a>
904 <div class=
"fixedFont heading">
905 <span class='lighter'
>
909 <span class=
"light">{Node}
</span>
911 <b>_fnDomCatcher
</b>()
914 <div class=
"description">
915 An element to be placed on top of the activate button to catch events
927 <dl class=
"detailList nomargin">
936 <dt class=
"heading">Returns:
</dt>
938 <dd><span class=
"light fixedFont">{Node}
</span> div container for the collection
</dd>
949 <div class=
"hr"></div>
951 <a name=
"_fnDomCollection"></a>
953 <div class=
"fixedFont heading">
954 <span class='lighter'
>
958 <span class=
"light">{Node}
</span>
960 <b>_fnDomCollection
</b>()
963 <div class=
"description">
964 Create the element used to contain list the columns (it is shown and hidden as needed)
976 <dl class=
"detailList nomargin">
985 <dt class=
"heading">Returns:
</dt>
987 <dd><span class=
"light fixedFont">{Node}
</span> div container for the collection
</dd>
998 <div class=
"hr"></div>
1000 <a name=
"_fnDomColumnButton"></a>
1002 <div class=
"fixedFont heading">
1003 <span class='lighter'
>
1007 <span class=
"light">{Node}
</span>
1009 <b>_fnDomColumnButton
</b>(i)
1012 <div class=
"description">
1013 Create the DOM for a show / hide button
1023 <dl class=
"detailList params">
1024 <dt class=
"heading">Parameters:
</dt>
1027 <span class=
"light fixedFont">{int}
</span> <b>i
</b>
1030 <dd>Column in question
</dd>
1036 <dl class=
"detailList nomargin">
1045 <dt class=
"heading">Returns:
</dt>
1047 <dd><span class=
"light fixedFont">{Node}
</span> Created button
</dd>
1058 <div class=
"hr"></div>
1060 <a name=
"_fnDomRestoreButton"></a>
1062 <div class=
"fixedFont heading">
1063 <span class='lighter'
>
1067 <span class=
"light">{Node}
</span>
1069 <b>_fnDomRestoreButton
</b>()
1072 <div class=
"description">
1073 Create a button which allows a
"restore" action
1085 <dl class=
"detailList nomargin">
1094 <dt class=
"heading">Returns:
</dt>
1096 <dd><span class=
"light fixedFont">{Node}
</span> Created button
</dd>
1107 <div class=
"hr"></div>
1109 <a name=
"_fnDrawCallback"></a>
1111 <div class=
"fixedFont heading">
1112 <span class='lighter'
>
1118 <b>_fnDrawCallback
</b>()
1121 <div class=
"description">
1122 On each table draw, check the visiblity checkboxes as needed. This allows any process to
1123 update the table's column visiblity and ColVis will still be accurate.
1135 <dl class=
"detailList nomargin">
1144 <dt class=
"heading">Returns:
</dt>
1157 <div class=
"hr"></div>
1159 <a name=
".fnRebuild"></a>
1161 <div class=
"fixedFont heading">
1162 <span class='lighter'
>
1168 <span class=
"light">ColVis.
</span><b>fnRebuild
</b>(object)
1171 <div class=
"description">
1172 Rebuild the collection for a given table, or all tables if no parameter given
1182 <dl class=
"detailList params">
1183 <dt class=
"heading">Parameters:
</dt>
1189 <dd>oTable DataTable instance to consider - optional
</dd>
1195 <dl class=
"detailList nomargin">
1204 <dt class=
"heading">Returns:
</dt>
1217 <div class=
"hr"></div>
1219 <a name=
"fnRebuild"></a>
1221 <div class=
"fixedFont heading">
1222 <span class='lighter'
>
1231 <div class=
"description">
1232 Rebuild the list of buttons for this instance (i.e. if there is a column header update)
1244 <dl class=
"detailList nomargin">
1253 <dt class=
"heading">Returns:
</dt>