X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=webapp%2Fresources%2Fdatatables-1.9.4%2Fexamples%2Fplug-ins%2Fplugin_api.html;fp=webapp%2Fresources%2Fdatatables-1.9.4%2Fexamples%2Fplug-ins%2Fplugin_api.html;h=38af8932a9d4722e6d48dfc09b4a2549abb35653;hb=9bb6ee99ca7f738fac1087190b5481b8fe6e8d9f;hp=0000000000000000000000000000000000000000;hpb=2e3f6b76be585306f1003d849831840c0adb3360;p=proteocache.git diff --git a/webapp/resources/datatables-1.9.4/examples/plug-ins/plugin_api.html b/webapp/resources/datatables-1.9.4/examples/plug-ins/plugin_api.html new file mode 100644 index 0000000..38af893 --- /dev/null +++ b/webapp/resources/datatables-1.9.4/examples/plug-ins/plugin_api.html @@ -0,0 +1,668 @@ + + + + + + + DataTables example + + + + + + +
+
+ DataTables new API function plug-in example +
+ +

Preamble

+

DataTables presents a number of useful API functions to the calling code which can be used to manipulate the table data as required. But there are times when DataTables doesn't provide the API function that you want - so for this DataTables allows a method by which custom API functions can be defined (effectively a plug-in). This is done by adding functions the $.fn.dataTableExt.oApi object, which will be registered by DataTables. Each function is passed a single parameter, the settings object for the table in question.

+

In the example below, I present an API function which is used to obtain all of the TR rows which are currently not on display (useful for building a form from the table).

+ +

Live example

+ Click to get hidden rows +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Rendering engineBrowserPlatform(s)Engine versionCSS grade
TridentInternet + Explorer 4.0Win 95+4X
TridentInternet + Explorer 5.0Win 95+5C
TridentInternet + Explorer 5.5Win 95+5.5A
TridentInternet + Explorer 6Win 98+6A
TridentInternet Explorer 7Win XP SP2+7A
TridentAOL browser (AOL desktop)Win XP6A
GeckoFirefox 1.0Win 98+ / OSX.2+1.7A
GeckoFirefox 1.5Win 98+ / OSX.2+1.8A
GeckoFirefox 2.0Win 98+ / OSX.2+1.8A
GeckoFirefox 3.0Win 2k+ / OSX.3+1.9A
GeckoCamino 1.0OSX.2+1.8A
GeckoCamino 1.5OSX.3+1.8A
GeckoNetscape 7.2Win 95+ / Mac OS 8.6-9.21.7A
GeckoNetscape Browser 8Win 98SE+1.7A
GeckoNetscape Navigator 9Win 98+ / OSX.2+1.8A
GeckoMozilla 1.0Win 95+ / OSX.1+1A
GeckoMozilla 1.1Win 95+ / OSX.1+1.1A
GeckoMozilla 1.2Win 95+ / OSX.1+1.2A
GeckoMozilla 1.3Win 95+ / OSX.1+1.3A
GeckoMozilla 1.4Win 95+ / OSX.1+1.4A
GeckoMozilla 1.5Win 95+ / OSX.1+1.5A
GeckoMozilla 1.6Win 95+ / OSX.1+1.6A
GeckoMozilla 1.7Win 98+ / OSX.1+1.7A
GeckoMozilla 1.8Win 98+ / OSX.1+1.8A
GeckoSeamonkey 1.1Win 98+ / OSX.2+1.8A
GeckoEpiphany 2.20Gnome1.8A
WebkitSafari 1.2OSX.3125.5A
WebkitSafari 1.3OSX.3312.8A
WebkitSafari 2.0OSX.4+419.3A
WebkitSafari 3.0OSX.4+522.1A
WebkitOmniWeb 5.5OSX.4+420A
WebkitiPod Touch / iPhoneiPod420.1A
WebkitS60S60413A
PrestoOpera 7.0Win 95+ / OSX.1+-A
PrestoOpera 7.5Win 95+ / OSX.2+-A
PrestoOpera 8.0Win 95+ / OSX.2+-A
PrestoOpera 8.5Win 95+ / OSX.2+-A
PrestoOpera 9.0Win 95+ / OSX.3+-A
PrestoOpera 9.2Win 88+ / OSX.3+-A
PrestoOpera 9.5Win 88+ / OSX.3+-A
PrestoOpera for WiiWii-A
PrestoNokia N800N800-A
PrestoNintendo DS browserNintendo DS8.5C/A1
KHTMLKonqureror 3.1KDE 3.13.1C
KHTMLKonqureror 3.3KDE 3.33.3A
KHTMLKonqureror 3.5KDE 3.53.5A
TasmanInternet Explorer 4.5Mac OS 8-9-X
TasmanInternet Explorer 5.1Mac OS 7.6-91C
TasmanInternet Explorer 5.2Mac OS 8-X1C
MiscNetFront 3.1Embedded devices-C
MiscNetFront 3.4Embedded devices-A
MiscDillo 0.8Embedded devices-X
MiscLinksText only-X
MiscLynxText only-X
MiscIE MobileWindows Mobile 6-C
MiscPSP browserPSP-C
Other browsersAll others--U
Rendering engineBrowserPlatform(s)Engine versionCSS grade
+
+
+ + +

Initialisation code

+ 
/*
+ * Function: fnGetHiddenTrNodes
+ * Purpose:  Get all of the hidden TR nodes (i.e. the ones which aren't on display)
+ * Returns:  array:
+ * Inputs:   object:oSettings - DataTables settings object
+ */
+$.fn.dataTableExt.oApi.fnGetHiddenTrNodes = function ( oSettings )
+{
+	/* Note the use of a DataTables 'private' function thought the 'oApi' object */
+	var anNodes = this.oApi._fnGetTrNodes( oSettings );
+	var anDisplay = $('tbody tr', oSettings.nTable);
+	
+	/* Remove nodes which are being displayed */
+	for ( var i=0 ; i<anDisplay.length ; i++ )
+	{
+		var iIndex = jQuery.inArray( anDisplay[i], anNodes );
+		if ( iIndex != -1 )
+		{
+			anNodes.splice( iIndex, 1 );
+		}
+	}
+	
+	/* Fire back the array to the caller */
+	return anNodes;
+}
+
+/* Init the table and fire off a call to get the hidden nodes. */
+var oTable;
+$(document).ready(function() {
+	var oTable = $('#example').dataTable();
+	
+	$('#button').click( function () {
+		var nHidden = oTable.fnGetHiddenTrNodes();
+		alert( nHidden.length +' nodes were returned' );
+	} );
+} );
+ + + + +

Other examples

+
+

Basic initialisation

+ + +

Advanced initialisation

+ + +

API

+ +
+ +
+

Data sources

+ + +

Server-side processing

+ + +

Ajax data source

+ + +

Plug-ins

+ +
+ + + +
+ + \ No newline at end of file