[weblabels.fsf.org.git] / crm.fsf.org / 20131203 / files / sites / all / modules-old / civicrm / packages / jquery / plugins / DataTables / extras / ColVis / ColVis / media / docs_private / symbols / ColVis#s.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - ColVis#s</title>
		<link href="../css/default.css" type="text/css" rel="stylesheet" media="all" />
	</head>

	<body>
		<div id="header">
</div>

		<div class="index">
			<div class="menu">
				<!-- begin publish.classesIndex -->
				<div align="center"><a href="../index.html">Class Index</a> | <a href="../files.html">File Index</a></div>

<h2 class="heading1">Classes</h2>

<ul class="classList">
	
		<li><a href="../symbols/_global_.html">_global_</a></li>
	
		<li><a href="../symbols/ColVis.html">ColVis</a></li>
	
		<li><a href="../symbols/ColVis%23dom.html">ColVis#dom</a></li>
	
		<li><a href="../symbols/ColVis%23s.html">ColVis#s</a></li>
	
</ul>

				<!-- end publish.classesIndex -->
			</div>
			
			<div class="fineprint" style="clear:both">
				
				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:50 GMT+0100 (BST)<br />
				HTML template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a>
			</div>
		</div>
		
		<div class="content">
			<div class="innerContent">
				<h1 class="classTitle">
					
					Namespace <span>ColVis#s</span>
				</h1>

				<p class="description summary">
					
					
					
				
					Settings object which contains customisable information for ColVis instance
					
					
						<br /><em>Defined in: </em> <a href="../symbols/src/js_ColVis.js.html">ColVis.js</a>.
					
				</p>

				
					<div class="props">
						<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class ColVis#s.">
							<caption>Namespace Summary</caption>
							<thead>
								<tr>
									<th scope="col">Constructor Attributes</th>
									<th scope="col">Constructor Name and Description</th>
								</tr>
							</thead>
							<tbody>
								<tr>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription" >
										<div class="fixedFont">
											<b><a href="../symbols/ColVis%23s.html#constructor">ColVis#s</a></b>
										</div>
										<div class="description"></div>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				

				
					
					
						<div class="props">
							<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class ColVis#s.">
								<caption>Field Summary</caption>
								
								<thead>
									<tr>
										<th scope="col">Field Attributes</th>
										<th scope="col">Field Name and Description</th>
									</tr>
								</thead>
								
								<tbody>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.abOriginal">abOriginal</a></b>
												</div>
												<div class="description">Store the original viisbility settings so they could be restored</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.activate">activate</a></b>
												</div>
												<div class="description">Mode of activation.</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.aiExclude">aiExclude</a></b>
												</div>
												<div class="description">List of columns (integers) which should be excluded from the list</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.bRestore">bRestore</a></b>
												</div>
												<div class="description">Show restore button</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.buttonText">buttonText</a></b>
												</div>
												<div class="description">Text used for the button</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.dt">dt</a></b>
												</div>
												<div class="description">DataTables settings object</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.fnLabel">fnLabel</a></b>
												</div>
												<div class="description">Label callback for column names.</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.fnStateChange">fnStateChange</a></b>
												</div>
												<div class="description">Callback function to tell the user when the state has changed</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.hidden">hidden</a></b>
												</div>
												<div class="description">Flag to say if the collection is hidden</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.iOverlayFade">iOverlayFade</a></b>
												</div>
												<div class="description">Overlay animation duration in mS</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.oInit">oInit</a></b>
												</div>
												<div class="description">Customisation object</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.sAlign">sAlign</a></b>
												</div>
												<div class="description">Position of the collection menu when shown - align "left" or "right"</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.sRestore">sRestore</a></b>
												</div>
												<div class="description">Restore button text</div>
											</td>
										</tr>
									
										<tr>
											<td class="attributes">&lt;static&gt; &nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												ColVis#s.<b><a href="../symbols/ColVis%23s.html#.sSize">sSize</a></b>
												</div>
												<div class="description">Indicate if ColVis should automatically calculate the size of buttons or not.</div>
											</td>
										</tr>
									
								</tbody>
							</table>
						</div>
					
					
					
				

	<!--
	#### METHODS SUMMARY
	-->
				
				
	<!--
	#### EVENTS SUMMARY
	-->
				

	<!--
	#### CONSTRUCTOR DETAILS
	-->
				
					<div class="details props">
						<div class="innerProps">
							<a name="constructor"></a>
							
							<div class="sectionTitle">
								Namespace Detail
							</div>
							
							<div class="fixedFont">
								<b>ColVis#s</b>
							</div>
							
							<div class="description">
								
								
							</div>
							
							
						
							
							
							
						</div>
					</div>
				

	<!--
	#### FIELD DETAILS
	-->
				
					<div class="details props">
						<div class="innerProps">

							<div class="sectionTitle">
								Field Detail
							</div>
							
							
								<a name=".abOriginal"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{Array}</span>
									
									<span class="light">ColVis#s.</span><b>abOriginal</b>							
								</div>
								
								<div class="description">
									Store the original viisbility settings so they could be restored
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												[]
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".activate"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{String}</span>
									
									<span class="light">ColVis#s.</span><b>activate</b>							
								</div>
								
								<div class="description">
									Mode of activation. Can be 'click' or 'mouseover'
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												click
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".aiExclude"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{Array}</span>
									
									<span class="light">ColVis#s.</span><b>aiExclude</b>							
								</div>
								
								<div class="description">
									List of columns (integers) which should be excluded from the list
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												[]
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".bRestore"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{Array}</span>
									
									<span class="light">ColVis#s.</span><b>bRestore</b>							
								</div>
								
								<div class="description">
									Show restore button
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												[]
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".buttonText"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{String}</span>
									
									<span class="light">ColVis#s.</span><b>buttonText</b>							
								</div>
								
								<div class="description">
									Text used for the button
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												Show / hide columns
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".dt"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{Object}</span>
									
									<span class="light">ColVis#s.</span><b>dt</b>							
								</div>
								
								<div class="description">
									DataTables settings object
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												null
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".fnLabel"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{Function}</span>
									
									<span class="light">ColVis#s.</span><b>fnLabel</b>							
								</div>
								
								<div class="description">
									Label callback for column names. Takes three parameters: 1. the column index, 2. the column
