X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=webapp%2Fresources%2Fdatatables-1.9.4%2Fextras%2FFixedColumns%2Fdocs%2FFixedColumns.html;fp=webapp%2Fresources%2Fdatatables-1.9.4%2Fextras%2FFixedColumns%2Fdocs%2FFixedColumns.html;h=68c28baaf7c3db8ff66fd181fcf9fcb735fd5b48;hb=9bb6ee99ca7f738fac1087190b5481b8fe6e8d9f;hp=0000000000000000000000000000000000000000;hpb=2e3f6b76be585306f1003d849831840c0adb3360;p=proteocache.git diff --git a/webapp/resources/datatables-1.9.4/extras/FixedColumns/docs/FixedColumns.html b/webapp/resources/datatables-1.9.4/extras/FixedColumns/docs/FixedColumns.html new file mode 100644 index 0000000..68c28ba --- /dev/null +++ b/webapp/resources/datatables-1.9.4/extras/FixedColumns/docs/FixedColumns.html @@ -0,0 +1,282 @@ + + + + + Class: FixedColumns - documentation + + + + + + + + + +
+ + +
+

Class: FixedColumns

+ +
+ FixedColumns v2.0.3 documentation +
+
+ + + +
+

Navigation

+ +
+ + Hiding private elements + (toggle) + +
+
+ + Showing extended elements + (toggle) + +
+
+ +
+ +
+
+
new FixedColumns(oDT, oInit)

When making use of DataTables' x-axis scrolling feature, you may wish to +fix the left most column in place. This plug-in for DataTables provides +exactly this option (note for non-scrolling tables, please use the
+FixedHeader plug-in, which can fix headers, footers and columns). Key +features include: +

    +
  • Freezes the left or right most columns to the side of the table
    • +
  • Option to freeze two or more columns
    • +
  • Full integration with DataTables' scrolling options
    • +
  • Speed - FixedColumns is fast in its operation
    • +

Constructor

+ +
+
Parameters:
+ + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
1
oDTobject

DataTables instance

2
oInitobjectOptional{}

Configuration object for FixedColumns. Options are defined by FixedColumns.defaults

Example:
+
+ 
 	var oTable = $('#example').dataTable( {
+ 		"sScrollX": "100%"
+ 	} );
+ 	new FixedColumns( oTable );
+
+
+

Requires

+
    +
  • module:jQuery
  • module:DataTables
    • +
+ +
+ + +
+ +

Summary

+ +

Namespaces

+
+
defaults

FixedColumns default settings for initialisation

dom

DOM elements used by the class instance

s

Settings object which contains customisable information for FixedColumns instance

+

Properties - static

+ +
+
<static, constant> VERSION :String

FixedColumns version

+

Methods - instance

+ +
+
fnRecalculateHeight(nTr) → {void}

Mark a row such that it's height should be recalculated when using 'semiauto' row +height matching. This function will have no effect when 'none' or 'auto' row height +matching is used.

fnRedrawLayout() → {void}

Recalculate the resizes of the 3x3 grid that FixedColumns uses for display of the table. +This is useful if you update the width of the table container. Note that FixedColumns will +perform this function automatically when the window.resize event is fired.

fnSetRowHeight(nTarget, iHeight) → {void}

Set the height of a given row - provides cross browser compatibility

fnUpdate() → {void}

Update the fixed columns - including headers and footers. Note that FixedColumns will +automatically update the display whenever the host DataTable redraws.

+
+

Events

+
+
draw

Event fired whenever FixedColumns redraws the fixed columns (i.e. clones the table elements from the main DataTable). This will occur whenever the DataTable that the FixedColumns instance is attached does its own draw.

+ +
+
+ + + + +
+ +

Details

+

Properties - static

+
+
<static, constant> VERSION :String

FixedColumns version

+ +
+
+

Methods - instance

+
+
fnRecalculateHeight(nTr) → {void}

Mark a row such that it's height should be recalculated when using 'semiauto' row +height matching. This function will have no effect when 'none' or 'auto' row height +matching is used.

+ +
+
Parameters:
+ + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
1
nTrNode

TR element that should have it's height recalculated

Example:
+
+ 
 	var oTable = $('#example').dataTable( {
+ 		"sScrollX": "100%"
+ 	} );
+ 	var oFC = new FixedColumns( oTable );
+ 	
+ 	// manipulate the table - mark the row as needing an update then update the table
+ 	// this allows the redraw performed by DataTables fnUpdate to recalculate the row
+ 	// height
+ 	oFC.fnRecalculateHeight();
+ 	oTable.fnUpdate( $('#example tbody tr:eq(0)')[0], ["insert date", 1, 2, 3 ... ]);
+
+
+
fnRedrawLayout() → {void}

Recalculate the resizes of the 3x3 grid that FixedColumns uses for display of the table. +This is useful if you update the width of the table container. Note that FixedColumns will +perform this function automatically when the window.resize event is fired.

+ +
+
Example:
+
+ 
 	var oTable = $('#example').dataTable( {
+ 		"sScrollX": "100%"
+ 	} );
+ 	var oFC = new FixedColumns( oTable );
+ 	
+ 	// Resize the table container and then have FixedColumns adjust its layout....
+     $('#content').width( 1200 );
+ 	oFC.fnRedrawLayout();
+
+
+
fnSetRowHeight(nTarget, iHeight) → {void}

Set the height of a given row - provides cross browser compatibility

+ +
+
Parameters:
+ + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
1
nTargetNode

TR element that should have it's height recalculated

2
iHeightint

Height in pixels to set

Example:
+
+ 
 	var oTable = $('#example').dataTable( {
+ 		"sScrollX": "100%"
+ 	} );
+ 	var oFC = new FixedColumns( oTable );
+ 	
+ 	// You may want to do this after manipulating a row in the fixed column
+ 	oFC.fnSetRowHeight( $('#example tbody tr:eq(0)')[0], 50 );
+
+
+
fnUpdate() → {void}

Update the fixed columns - including headers and footers. Note that FixedColumns will +automatically update the display whenever the host DataTable redraws.

+ +
+
Example:
+
+ 
 	var oTable = $('#example').dataTable( {
+ 		"sScrollX": "100%"
+ 	} );
+ 	var oFC = new FixedColumns( oTable );
+ 	
+ 	// at some later point when the table has been manipulated....
+ 	oFC.fnUpdate();
+
+
+ +
+

Events

+
+
draw

Event fired whenever FixedColumns redraws the fixed columns (i.e. clones the table elements from the main DataTable). This will occur whenever the DataTable that the FixedColumns instance is attached does its own draw.

+ +
+
Parameters:
+ + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
1
eevent

jQuery event object

2
oobject

Event parameters from FixedColumns

o.leftCloneobject

Instance's object dom.clone.left for easy reference. This object contains references to the left fixed clumn column's nodes

o.rightCloneobject

Instance's object dom.clone.right for easy reference. This object contains references to the right fixed clumn column's nodes

+ +
+
+
+ +
+ +
+ FixedColumns: Copyright 2010-2011 Allan Jardine, all rights reserved
+ + Documentation generated by JSDoc 3 on + 23th Sep 2012 - 14:27 + with the DataTables template. +
+ + \ No newline at end of file