Subversion Repositories SmartDukaan

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2629 vikas 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2
<html>
3
	<head>
4
		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
5
		<title>Namespace: s - documentation</title>
6
 
7
		<style type="text/css" media="screen">
8
			@import "media/css/doc.css";
9
			@import "media/css/shCore.css";
10
			@import "media/css/shThemeDataTables.css";
11
		</style>
12
 
13
		<script type="text/javascript" src="media/js/shCore.js"></script>
14
		<script type="text/javascript" src="media/js/shBrushJScript.js"></script>
15
		<script type="text/javascript" src="media/js/jquery.js"></script>
16
		<script type="text/javascript" src="media/js/doc.js"></script>
17
	</head>
18
	<body>
19
		<div class="fw_container">
20
 
21
				<a name="top"></a>
22
				<div class="fw_header">
23
					<h1 class="page-title">Namespace: s</h1>
24
					<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="FixedColumns.html">FixedColumns</a></span> ยป s</h2>
25
					<div class="page-info">
26
						FixedColumns v2.0.1 documentation
27
					</div>
28
				</div>
29
 
30
 
31
 
32
				<div class="fw_nav">
33
					<h2>Navigation</h2>
34
					<ul>
35
					<li><a href="#top">Overview</a></li>
36
					<li><a href="#summary">Summary</a><div><a href="#summary_properties">Properties</a></div></li><li><a href="#details">Details</a><div><a href="#details_properties">Properties</a></div></li></ul>
37
					<div style="margin-top: 10px;">
38
						<input type="hidden" name="show_private" value="0">
39
						<span id="private_label">Hiding</span> private elements 
40
							(<a id="private_toggle" href="">toggle</a>)
41
						</span>
42
					</div>
43
					<div>
44
						<input type="hidden" name="show_extended" value="1">
45
						<span id="extended_label">Showing</span> extended elements 
46
							(<a id="extended_toggle" href="">toggle</a>)
47
						</span>
48
					</div>
49
				</div>
50
 
51
				<div class="fw_content">
52
					<a name="overview"></a>
53
					<div class="doc_overview">
54
						<div class="nav_blocker"></div>
55
						<p class="description">Settings object which contains customisable information for FixedColumns instance</p><dl class="details">
56
 
57
 
58
 
59
 
60
 
61
 
62
 
63
 
64
 
65
 
66
 
67
 
68
 
69
</dl><h3 class="subsection-title">Extends</h3>
70
<ul>
71
	<li><a href="FixedColumns.defaults.html">FixedColumns.defaults</a></li>
72
</ul>
73
					</div>
74
 
75
					<div class="doc_summary">
76
						<a name="summary"></a>
77
						<h2>Summary</h2>
78
 
79
						<div class="doc_group"><a name="summary_properties"></a><h3 class="subsection-title">Properties</h3>
80
 
81
<dl>
82
    <dt class="  even"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#aiWidths_details">aiWidths</a></span><span class="type-sig"> :<span class="type-signature">array.&lt;int></span></span></dt><dd class="  even">Original widths of the columns as rendered by DataTables</dd><dt class="  odd"><span class="type-attr">&lt;static, readonly> </span><span class="type-name"><a href="#bOldIE_details">bOldIE</a></span><span class="type-sig"> :<span class="type-signature">boolean</span></span></dt><dd class="  odd">Flag to indicate if we are dealing with IE6/7 as these browsers need a little hack
