| 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: defaults - 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: defaults</h1> |
| 24 |
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="FixedColumns.html">FixedColumns</a>.</span> ยป defaults</h2> |
| 25 |
<div class="page-info"> |
| 26 |
FixedColumns v2.0.3 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><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Classes (0)</td><td>Namespaces (0)</td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (8)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li><li><a href="#details">Details</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (8)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></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>FixedColumns default settings for initialisation</p><dl class="details"> |
| 56 |
|
| 57 |
</dl> |
| 58 |
|
| 59 |
</div> |
| 60 |
|
| 61 |
|
| 62 |
<div class="doc_summary"> |
| 63 |
<a name="summary"></a> |
| 64 |
<h2>Summary</h2> |
| 65 |
|
| 66 |
<div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3> |
| 67 |
|
| 68 |
<dl> |
| 69 |
<dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnDrawCallback">fnDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :function(object, object):void</span></span></dt><dd class=" even"><p>Draw callback function which is called when FixedColumns has redrawn the fixed assets</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLeftColumns">iLeftColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of left hand columns to fix in position</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLeftWidth">iLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the left fixed column(s) - note that the behaviour of this |
| 70 |
property is directly effected by the sLeftWidth property. If not defined then this property |
| 71 |
is calculated automatically from what has been assigned by DataTables.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iRightColumns">iRightColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of right hand columns to fix in position</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iRightWidth">iRightWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the right fixed column(s) - note that the behaviour of this |
| 72 |
property is directly effected by the sRightWidth property. If not defined then this property |
| 73 |
is calculated automatically from what has been assigned by DataTables.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sHeightMatch">sHeightMatch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Height matching algorthim to use. This can be "none" which will result in no height |
| 74 |
matching being applied by FixedColumns (height matching could be forced by CSS in this |
| 75 |
case), "semiauto" whereby the height calculation will be performed once, and the result |
| 76 |
cached to be used again (fnRecalculateHeight can be used to force recalculation), or |
| 77 |
"auto" when height matching is performed on every draw (slowest but must accurate)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLeftWidth">sLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth |
| 78 |
value will be treated as a pixel value, or "relative" for which case iLeftWidth will be |
| 79 |
treated as a percentage value.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sRightWidth">sRightWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Type of right column size calculation. Can take the values of "fixed", whereby the |
| 80 |
iRightWidth value will be treated as a pixel value, or "relative" for which case |
| 81 |
iRightWidth will be treated as a percentage value.</p></dd> |
| 82 |
</dl></div> |
| 83 |
</div> |
| 84 |
|
| 85 |
|
| 86 |
|
| 87 |
|
| 88 |
<div class="doc_details"> |
| 89 |
<a name="details"></a> |
| 90 |
<h2>Details</h2> |
| 91 |
<div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3> |
| 92 |
<dl> |
| 93 |
<dt class=" even"><a name="fnDrawCallback"></a><a name="fnDrawCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnDrawCallback">fnDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :function(object, object):void</span></span></dt><dd class=" even"><p>Draw callback function which is called when FixedColumns has redrawn the fixed assets</p><div class="collapse_details"><dl class="details"> |
| 94 |
|
| 95 |
</dl> |
| 96 |
<h5>Example</h5> |
| 97 |
<div class="example-code"> |
| 98 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 99 |
"sScrollX": "100%" |
| 100 |
} ); |
| 101 |
new FixedColumns( oTable, { |
| 102 |
"fnDrawCallback": function () { |
| 103 |
alert( "FixedColumns redraw" ); |
| 104 |
} |
| 105 |
} );</pre> |
| 106 |
</div> |
| 107 |
</div></dd><dt class=" odd"><a name="iLeftColumns"></a><a name="iLeftColumns_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLeftColumns">iLeftColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of left hand columns to fix in position</p><div class="collapse_details"><dl class="details"> |
| 108 |
|
| 109 |
</dl> |
| 110 |
<h5>Example</h5> |
| 111 |
<div class="example-code"> |
| 112 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 113 |
"sScrollX": "100%" |
| 114 |
} ); |
| 115 |
new FixedColumns( oTable, { |
| 116 |
"iLeftColumns": 2 |
| 117 |
} );</pre> |
| 118 |
</div> |
| 119 |
</div></dd><dt class=" even"><a name="iLeftWidth"></a><a name="iLeftWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLeftWidth">iLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the left fixed column(s) - note that the behaviour of this |
| 120 |
property is directly effected by the sLeftWidth property. If not defined then this property |
| 121 |
is calculated automatically from what has been assigned by DataTables.</p><div class="collapse_details"><dl class="details"> |
| 122 |
|
| 123 |
</dl> |
| 124 |
<h5>Example</h5> |
| 125 |
<div class="example-code"> |
| 126 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 127 |
"sScrollX": "100%" |
| 128 |
} ); |
| 129 |
new FixedColumns( oTable, { |
| 130 |
"iLeftWidth": 100 // pixels |
| 131 |
} );</pre> |
| 132 |
</div> |
| 133 |
</div></dd><dt class=" odd"><a name="iRightColumns"></a><a name="iRightColumns_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iRightColumns">iRightColumns</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Number of right hand columns to fix in position</p><div class="collapse_details"><dl class="details"> |
| 134 |
|
| 135 |
</dl> |
| 136 |
<h5>Example</h5> |
| 137 |
<div class="example-code"> |
| 138 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 139 |
"sScrollX": "100%" |
| 140 |
} ); |
| 141 |
new FixedColumns( oTable, { |
| 142 |
"iRightColumns": 1 |
| 143 |
} );</pre> |
| 144 |
</div> |
| 145 |
</div></dd><dt class=" even"><a name="iRightWidth"></a><a name="iRightWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iRightWidth">iRightWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Width to set for the width of the right fixed column(s) - note that the behaviour of this |
| 146 |
property is directly effected by the sRightWidth property. If not defined then this property |
| 147 |
is calculated automatically from what has been assigned by DataTables.</p><div class="collapse_details"><dl class="details"> |
| 148 |
|
| 149 |
</dl> |
| 150 |
<h5>Example</h5> |
| 151 |
<div class="example-code"> |
| 152 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 153 |
"sScrollX": "100%" |
| 154 |
} ); |
| 155 |
new FixedColumns( oTable, { |
| 156 |
"iRightWidth": 200 // pixels |
| 157 |
} );</pre> |
| 158 |
</div> |
| 159 |
</div></dd><dt class=" odd"><a name="sHeightMatch"></a><a name="sHeightMatch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sHeightMatch">sHeightMatch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Height matching algorthim to use. This can be "none" which will result in no height |
| 160 |
matching being applied by FixedColumns (height matching could be forced by CSS in this |
| 161 |
case), "semiauto" whereby the height calculation will be performed once, and the result |
| 162 |
cached to be used again (fnRecalculateHeight can be used to force recalculation), or |
| 163 |
"auto" when height matching is performed on every draw (slowest but must accurate)</p><div class="collapse_details"><dl class="details"> |
| 164 |
|
| 165 |
</dl> |
| 166 |
<h5>Example</h5> |
| 167 |
<div class="example-code"> |
| 168 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 169 |
"sScrollX": "100%" |
| 170 |
} ); |
| 171 |
new FixedColumns( oTable, { |
| 172 |
"sHeightMatch": "auto" |
| 173 |
} );</pre> |
| 174 |
</div> |
| 175 |
</div></dd><dt class=" even"><a name="sLeftWidth"></a><a name="sLeftWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLeftWidth">sLeftWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth |
| 176 |
value will be treated as a pixel value, or "relative" for which case iLeftWidth will be |
| 177 |
treated as a percentage value.</p><div class="collapse_details"><dl class="details"> |
| 178 |
|
| 179 |
</dl> |
| 180 |
<h5>Example</h5> |
| 181 |
<div class="example-code"> |
| 182 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 183 |
"sScrollX": "100%" |
| 184 |
} ); |
| 185 |
new FixedColumns( oTable, { |
| 186 |
"sLeftWidth": "relative", |
| 187 |
"iLeftWidth": 10 // percentage |
| 188 |
} );</pre> |
| 189 |
</div> |
| 190 |
</div></dd><dt class=" odd"><a name="sRightWidth"></a><a name="sRightWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sRightWidth">sRightWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Type of right column size calculation. Can take the values of "fixed", whereby the |
| 191 |
iRightWidth value will be treated as a pixel value, or "relative" for which case |
| 192 |
iRightWidth will be treated as a percentage value.</p><div class="collapse_details"><dl class="details"> |
| 193 |
|
| 194 |
</dl> |
| 195 |
<h5>Example</h5> |
| 196 |
<div class="example-code"> |
| 197 |
<pre class="brush: js"> var oTable = $('#example').dataTable( { |
| 198 |
"sScrollX": "100%" |
| 199 |
} ); |
| 200 |
new FixedColumns( oTable, { |
| 201 |
"sRightWidth": "relative", |
| 202 |
"iRightWidth": 10 // percentage |
| 203 |
} );</pre> |
| 204 |
</div> |
| 205 |
</div></dd> |
| 206 |
</dl></div> |
| 207 |
</div> |
| 208 |
|
| 209 |
</div> |
| 210 |
|
| 211 |
<div class="fw_footer"> |
| 212 |
FixedColumns: Copyright 2010-2011 Allan Jardine, all rights reserved<br> |
| 213 |
|
| 214 |
Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on |
| 215 |
23th Sep 2012 - 14:27 |
| 216 |
with the <a href="http://datatables.net/">DataTables</a> template. |
| 217 |
</div> |
| 218 |
</body> |
| 219 |
</html> |
Parent Directory
| 
Revision Log