title detected by DataTables and 3. the TH node for the column
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												null
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".fnStateChange"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{function}</span>
									
									<span class="light">ColVis#s.</span><b>fnStateChange</b>							
								</div>
								
								<div class="description">
									Callback function to tell the user when the state has changed
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												null
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".hidden"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{boolean}</span>
									
									<span class="light">ColVis#s.</span><b>hidden</b>							
								</div>
								
								<div class="description">
									Flag to say if the collection is hidden
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												true
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".iOverlayFade"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{Integer}</span>
									
									<span class="light">ColVis#s.</span><b>iOverlayFade</b>							
								</div>
								
								<div class="description">
									Overlay animation duration in mS
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												500
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".oInit"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{Object}</span>
									
									<span class="light">ColVis#s.</span><b>oInit</b>							
								</div>
								
								<div class="description">
									Customisation object
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												passed in
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".sAlign"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{String}</span>
									
									<span class="light">ColVis#s.</span><b>sAlign</b>							
								</div>
								
								<div class="description">
									Position of the collection menu when shown - align "left" or "right"
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												right
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".sRestore"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{String}</span>
									
									<span class="light">ColVis#s.</span><b>sRestore</b>							
								</div>
								
								<div class="description">
									Restore button text
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												Restore original
											</dd>
										
									</dl>
								
								
								<div class="hr"></div>
							
								<a name=".sSize"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									<span class="light">{String}</span>
									
									<span class="light">ColVis#s.</span><b>sSize</b>							
								</div>
								
								<div class="description">
									Indicate if ColVis should automatically calculate the size of buttons or not. The default