83
in the odd place</dd><dt class="  even"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#dt_details">dt</a></span><span class="type-sig"> :<span class="type-signature">object</span></span></dt><dd class="  even">DataTables settings objects</dd><dt class=" augmented odd"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#fnDrawCallback_details">fnDrawCallback</a></span><span class="type-sig"> :<span class="type-signature">function(object, object):void</span></span></dt><dd class=" augmented odd"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#fnDrawCallback_details"><img src="media/images/extended.png"></a></div>Draw callback function which is called when FixedColumns has redrawn the fixed assets</dd><dt class=" augmented even"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iLeftColumns_details">iLeftColumns</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented even"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#iLeftColumns_details"><img src="media/images/extended.png"></a></div>Number of left hand columns to fix in position</dd><dt class=" augmented odd"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iLeftWidth_details">iLeftWidth</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented odd"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#iLeftWidth_details"><img src="media/images/extended.png"></a></div>Width to set for the width of the left fixed column(s) - note that the behaviour of this
84
property is directly effected by the sLeftWidth property. If not defined then this property
85
is calculated automatically from what has been assigned by DataTables.</dd><dt class=" augmented even"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iRightColumns_details">iRightColumns</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented even"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#iRightColumns_details"><img src="media/images/extended.png"></a></div>Number of right hand columns to fix in position</dd><dt class=" augmented odd"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iRightWidth_details">iRightWidth</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented odd"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#iRightWidth_details"><img src="media/images/extended.png"></a></div>Width to set for the width of the right fixed column(s) - note that the behaviour of this
86
property is directly effected by the sRightWidth property. If not defined then this property
87
is calculated automatically from what has been assigned by DataTables.</dd><dt class="  even"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iTableColumns_details">iTableColumns</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class="  even">Number of columns in the DataTable - stored for quick access</dd><dt class=" augmented odd"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#sHeightMatch_details">sHeightMatch</a></span><span class="type-sig"> :<span class="type-signature">string</span></span></dt><dd class=" augmented odd"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#sHeightMatch_details"><img src="media/images/extended.png"></a></div>Height matching algorthim to use. This can be "none" which will result in no height
88
matching being applied by FixedColumns (height matching could be forced by CSS in this
89
case), "semiauto" whereby the height calculation will be performed once, and the result
90
cached to be used again (fnRecalculateHeight can be used to force recalculation), or
91
"auto" when height matching is performed on every draw (slowest but must accurate)</dd><dt class=" augmented even"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#sLeftWidth_details">sLeftWidth</a></span><span class="type-sig"> :<span class="type-signature">string</span></span></dt><dd class=" augmented even"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#sLeftWidth_details"><img src="media/images/extended.png"></a></div>Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth
92
value will be treated as a pixel value, or "relative" for which case iLeftWidth will be
93
treated as a percentage value.</dd><dt class=" augmented odd"><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#sRightWidth_details">sRightWidth</a></span><span class="type-sig"> :<span class="type-signature">string</span></span></dt><dd class=" augmented odd"><div class="type-augmented" title="Extended from FixedColumns.defaults"><a href="FixedColumns.defaults.html#sRightWidth_details"><img src="media/images/extended.png"></a></div>Type of right column size calculation. Can take the values of "fixed", whereby the 
94
iRightWidth value will be treated as a pixel value, or "relative" for which case 
95
iRightWidth will be treated as a percentage value.</dd>
96
</dl></div>
97
					</div>
98
 
99
 
100
					<div class="doc_details">
101
						<a name="details"></a>
102
						<h2>Details</h2>
103
						<div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties</h3>
104
<dl>
105
    <dt class="  even"><a name="aiWidths_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#aiWidths_details">aiWidths</a></span><span class="type-sig"> :<span class="type-signature">array.&lt;int></span></span></dt><dd class="  even"><p class="description">Original widths of the columns as rendered by DataTables</p><dl class="details">
106
 
107
 
108
 
109
 
110
 
111
 
112
 
113
 
114
 
115
 
116
 
117
 
118
 
119
</dl></dd><dt class="  odd"><a name="bOldIE_details"></a><span class="type-attr">&lt;static, readonly> </span><span class="type-name"><a href="#bOldIE_details">bOldIE</a></span><span class="type-sig"> :<span class="type-signature">boolean</span></span></dt><dd class="  odd"><p class="description">Flag to indicate if we are dealing with IE6/7 as these browsers need a little hack
120
in the odd place</p><dl class="details">
121
 
