mirror of
https://github.com/DataTables/DataTables.git
synced 2024-12-02 14:24:11 +01:00
bd804fdcb8
- Showing and hiding details about a row in a child row is very useful and proven to be a popular part of DataTables. This commit provides that ability in the new API and extends it. It also fully modularises the child rows aspects, so it could be removed from the core without effecting any other aspects (it may be moved into a seperate file in future). - This will effectively replace fnOpen, fnClose and fnIsOpen - Added methods: - row( selector, opts ).child() - row( selector, opts ).child( str, class ) - row( selector, opts ).child( str, class ).show() - row( selector, opts ).child( str, class ).hide() - row( selector, opts ).child.show() - row( selector, opts ).child.hide() - row( selector, opts ).child.isShown() - Note that unlike the old API you need to specify the data first, and then use the show() method to show the child row. This allows the details rows to be configured before they are actually shown. - Additionally multiple child rows can be attached to a parent (pass `str` (from above) as an array to use this feature. API plug-ins could use this ability to show fully nested tables. - Not just a string can be passed in now, but also a TR node which will actually be used (rather than put into a nested row), any other type of node (which will be inserted into a wrapper row/cell) or a jQuery object.
298 lines
13 KiB
HTML
298 lines
13 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<link rel="shortcut icon" type="image/ico" href="http://www.datatables.net/media/images/favicon.ico" />
|
|
|
|
<title>DataTables example</title>
|
|
<style type="text/css" title="currentStyle">
|
|
@import "../../media/css/demo_page.css";
|
|
@import "../../media/css/demo_table.css";
|
|
|
|
|
|
tr td.icon {
|
|
background: url('../examples_support/details_open.png') no-repeat center center;
|
|
}
|
|
tr.shown td.icon {
|
|
background: url('../examples_support/details_close.png') no-repeat center center;
|
|
}
|
|
</style>
|
|
<script type="text/javascript" language="javascript" src="../../media/js/jquery.js"></script>
|
|
<script type="text/javascript" language="javascript" src="../../media/js/jquery.dataTables.js"></script>
|
|
<script type="text/javascript" charset="utf-8">
|
|
/* Formatting function for row details */
|
|
function format ( data ) {
|
|
return '<table cellpadding="5" cellspacing="0" border="0" style="padding-left:50px;">' +
|
|
'<tr><td>Rendering engine:</td><td>'+data.engine+' '+data.grade+'</td></tr>' +
|
|
'<tr><td>Link to source:</td><td>Could provide a link here</td></tr>' +
|
|
'<tr><td>Extra info:</td><td>And any further details here (images etc)</td></tr>' +
|
|
'</table>';
|
|
}
|
|
|
|
$(document).ready(function() {
|
|
var table = $('#example').DataTable( {
|
|
"ajax": "../ajax/sources/objects.txt",
|
|
"columns": [
|
|
{
|
|
"sortable": false,
|
|
"className": 'icon',
|
|
"defaultContent": ''
|
|
},
|
|
{ "data": "engine" },
|
|
{ "data": "browser" },
|
|
{ "data": "platform" },
|
|
{ "data": "version" },
|
|
{ "data": "grade" }
|
|
],
|
|
"sorting": [[1, 'asc']],
|
|
initComplete: function () {
|
|
// @todo this should be done automatically by DT for Ajax src
|
|
table.columns.adjust();
|
|
}
|
|
} );
|
|
|
|
// Add event listener for opening and closing details
|
|
$('#example tbody').on('click', 'td.icon', function () {
|
|
var tr = $(this).parents('tr');
|
|
var row = table.row( tr );
|
|
|
|
if ( row.child.isShown() ) {
|
|
// This row is already open - close it
|
|
row.child.hide();
|
|
tr.removeClass('shown');
|
|
}
|
|
else {
|
|
// Open this row
|
|
row.child( format(row.data()) ).show();
|
|
tr.addClass('shown');
|
|
}
|
|
} );
|
|
} );
|
|
</script>
|
|
</head>
|
|
<body id="dt_example">
|
|
<div id="container">
|
|
<div class="full_width big">
|
|
DataTables hidden row details example
|
|
</div>
|
|
|
|
<h1>Preamble</h1>
|
|
<p>DataTables has most features enabled by default, so all you need to do to use it with one of your own tables is to call the construction function (as shown below).</p>
|
|
|
|
<h1>Live example</h1>
|
|
<div id="demo">
|
|
<table cellpadding="0" cellspacing="0" border="0" class="display" id="example">
|
|
<thead>
|
|
<tr>
|
|
<th></th>
|
|
<th>Rendering engine</th>
|
|
<th>Browser</th>
|
|
<th>Platform(s)</th>
|
|
<th>Engine version</th>
|
|
<th>CSS grade</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody></tbody>
|
|
</table>
|
|
</div>
|
|
<div class="spacer"></div>
|
|
|
|
|
|
<h1>Initialisation code</h1>
|
|
<pre class="brush: js;">/* Formating function for row details */
|
|
function fnFormatDetails ( oTable, nTr )
|
|
{
|
|
var aData = oTable.fnGetData( nTr );
|
|
var sOut = '<table cellpadding="5" cellspacing="0" border="0" style="padding-left:50px;">';
|
|
sOut += '<tr><td>Rendering engine:</td><td>'+aData[1]+' '+aData[4]+'</td></tr>';
|
|
sOut += '<tr><td>Link to source:</td><td>Could provide a link here</td></tr>';
|
|
sOut += '<tr><td>Extra info:</td><td>And any further details here (images etc)</td></tr>';
|
|
sOut += '</table>';
|
|
|
|
return sOut;
|
|
}
|
|
|
|
$(document).ready(function() {
|
|
/*
|
|
* Insert a 'details' column to the table
|
|
*/
|
|
var nCloneTh = document.createElement( 'th' );
|
|
var nCloneTd = document.createElement( 'td' );
|
|
nCloneTd.innerHTML = '<img src="../examples_support/details_open.png">';
|
|
nCloneTd.className = "center";
|
|
|
|
$('#example thead tr').each( function () {
|
|
this.insertBefore( nCloneTh, this.childNodes[0] );
|
|
} );
|
|
|
|
$('#example tbody tr').each( function () {
|
|
this.insertBefore( nCloneTd.cloneNode( true ), this.childNodes[0] );
|
|
} );
|
|
|
|
/*
|
|
* Initialse DataTables, with no sorting on the 'details' column
|
|
*/
|
|
var oTable = $('#example').dataTable( {
|
|
"aoColumnDefs": [
|
|
{ "bSortable": false, "aTargets": [ 0 ] }
|
|
],
|
|
"aaSorting": [[1, 'asc']]
|
|
});
|
|
|
|
/* Add event listener for opening and closing details
|
|
* Note that the indicator for showing which row is open is not controlled by DataTables,
|
|
* rather it is done here
|
|
*/
|
|
$('#example tbody td img').live('click', function () {
|
|
var nTr = $(this).parents('tr')[0];
|
|
if ( oTable.fnIsOpen(nTr) )
|
|
{
|
|
/* This row is already open - close it */
|
|
this.src = "../examples_support/details_open.png";
|
|
oTable.fnClose( nTr );
|
|
}
|
|
else
|
|
{
|
|
/* Open this row */
|
|
this.src = "../examples_support/details_close.png";
|
|
oTable.fnOpen( nTr, fnFormatDetails(oTable, nTr), 'details' );
|
|
}
|
|
} );
|
|
} );</pre>
|
|
<style type="text/css">
|
|
@import "../examples_support/syntax/css/shCore.css";
|
|
</style>
|
|
<script type="text/javascript" language="javascript" src="../examples_support/syntax/js/shCore.js"></script>
|
|
|
|
|
|
<h1>Other examples</h1>
|
|
<div class="demo_links">
|
|
<h2>Basic initialisation</h2>
|
|
<ul>
|
|
<li><a href="../basic_init/zero_config.html">Zero configuration</a></li>
|
|
<li><a href="../basic_init/filter_only.html">Feature enablement</a></li>
|
|
<li><a href="../basic_init/table_sorting.html">Sorting data</a></li>
|
|
<li><a href="../basic_init/multi_col_sort.html">Multi-column sorting</a></li>
|
|
<li><a href="../basic_init/multiple_tables.html">Multiple tables</a></li>
|
|
<li><a href="../basic_init/hidden_columns.html">Hidden columns</a></li>
|
|
<li><a href="../basic_init/complex_header.html">Complex headers - grouping with colspan</a></li>
|
|
<li><a href="../basic_init/dom.html">DOM positioning</a></li>
|
|
<li><a href="../basic_init/flexible_width.html">Flexible table width</a></li>
|
|
<li><a href="../basic_init/state_save.html">State saving</a></li>
|
|
<li><a href="../basic_init/alt_pagination.html">Alternative pagination styles</a></li>
|
|
<li>Scrolling: <br>
|
|
<a href="../basic_init/scroll_x.html">Horizontal</a> /
|
|
<a href="../basic_init/scroll_y.html">Vertical</a> /
|
|
<a href="../basic_init/scroll_xy.html">Both</a> /
|
|
<a href="../basic_init/scroll_y_theme.html">Themed</a> /
|
|
<a href="../basic_init/scroll_y_infinite.html">Infinite</a>
|
|
</li>
|
|
<li><a href="../basic_init/language.html">Change language information (internationalisation)</a></li>
|
|
<li><a href="../basic_init/themes.html">ThemeRoller themes (Smoothness)</a></li>
|
|
</ul>
|
|
|
|
<h2>Advanced initialisation</h2>
|
|
<ul>
|
|
<li>Events: <br>
|
|
<a href="../advanced_init/events_live.html">Live events</a> /
|
|
<a href="../advanced_init/events_pre_init.html">Pre-init</a> /
|
|
<a href="../advanced_init/events_post_init.html">Post-init</a>
|
|
</li>
|
|
<li><a href="../advanced_init/column_render.html">Column rendering</a></li>
|
|
<li><a href="../advanced_init/html_sort.html">Sorting without HTML tags</a></li>
|
|
<li><a href="../advanced_init/dom_multiple_elements.html">Multiple table controls (sDom)</a></li>
|
|
<li><a href="../advanced_init/length_menu.html">Defining length menu options</a></li>
|
|
<li><a href="../advanced_init/complex_header.html">Complex headers and hidden columns</a></li>
|
|
<li><a href="../advanced_init/dom_toolbar.html">Custom toolbar (element) around table</a></li>
|
|
<li><a href="../advanced_init/highlight.html">Row highlighting with CSS</a></li>
|
|
<li><a href="../advanced_init/row_grouping.html">Row grouping</a></li>
|
|
<li><a href="../advanced_init/row_callback.html">Row callback</a></li>
|
|
<li><a href="../advanced_init/footer_callback.html">Footer callback</a></li>
|
|
<li><a href="../advanced_init/sorting_control.html">Control sorting direction of columns</a></li>
|
|
<li><a href="../advanced_init/language_file.html">Change language information from a file (internationalisation)</a></li>
|
|
<li><a href="../advanced_init/defaults.html">Setting defaults</a></li>
|
|
<li><a href="../advanced_init/localstorage.html">State saving with localStorage</a></li>
|
|
<li><a href="../advanced_init/dt_events.html">Custom events</a></li>
|
|
</ul>
|
|
|
|
<h2>API</h2>
|
|
<ul>
|
|
<li><a href="../api/add_row.html">Dynamically add a new row</a></li>
|
|
<li><a href="../api/multi_filter.html">Individual column filtering (using "input" elements)</a></li>
|
|
<li><a href="../api/multi_filter_select.html">Individual column filtering (using "select" elements)</a></li>
|
|
<li><a href="../api/highlight.html">Highlight rows and columns</a></li>
|
|
<li><a href="../api/row_details.html">Show and hide details about a particular record</a></li>
|
|
<li><a href="../api/select_row.html">User selectable rows (multiple rows)</a></li>
|
|
<li><a href="../api/select_single_row.html">User selectable rows (single row) and delete rows</a></li>
|
|
<li><a href="../api/editable.html">Editable rows (with jEditable)</a></li>
|
|
<li><a href="../api/form.html">Submit form with elements in table</a></li>
|
|
<li><a href="../api/counter_column.html">Index column (static number column)</a></li>
|
|
<li><a href="../api/show_hide.html">Show and hide columns dynamically</a></li>
|
|
<li><a href="../api/api_in_init.html">API function use in initialisation object (callback)</a></li>
|
|
<li><a href="../api/tabs_and_scrolling.html">DataTables scrolling and tabs</a></li>
|
|
<li><a href="../api/regex.html">Regular expression filtering</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="demo_links">
|
|
<h2>Data sources</h2>
|
|
<ul>
|
|
<li><a href="../data_sources/dom.html">DOM</a></li>
|
|
<li><a href="../data_sources/js_array.html">Javascript array</a></li>
|
|
<li><a href="../data_sources/ajax.html">Ajax source</a></li>
|
|
<li><a href="../data_sources/server_side.html">Server side processing</a></li>
|
|
</ul>
|
|
|
|
<h2>Server-side processing</h2>
|
|
<ul>
|
|
<li><a href="../server_side/server_side.html">Obtain server-side data</a></li>
|
|
<li><a href="../server_side/custom_vars.html">Add extra HTTP variables</a></li>
|
|
<li><a href="../server_side/post.html">Use HTTP POST</a></li>
|
|
<li><a href="../server_side/ids.html">Automatic addition of IDs and classes to rows</a></li>
|
|
<li><a href="../server_side/object_data.html">Reading table data from objects</a></li>
|
|
<li><a href="../server_side/row_details.html">Show and hide details about a particular record</a></li>
|
|
<li><a href="../server_side/select_rows.html">User selectable rows (multiple rows)</a></li>
|
|
<li><a href="../server_side/jsonp.html">JSONP for a cross domain data source</a></li>
|
|
<li><a href="../server_side/editable.html">jEditable integration with DataTables</a></li>
|
|
<li><a href="../server_side/defer_loading.html">Deferred loading of Ajax data</a></li>
|
|
<li><a href="../server_side/pipeline.html">Pipelining data (reduce Ajax calls for paging)</a></li>
|
|
</ul>
|
|
|
|
<h2>Ajax data source</h2>
|
|
<ul>
|
|
<li><a href="../ajax/ajax.html">Ajax sourced data (array of arrays)</a></li>
|
|
<li><a href="../ajax/objects.html">Ajax sourced data (array of objects)</a></li>
|
|
<li><a href="../ajax/defer_render.html">Deferred DOM creation for extra speed</a></li>
|
|
<li><a href="../ajax/null_data_source.html">Empty data source columns</a></li>
|
|
<li><a href="../ajax/custom_data_property.html">Use a data source other than aaData (the default)</a></li>
|
|
<li><a href="../ajax/objects_subarrays.html">Read column data from sub-arrays</a></li>
|
|
<li><a href="../ajax/deep.html">Read column data from deeply nested properties</a></li>
|
|
</ul>
|
|
|
|
<h2>Plug-ins</h2>
|
|
<ul>
|
|
<li><a href="../plug-ins/plugin_api.html">Add custom API functions</a></li>
|
|
<li><a href="../plug-ins/sorting_plugin.html">Sorting and automatic type detection</a></li>
|
|
<li><a href="../plug-ins/sorting_sType.html">Sorting without automatic type detection</a></li>
|
|
<li><a href="../plug-ins/paging_plugin.html">Custom pagination controls</a></li>
|
|
<li><a href="../plug-ins/range_filtering.html">Range filtering / custom filtering</a></li>
|
|
<li><a href="../plug-ins/dom_sort.html">Live DOM sorting</a></li>
|
|
<li><a href="../plug-ins/html_sort.html">Automatic HTML type detection</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div id="footer" class="clear" style="text-align:center;">
|
|
<p>
|
|
Please refer to the <a href="http://www.datatables.net/usage">DataTables documentation</a> for full information about its API properties and methods.<br>
|
|
Additionally, there are a wide range of <a href="http://www.datatables.net/extras">extras</a> and <a href="http://www.datatables.net/plug-ins">plug-ins</a> which extend the capabilities of DataTables.
|
|
</p>
|
|
|
|
<span style="font-size:10px;">
|
|
DataTables designed and created by <a href="http://www.sprymedia.co.uk">Allan Jardine</a> © 2007-2011<br>
|
|
DataTables is dual licensed under the <a href="http://www.datatables.net/license_gpl2">GPL v2 license</a> or a <a href="http://www.datatables.net/license_bsd">BSD (3-point) license</a>.
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |