Context Navigation

source: branches/WebApplication/MVC2/HeuristicLabWeb.PluginHost/HLWebPluginHost/Content/jQuery/jQueryPlugins/DataTables-1.7.6/extras/ColVis/media/docs_private/symbols/ColVis#s.html @ 6286

Visit:

Last change on this file since 6286 was 6286, checked in by dkahn, 13 years ago
#1198 Added jQuery plus plugins
File size: 16.0 KB

Line
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#s</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 Wed Mar 02 2011 19:10:29 GMT-0000 (GMT)<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	Namespace <span>ColVis#s</span>
49	</h1>
50
51	<p class="description summary">
52
53
54
55
56	Settings object which contains customisable information for ColVis instance
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#s.">
66	<caption>Namespace 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"> </td>
76	<td class="nameDescription" >
77	<div class="fixedFont">
78	<b><a href="../symbols/ColVis%23s.html#constructor">ColVis#s</a></b>
79	</div>
80	<div class="description"></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#s.">
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"><static>  </td>
106	<td class="nameDescription">
107	<div class="fixedFont">
108	ColVis#s.<b><a href="../symbols/ColVis%23s.html#.abOriginal">abOriginal</a></b>
109	</div>
110	<div class="description">Store the original viisbility settings so they could be restored</div>
111	</td>
112	</tr>
113
114	<tr>
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>
119	</div>
120	<div class="description">Mode of activation.</div>
121	</td>
122	</tr>
123
124	<tr>
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>
129	</div>
130	<div class="description">List of columns (integers) which should be excluded from the list</div>
131	</td>
132	</tr>
133
134	<tr>
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>
139	</div>
140	<div class="description">Show restore button</div>
141	</td>
142	</tr>
143
144	<tr>
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>
149	</div>
150	<div class="description">Text used for the button</div>
151	</td>
152	</tr>
153
154	<tr>
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>
159	</div>
160	<div class="description">DataTables settings object</div>
161	</td>
162	</tr>
163
164	<tr>
165	<td class="attributes"><static>  </td>
166	<td class="nameDescription">
167	<div class="fixedFont">
168	ColVis#s.<b><a href="../symbols/ColVis%23s.html#.fnStateChange">fnStateChange</a></b>
169	</div>
170	<div class="description">Callback function to tell the user when the state has changed</div>
171	</td>
172	</tr>
173
174	<tr>
175	<td class="attributes"><static>  </td>
176	<td class="nameDescription">
177	<div class="fixedFont">
178	ColVis#s.<b><a href="../symbols/ColVis%23s.html#.hidden">hidden</a></b>
179	</div>
180	<div class="description">Flag to say if the collection is hidden</div>
181	</td>
182	</tr>
183
184	<tr>
185	<td class="attributes"><static>  </td>
186	<td class="nameDescription">
187	<div class="fixedFont">
188	ColVis#s.<b><a href="../symbols/ColVis%23s.html#.oInit">oInit</a></b>
189	</div>
190	<div class="description">Customisation object</div>
191	</td>
192	</tr>
193
194	<tr>
195	<td class="attributes"><static>  </td>
196	<td class="nameDescription">
197	<div class="fixedFont">
198	ColVis#s.<b><a href="../symbols/ColVis%23s.html#.sAlign">sAlign</a></b>
199	</div>
200	<div class="description">Position of the collection menu when shown - align "left" or "right"</div>
201	</td>
202	</tr>
203
204	<tr>
205	<td class="attributes"><static>  </td>
206	<td class="nameDescription">
207	<div class="fixedFont">
208	ColVis#s.<b><a href="../symbols/ColVis%23s.html#.sRestore">sRestore</a></b>
209	</div>
210	<div class="description">Restore button text</div>
211	</td>
212	</tr>
213
214	</tbody>
215	</table>
216	</div>
217
218
219
220
221
222	<!--
223	#### METHODS SUMMARY
224	-->
225
226
227	<!--
228	#### EVENTS SUMMARY
229	-->
230
231
232	<!--
233	#### CONSTRUCTOR DETAILS
234	-->
235
236	<div class="details props">
237	<div class="innerProps">
238	<a name="constructor"></a>
239
240	<div class="sectionTitle">
241	Namespace Detail
242	</div>
243
244	<div class="fixedFont">
245	<b>ColVis#s</b>
246	</div>
247
248	<div class="description">
249
250
251	</div>
252
253
254
255
256
257
258	</div>
259	</div>
260
261
262	<!--
263	#### FIELD DETAILS
264	-->
265
266	<div class="details props">
267	<div class="innerProps">
268
269	<div class="sectionTitle">
270	Field Detail
271	</div>
272
273
274	<a name=".abOriginal"></a>
275
276	<div class="fixedFont heading">
277	<span class='lighter'>
278	<static>
279	</span>
280
281	<span class="light">{Array}</span>
282
283	<span class="light">ColVis#s.</span><b>abOriginal</b>
284	</div>
285
286	<div class="description">
287	Store the original viisbility settings so they could be restored
288
289
290
291	</div>
292
293
294
295
296	<dl class="detailList nomargin">
297
298
299
300
301
302	<dt class="heading">Default Value:</dt>
303	<dd>
304	[]
305	</dd>
306
307	</dl>
308
309
310	<div class="hr"></div>
311
312	<a name=".activate"></a>
313
314	<div class="fixedFont heading">
315	<span class='lighter'>
316	<static>
317	</span>
318
319	<span class="light">{String}</span>
320
321	<span class="light">ColVis#s.</span><b>activate</b>
322	</div>
323
324	<div class="description">
325	Mode of activation. Can be 'click' or 'mouseover'
326
327
328
329	</div>
330
331
332
333
334	<dl class="detailList nomargin">
335
336
337
338
339
340	<dt class="heading">Default Value:</dt>
341	<dd>
342	click
343	</dd>
344
345	</dl>
346
347
348	<div class="hr"></div>
349
350	<a name=".aiExclude"></a>
351
352	<div class="fixedFont heading">
353	<span class='lighter'>
354	<static>
355	</span>
356
357	<span class="light">{Array}</span>
358
359	<span class="light">ColVis#s.</span><b>aiExclude</b>
360	</div>
361
362	<div class="description">
363	List of columns (integers) which should be excluded from the list
364
365
366
367	</div>
368
369
370
371
372	<dl class="detailList nomargin">
373
374
375
376
377
378	<dt class="heading">Default Value:</dt>
379	<dd>
380	[]
381	</dd>
382
383	</dl>
384
385
386	<div class="hr"></div>
387
388	<a name=".bRestore"></a>
389
390	<div class="fixedFont heading">
391	<span class='lighter'>
392	<static>
393	</span>
394
395	<span class="light">{Array}</span>
396
397	<span class="light">ColVis#s.</span><b>bRestore</b>
398	</div>
399
400	<div class="description">
401	Show restore button
402
403
404
405	</div>
406
407
408
409
410	<dl class="detailList nomargin">
411
412
413
414
415
416	<dt class="heading">Default Value:</dt>
417	<dd>
418	[]
419	</dd>
420
421	</dl>
422
423
424	<div class="hr"></div>
425
426	<a name=".buttonText"></a>
427
428	<div class="fixedFont heading">
429	<span class='lighter'>
430	<static>
431	</span>
432
433	<span class="light">{String}</span>
434
435	<span class="light">ColVis#s.</span><b>buttonText</b>
436	</div>
437
438	<div class="description">
439	Text used for the button
440
441
442
443	</div>
444
445
446
447
448	<dl class="detailList nomargin">
449
450
451
452
453
454	<dt class="heading">Default Value:</dt>
455	<dd>
456	Show / hide columns
457	</dd>
458
459	</dl>
460
461
462	<div class="hr"></div>
463
464	<a name=".dt"></a>
465
466	<div class="fixedFont heading">
467	<span class='lighter'>
468	<static>
469	</span>
470
471	<span class="light">{Object}</span>
472
473	<span class="light">ColVis#s.</span><b>dt</b>
474	</div>
475
476	<div class="description">
477	DataTables settings object
478
479
480
481	</div>
482
483
484
485
486	<dl class="detailList nomargin">
487
488
489
490
491
492	<dt class="heading">Default Value:</dt>
493	<dd>
494	null
495	</dd>
496
497	</dl>
498
499
500	<div class="hr"></div>
501
502	<a name=".fnStateChange"></a>
503
504	<div class="fixedFont heading">
505	<span class='lighter'>
506	<static>
507	</span>
508
509	<span class="light">{function}</span>
510
511	<span class="light">ColVis#s.</span><b>fnStateChange</b>
512	</div>
513
514	<div class="description">
515	Callback function to tell the user when the state has changed
516
517
518
519	</div>
520
521
522
523
524	<dl class="detailList nomargin">
525
526
527
528
529
530	<dt class="heading">Default Value:</dt>
531	<dd>
532	null
533	</dd>
534
535	</dl>
536
537
538	<div class="hr"></div>
539
540	<a name=".hidden"></a>
541
542	<div class="fixedFont heading">
543	<span class='lighter'>
544	<static>
545	</span>
546
547	<span class="light">{boolean}</span>
548
549	<span class="light">ColVis#s.</span><b>hidden</b>
550	</div>
551
552	<div class="description">
553	Flag to say if the collection is hidden
554
555
556
557	</div>
558
559
560
561
562	<dl class="detailList nomargin">
563
564
565
566
567
568	<dt class="heading">Default Value:</dt>
569	<dd>
570	true
571	</dd>
572
573	</dl>
574
575
576	<div class="hr"></div>
577
578	<a name=".oInit"></a>
579
580	<div class="fixedFont heading">
581	<span class='lighter'>
582	<static>
583	</span>
584
585	<span class="light">{Object}</span>
586
587	<span class="light">ColVis#s.</span><b>oInit</b>
588	</div>
589
590	<div class="description">
591	Customisation object
592
593
594
595	</div>
596
597
598
599
600	<dl class="detailList nomargin">
601
602
603
604
605
606	<dt class="heading">Default Value:</dt>
607	<dd>
608	passed in
609	</dd>
610
611	</dl>
612
613
614	<div class="hr"></div>
615
616	<a name=".sAlign"></a>
617
618	<div class="fixedFont heading">
619	<span class='lighter'>
620	<static>
621	</span>
622
623	<span class="light">{String}</span>
624
625	<span class="light">ColVis#s.</span><b>sAlign</b>
626	</div>
627
628	<div class="description">
629	Position of the collection menu when shown - align "left" or "right"
630
631
632
633	</div>
634
635
636
637
638	<dl class="detailList nomargin">
639
640
641
642
643
644	<dt class="heading">Default Value:</dt>
645	<dd>
646	right
647	</dd>
648
649	</dl>
650
651
652	<div class="hr"></div>
653
654	<a name=".sRestore"></a>
655
656	<div class="fixedFont heading">
657	<span class='lighter'>
658	<static>
659	</span>
660
661	<span class="light">{String}</span>
662
663	<span class="light">ColVis#s.</span><b>sRestore</b>
664	</div>
665
666	<div class="description">
667	Restore button text
668
669
670
671	</div>
672
673
674
675
676	<dl class="detailList nomargin">
677
678
679
680
681
682	<dt class="heading">Default Value:</dt>
683	<dd>
684	Restore original
685	</dd>
686
687	</dl>
688
689
690
691
692	</div>
693	</div>
694
695
696	<!--
697	#### METHOD DETAILS
698	-->
699
700
701	<!--
702	#### EVENT DETAILS
703	-->
704
705	</div>
706	</div>
707	</body>
708	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Update cookies preferences