122
 
123
 
124
 
125
 
126
 
127
 
128
 
129
 
130
 
131
 
132
 
133
 
134
</dl></dd><dt class="  even"><a name="dt_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#dt_details">dt</a></span><span class="type-sig"> :<span class="type-signature">object</span></span></dt><dd class="  even"><p class="description">DataTables settings objects</p><dl class="details">
135
 
136
 
137
 
138
 
139
 
140
 
141
 
142
 
143
 
144
 
145
 
146
 
147
 
148
</dl></dd><dt class=" augmented odd"><a name="fnDrawCallback_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#fnDrawCallback_details">fnDrawCallback</a></span><span class="type-sig"> :<span class="type-signature">function(object, object):void</span></span></dt><dd class=" augmented odd"><p class="description">Draw callback function which is called when FixedColumns has redrawn the fixed assets</p><dl class="details">
149
 
150
 
151
 
152
 
153
 
154
 
155
 
156
 
157
 
158
 
159
 
160
 
161
 
162
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
163
    <div class="example-code">
164
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
165
 		"sScrollX": "100%"
166
 	} );
167
 	new FixedColumns( oTable, {
168
 		"fnDrawCallback": function () {
169
				alert( "FixedColumns redraw" );
170
			}
171
 	} );</pre>
172
    </div>
173
</dd><dt class=" augmented even"><a name="iLeftColumns_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iLeftColumns_details">iLeftColumns</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented even"><p class="description">Number of left hand columns to fix in position</p><dl class="details">
174
 
175
 
176
 
177
 
178
 
179
 
180
 
181
 
182
 
183
 
184
 
185
 
186
 
187
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
188
    <div class="example-code">
189
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
190
 		"sScrollX": "100%"
191
 	} );
192
 	new FixedColumns( oTable, {
193
 		"iLeftColumns": 2
194
 	} );</pre>
195
    </div>
196
</dd><dt class=" augmented odd"><a name="iLeftWidth_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iLeftWidth_details">iLeftWidth</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented odd"><p class="description">Width to set for the width of the left fixed column(s) - note that the behaviour of this
197
property is directly effected by the sLeftWidth property. If not defined then this property
198
is calculated automatically from what has been assigned by DataTables.</p><dl class="details">
199
 
200
 
201
 
202
 
203
 
204
 
205
 
206
 
207
 
208
 
209
 
210
 
211
 
212
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
213
    <div class="example-code">
214
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
215
 		"sScrollX": "100%"
216
 	} );
217
 	new FixedColumns( oTable, {
218
 		"iLeftWidth": 100 // pixels
219
 	} );</pre>
220
    </div>
221
</dd><dt class=" augmented even"><a name="iRightColumns_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iRightColumns_details">iRightColumns</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented even"><p class="description">Number of right hand columns to fix in position</p><dl class="details">
222
 
223
 
224
 
225
 
226
 
227
 
228
 
229
 
230
 
231
 
232
 
233
 
234
 
235
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
236
    <div class="example-code">
237
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
238
 		"sScrollX": "100%"
239
 	} );
240
 	new FixedColumns( oTable, {
241
 		"iRightColumns": 1
242
 	} );</pre>
243
    </div>
244
</dd><dt class=" augmented odd"><a name="iRightWidth_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iRightWidth_details">iRightWidth</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class=" augmented odd"><p class="description">Width to set for the width of the right fixed column(s) - note that the behaviour of this
245
property is directly effected by the sRightWidth property. If not defined then this property
246
is calculated automatically from what has been assigned by DataTables.</p><dl class="details">
247
 
248
 
249
 
250
 
251
 
252
 
253
 
254
 
255
 
256
 
257
 
258
 
259
 
260
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
261
    <div class="example-code">
262
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
263
 		"sScrollX": "100%"
264
 	} );
265
 	new FixedColumns( oTable, {
266
 		"iRightWidth": 200 // pixels
267
 	} );</pre>