is for it to do so. Set to "css" to disable the automatic sizing
									
									
									
								</div>
								
								

								
									<dl class="detailList nomargin">
									
										
										
										
										
											<dt class="heading">Default Value:</dt>
											<dd>
												auto
											</dd>
										
									</dl>
								
								
								
							
						</div>
					</div>
				

	<!--
	#### METHOD DETAILS
	-->		
				
				
	<!--
	#### EVENT DETAILS
	-->		
				
			</div>
		</div>
	</body>
</html>
Commit	Line	Data
5a920362	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 Sat Sep 10 2011 10:46:50 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	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#.fnLabel">fnLabel</a></b>
169	</div>
170	<div class="description">Label callback for column names.</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#.fnStateChange">fnStateChange</a></b>
179	</div>
180	<div class="description">Callback function to tell the user when the state has changed</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#.hidden">hidden</a></b>
189	</div>
190	<div class="description">Flag to say if the collection is hidden</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#.iOverlayFade">iOverlayFade</a></b>
199	</div>
200	<div class="description">Overlay animation duration in mS</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#.oInit">oInit</a></b>
209	</div>
210	<div class="description">Customisation object</div>
211	</td>
212	</tr>
213
214	<tr>
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>
219	</div>
220	<div class="description">Position of the collection menu when shown - align "left" or "right"</div>
221	</td>
222	</tr>
223
224	<tr>
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>
229	</div>
230	<div class="description">Restore button text</div>
231	</td>
232	</tr>
233
234	<tr>
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>
239	</div>
240	<div class="description">Indicate if ColVis should automatically calculate the size of buttons or not.</div>
241	</td>
242	</tr>
243
244	</tbody>
245	</table>
246	</div>
247
248
249
250
251
252	<!--
253	#### METHODS SUMMARY
254	-->
255
256
257	<!--
258	#### EVENTS SUMMARY
259	-->
260
261
262	<!--
263	#### CONSTRUCTOR DETAILS
264	-->
265
266	<div class="details props">
267	<div class="innerProps">
268	<a name="constructor"></a>
269
270	<div class="sectionTitle">
271	Namespace Detail
272	</div>
273
274	<div class="fixedFont">
275	<b>ColVis#s</b>
276	</div>
277
278	<div class="description">
279
280
281	</div>
282
283
284
285
286
287
288	</div>
289	</div>
290
291
292	<!--
293	#### FIELD DETAILS
294	-->
295
296	<div class="details props">
297	<div class="innerProps">
298
299	<div class="sectionTitle">
300	Field Detail
301	</div>
302
303
304	<a name=".abOriginal"></a>
305
306	<div class="fixedFont heading">
307	<span class='lighter'>
308	<static>
309	</span>
310
311	<span class="light">{Array}</span>
312
313	<span class="light">ColVis#s.</span><b>abOriginal</b>
314	</div>
315
316	<div class="description">
317	Store the original viisbility settings so they could be restored
318
319
320
321	</div>
322
323
324
325
326	<dl class="detailList nomargin">
327
328
329
330
331
332	<dt class="heading">Default Value:</dt>
333	<dd>
334	[]
335	</dd>
336
337	</dl>
338
339
340	<div class="hr"></div>
341
342	<a name=".activate"></a>
343
344	<div class="fixedFont heading">
345	<span class='lighter'>
346	<static>
347	</span>
348
349	<span class="light">{String}</span>
350
351	<span class="light">ColVis#s.</span><b>activate</b>
352	</div>
353
354	<div class="description">
355	Mode of activation. Can be 'click' or 'mouseover'
356
357
358
359	</div>
360
361
362
363
364	<dl class="detailList nomargin">
365
366
367
368
369
370	<dt class="heading">Default Value:</dt>
371	<dd>
372	click
373	</dd>
374
375	</dl>
376
377
378	<div class="hr"></div>
379
380	<a name=".aiExclude"></a>
381
382	<div class="fixedFont heading">
383	<span class='lighter'>
384	<static>
385	</span>
386
387	<span class="light">{Array}</span>
388
389	<span class="light">ColVis#s.</span><b>aiExclude</b>
390	</div>
391
392	<div class="description">
393	List of columns (integers) which should be excluded from the list
394
395
396
397	</div>
398
399
400
401
402	<dl class="detailList nomargin">
403
404
405
406
407
408	<dt class="heading">Default Value:</dt>
409	<dd>
410	[]
411	</dd>
412
413	</dl>
414
415
416	<div class="hr"></div>
417
418	<a name=".bRestore"></a>
419
420	<div class="fixedFont heading">
421	<span class='lighter'>
422	<static>
423	</span>
424
425	<span class="light">{Array}</span>
426
427	<span class="light">ColVis#s.</span><b>bRestore</b>
428	</div>
429
430	<div class="description">
431	Show restore button
432
433
434
435	</div>
436
437
438
439
440	<dl class="detailList nomargin">
441
442
443
444
445
446	<dt class="heading">Default Value:</dt>
447	<dd>
448	[]
449	</dd>
450
451	</dl>
452
453
454	<div class="hr"></div>
455
456	<a name=".buttonText"></a>
457
458	<div class="fixedFont heading">
459	<span class='lighter'>
460	<static>
461	</span>
462
463	<span class="light">{String}</span>
464
465	<span class="light">ColVis#s.</span><b>buttonText</b>
466	</div>
467
468	<div class="description">
469	Text used for the button
470
471
472
473	</div>
474
475
476
477
478	<dl class="detailList nomargin">
479
480
481
482
483
484	<dt class="heading">Default Value:</dt>
485	<dd>
486	Show / hide columns
487	</dd>
488
489	</dl>
490
491
492	<div class="hr"></div>
493
494	<a name=".dt"></a>
495
496	<div class="fixedFont heading">
497	<span class='lighter'>
498	<static>
499	</span>
500
501	<span class="light">{Object}</span>
502
503	<span class="light">ColVis#s.</span><b>dt</b>
504	</div>
505
506	<div class="description">
507	DataTables settings object
508
509
510
511	</div>
512
513
514
515
516	<dl class="detailList nomargin">
517
518
519
520
521
522	<dt class="heading">Default Value:</dt>
523	<dd>
524	null
525	</dd>
526
527	</dl>
528
529
530	<div class="hr"></div>
531
532	<a name=".fnLabel"></a>
533
534	<div class="fixedFont heading">
535	<span class='lighter'>
536	<static>
537	</span>
538
539	<span class="light">{Function}</span>
540
541	<span class="light">ColVis#s.</span><b>fnLabel</b>
542	</div>
543
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
547
548
549
550	</div>
551
552
553
554
555	<dl class="detailList nomargin">
556
557
558
559
560
561	<dt class="heading">Default Value:</dt>
562	<dd>
563	null
564	</dd>
565
566	</dl>
567
568
569	<div class="hr"></div>
570
571	<a name=".fnStateChange"></a>
572
573	<div class="fixedFont heading">
574	<span class='lighter'>
575	<static>
576	</span>
577
578	<span class="light">{function}</span>
579
580	<span class="light">ColVis#s.</span><b>fnStateChange</b>
581	</div>
582
583	<div class="description">
584	Callback function to tell the user when the state has changed
585
586
587
588	</div>
589
590
591
592
593	<dl class="detailList nomargin">
594
595
596
597
598
599	<dt class="heading">Default Value:</dt>
600	<dd>
601	null
602	</dd>
603
604	</dl>
605
606
607	<div class="hr"></div>
608
609	<a name=".hidden"></a>
610
611	<div class="fixedFont heading">
612	<span class='lighter'>
613	<static>
614	</span>
615
616	<span class="light">{boolean}</span>
617
618	<span class="light">ColVis#s.</span><b>hidden</b>
619	</div>
620
621	<div class="description">
622	Flag to say if the collection is hidden
623
624
625
626	</div>
627
628
629
630
631	<dl class="detailList nomargin">
632
633
634
635
636
637	<dt class="heading">Default Value:</dt>
638	<dd>
639	true
640	</dd>
641
642	</dl>
643
644
645	<div class="hr"></div>
646
647	<a name=".iOverlayFade"></a>
648
649	<div class="fixedFont heading">
650	<span class='lighter'>
651	<static>
652	</span>
653
654	<span class="light">{Integer}</span>
655
656	<span class="light">ColVis#s.</span><b>iOverlayFade</b>
657	</div>
658
659	<div class="description">
660	Overlay animation duration in mS
661
662
663
664	</div>
665
666
667
668
669	<dl class="detailList nomargin">
670
671
672
673
674
675	<dt class="heading">Default Value:</dt>
676	<dd>
677	500
678	</dd>
679
680	</dl>
681
682
683	<div class="hr"></div>
684
685	<a name=".oInit"></a>
686
687	<div class="fixedFont heading">
688	<span class='lighter'>
689	<static>
690	</span>
691
692	<span class="light">{Object}</span>
693
694	<span class="light">ColVis#s.</span><b>oInit</b>
695	</div>
696
697	<div class="description">
698	Customisation object
699
700
701
702	</div>
703
704
705
706
707	<dl class="detailList nomargin">
708
709
710
711
712
713	<dt class="heading">Default Value:</dt>
714	<dd>
715	passed in
716	</dd>
717
718	</dl>
719
720
721	<div class="hr"></div>
722
723	<a name=".sAlign"></a>
724
725	<div class="fixedFont heading">
726	<span class='lighter'>
727	<static>
728	</span>
729
730	<span class="light">{String}</span>
731
732	<span class="light">ColVis#s.</span><b>sAlign</b>
733	</div>
734
735	<div class="description">
736	Position of the collection menu when shown - align "left" or "right"
737
738
739
740	</div>
741
742
743
744
745	<dl class="detailList nomargin">
746
747
748
749
750
751	<dt class="heading">Default Value:</dt>
752	<dd>
753	right
754	</dd>
755
756	</dl>
757
758
759	<div class="hr"></div>
760
761	<a name=".sRestore"></a>
762
763	<div class="fixedFont heading">
764	<span class='lighter'>
765	<static>
766	</span>
767
768	<span class="light">{String}</span>
769
770	<span class="light">ColVis#s.</span><b>sRestore</b>
771	</div>
772
773	<div class="description">
774	Restore button text
775
776
777
778	</div>
779
780
781
782
783	<dl class="detailList nomargin">
784
785
786
787
788
789	<dt class="heading">Default Value:</dt>
790	<dd>
791	Restore original
792	</dd>
793
794	</dl>
795
796
797	<div class="hr"></div>
798
799	<a name=".sSize"></a>
800
801	<div class="fixedFont heading">
802	<span class='lighter'>
803	<static>
804	</span>
805
806	<span class="light">{String}</span>
807
808	<span class="light">ColVis#s.</span><b>sSize</b>
809	</div>
810
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
814
815
816
817	</div>
818
819
820
821
822	<dl class="detailList nomargin">
823
824
825
826
827
828	<dt class="heading">Default Value:</dt>
829	<dd>
830	auto
831	</dd>
832
833	</dl>
834
835
836
837
838	</div>
839	</div>
840
841
842	<!--
843	#### METHOD DETAILS
844	-->
845
846
847	<!--
848	#### EVENT DETAILS
849	-->
850
851	</div>
852	</div>
853	</body>
854	</html>