Namespace: defaults

Ancestry: FixedColumns. ยป defaults

FixedColumns v2.0.3 documentation

Navigation

Hiding private elements (toggle)
Showing extended elements (toggle)

FixedColumns default settings for initialisation

Summary

Properties - static

<static> fnDrawCallback :function(object, object):void

Draw callback function which is called when FixedColumns has redrawn the fixed assets

<static> iLeftColumns :int

Number of left hand columns to fix in position

<static> iLeftWidth :int

Width to set for the width of the left fixed column(s) - note that the behaviour of this property is directly effected by the sLeftWidth property. If not defined then this property is calculated automatically from what has been assigned by DataTables.

<static> iRightColumns :int

Number of right hand columns to fix in position

<static> iRightWidth :int

Width to set for the width of the right fixed column(s) - note that the behaviour of this property is directly effected by the sRightWidth property. If not defined then this property is calculated automatically from what has been assigned by DataTables.

<static> sHeightMatch :string

Height matching algorthim to use. This can be "none" which will result in no height matching being applied by FixedColumns (height matching could be forced by CSS in this case), "semiauto" whereby the height calculation will be performed once, and the result cached to be used again (fnRecalculateHeight can be used to force recalculation), or "auto" when height matching is performed on every draw (slowest but must accurate)

<static> sLeftWidth :string

Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth value will be treated as a pixel value, or "relative" for which case iLeftWidth will be treated as a percentage value.

<static> sRightWidth :string

Type of right column size calculation. Can take the values of "fixed", whereby the iRightWidth value will be treated as a pixel value, or "relative" for which case iRightWidth will be treated as a percentage value.

Details

Properties - static

<static> fnDrawCallback :function(object, object):void

Draw callback function which is called when FixedColumns has redrawn the fixed assets

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"fnDrawCallback": function () {
				alert( "FixedColumns redraw" );
			}
 	} );
<static> iLeftColumns :int

Number of left hand columns to fix in position

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"iLeftColumns": 2
 	} );
<static> iLeftWidth :int

Width to set for the width of the left fixed column(s) - note that the behaviour of this property is directly effected by the sLeftWidth property. If not defined then this property is calculated automatically from what has been assigned by DataTables.

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"iLeftWidth": 100 // pixels
 	} );
<static> iRightColumns :int

Number of right hand columns to fix in position

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"iRightColumns": 1
 	} );
<static> iRightWidth :int

Width to set for the width of the right fixed column(s) - note that the behaviour of this property is directly effected by the sRightWidth property. If not defined then this property is calculated automatically from what has been assigned by DataTables.

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"iRightWidth": 200 // pixels
 	} );
<static> sHeightMatch :string

Height matching algorthim to use. This can be "none" which will result in no height matching being applied by FixedColumns (height matching could be forced by CSS in this case), "semiauto" whereby the height calculation will be performed once, and the result cached to be used again (fnRecalculateHeight can be used to force recalculation), or "auto" when height matching is performed on every draw (slowest but must accurate)

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"sHeightMatch": "auto"
 	} );
<static> sLeftWidth :string

Type of left column size calculation. Can take the values of "fixed", whereby the iLeftWidth value will be treated as a pixel value, or "relative" for which case iLeftWidth will be treated as a percentage value.

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"sLeftWidth": "relative",
 		"iLeftWidth": 10 // percentage
 	} );
<static> sRightWidth :string

Type of right column size calculation. Can take the values of "fixed", whereby the iRightWidth value will be treated as a pixel value, or "relative" for which case iRightWidth will be treated as a percentage value.

Example
 	var oTable = $('#example').dataTable( {
 		"sScrollX": "100%"
 	} );
 	new FixedColumns( oTable, {
 		"sRightWidth": "relative",
 		"iRightWidth": 10 // percentage
 	} );