268
    </div>
269
</dd><dt class="  even"><a name="iTableColumns_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#iTableColumns_details">iTableColumns</a></span><span class="type-sig"> :<span class="type-signature">int</span></span></dt><dd class="  even"><p class="description">Number of columns in the DataTable - stored for quick access</p><dl class="details">
270
 
271
 
272
 
273
 
274
 
275
 
276
 
277
 
278
 
279
 
280
 
281
 
282
 
283
</dl></dd><dt class=" augmented odd"><a name="sHeightMatch_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#sHeightMatch_details">sHeightMatch</a></span><span class="type-sig"> :<span class="type-signature">string</span></span></dt><dd class=" augmented odd"><p class="description">Height matching algorthim to use. This can be "none" which will result in no height
284
matching being applied by FixedColumns (height matching could be forced by CSS in this
285
case), "semiauto" whereby the height calculation will be performed once, and the result
286
cached to be used again (fnRecalculateHeight can be used to force recalculation), or
287
"auto" when height matching is performed on every draw (slowest but must accurate)</p><dl class="details">
288
 
289
 
290
 
291
 
292
 
293
 
294
 
295
 
296
 
297
 
298
 
299
 
300
 
301
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
302
    <div class="example-code">
303
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
304
 		"sScrollX": "100%"
305
 	} );
306
 	new FixedColumns( oTable, {
307
 		"sHeightMatch": "auto"
308
 	} );</pre>
309
    </div>
310
</dd><dt class=" augmented even"><a name="sLeftWidth_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#sLeftWidth_details">sLeftWidth</a></span><span class="type-sig"> :<span class="type-signature">string</span></span></dt><dd class=" augmented even"><p class="description">Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth
311
value will be treated as a pixel value, or "relative" for which case iLeftWidth will be
312
treated as a percentage value.</p><dl class="details">
313
 
314
 
315
 
316
 
317
 
318
 
319
 
320
 
321
 
322
 
323
 
324
 
325
 
326
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
327
    <div class="example-code">
328
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
329
 		"sScrollX": "100%"
330
 	} );
331
 	new FixedColumns( oTable, {
332
 		"sLeftWidth": "relative",
333
 		"iLeftWidth": 10 // percentage
334
 	} );</pre>
335
    </div>
336
</dd><dt class=" augmented odd"><a name="sRightWidth_details"></a><span class="type-attr">&lt;static> </span><span class="type-name"><a href="#sRightWidth_details">sRightWidth</a></span><span class="type-sig"> :<span class="type-signature">string</span></span></dt><dd class=" augmented odd"><p class="description">Type of right column size calculation. Can take the values of "fixed", whereby the 
337
iRightWidth value will be treated as a pixel value, or "relative" for which case 
338
iRightWidth will be treated as a percentage value.</p><dl class="details">
339
 
340
 
341
 
342
 
343
 
344
 
345
 
346
 
347
 
348
 
349
 
350
 
351
 
352
</dl><h5>Extended from:</h5><div class="extended"><a href="FixedColumns.defaults.html"><img src="media/images/extended.png"> FixedColumns.defaults</a></div><h5>Example</h5>
353
    <div class="example-code">
354
    	<pre class="brush: js"> 	var oTable = $('#example').dataTable( {
355
 		"sScrollX": "100%"
356
 	} );
357
 	new FixedColumns( oTable, {
358
 		"sRightWidth": "relative",
359
 		"iRightWidth": 10 // percentage
360
 	} );</pre>
361
    </div>
362
</dd>
363
</dl></div>
364
   				</div>
365
   			</div>
366
 
367
		</div>
368
 
369
		<div class="fw_footer">
370
			FixedColumns: Copyright 2010-2011 Allan Jardine, all rights reserved<br>
371
 
372
			Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
373
			26th Jun 2011 - 09:40
374
			with the <a href="http://datatables.net/">DataTables</a> template.
375
		</div>
376
	</body>
377
</html>