New: eq() API method to reduce an API instance to just a single context

and result set for the plural methods.

Fix: Row details events were itterating over non-DataTables rows
creating a Javascript error

Fix: Example - Server-side processing row details example updated to be
able to restore the details row on a redraw.

Update: Documentation - Most examples which used `flatten()` are more
correct to use the new `eq()` method, so they have been updated.

- This set of changes is based on the discussion in thread 19377. While
  working on the fix, I realised that the use of flatten() is too broad,
  so the new `eq()` function is introduced. It is similar to the jQuery
  eq() method in that it reduces the instance to just the selected
  index, although in DataTables this is both the context and the result
  set. Its a small addition, but I think it will provide to be very
  useful

.datatables-commit-sync

@@ -1 +1 @@
-848be40591690163c03003346ee3748aec1b0006
+19a4f46a4f58fd7d24197f3ab6b550a4fd29dcae

examples/server_side/row_details.html

@@ -36,7 +36,7 @@ $(document).ready(function() {
 	var dt = $('#example').DataTable( {
 		"processing": true,
 		"serverSide": true,
-		"ajax": "scripts/objects.php",
+		"ajax": "scripts/ids-objects.php",
 		"columns": [ 
 			{
 				"class":          "details-control",
@@ -52,18 +52,37 @@ $(document).ready(function() {
 		"order": [[1, 'asc']]
 	} );
 
+	// Array to track the ids of the details displayed rows
+	var detailRows = [];
+
 	$('#example tbody').on( 'click', 'tr td:first-child', function () {
 		var tr = $(this).parents('tr');
 		var row = dt.row( tr );
+		var idx = $.inArray( tr.attr('id'), detailRows );
 
 		if ( row.child.isShown() ) {
 			tr.removeClass( 'details' );
 			row.child.hide();
+
+			// Remove from the 'open' array
+			detailRows.splice( idx, 1 );
 		}
 		else {
 			tr.addClass( 'details' );
 			row.child( format( row.data() ) ).show();
+
+			// Add to the 'open' array
+			if ( idx === -1 ) {
+				detailRows.push( tr.attr('id') );
 			}
+		}
+	} );
+
+	// On each draw, loop over the `detailRows` array and show any child rows
+	dt.on( 'draw', function () {
+		$.each( detailRows, function ( i, id ) {
+			$('#'+id+' td:first-child').trigger( 'click' );
+		} );
 	} );
 } );
 
@@ -97,6 +116,12 @@ $(document).ready(function() {
 				information to show. Note that the format details function has access to the full data source object
 				for the row, including information that is not actually shown in the table (the salary parameter for
 				example).</p>
+
+				<p>Furthermore, this example shows a small difference from the <a href=
+				"../api/row_details.html">client-side row details example</a> in that to have rows automatically reopen
+				when the table is redrawn, we need to track a unique identifier for each row - in this case the row
+				<code>id</code>. This is required because in server-side processing mode rows are automatically
+				destroyed and recreated on each draw.</p>
 			</div>
 
 			<table id="example" class="display" cellspacing="0" width="100%">
@@ -142,7 +167,7 @@ $(document).ready(function() {
 	var dt = $('#example').DataTable( {
 		&quot;processing&quot;: true,
 		&quot;serverSide&quot;: true,
-		&quot;ajax&quot;: &quot;scripts/objects.php&quot;,
+		&quot;ajax&quot;: &quot;scripts/ids-objects.php&quot;,
 		&quot;columns&quot;: [ 
 			{
 				&quot;class&quot;:          &quot;details-control&quot;,
@@ -158,18 +183,37 @@ $(document).ready(function() {
 		&quot;order&quot;: [[1, 'asc']]
 	} );
 
+	// Array to track the ids of the details displayed rows
+	var detailRows = [];
+
 	$('#example tbody').on( 'click', 'tr td:first-child', function () {
 		var tr = $(this).parents('tr');
 		var row = dt.row( tr );
+		var idx = $.inArray( tr.attr('id'), detailRows );
 
 		if ( row.child.isShown() ) {
 			tr.removeClass( 'details' );
 			row.child.hide();
+
+			// Remove from the 'open' array
+			detailRows.splice( idx, 1 );
 		}
 		else {
 			tr.addClass( 'details' );
 			row.child( format( row.data() ) ).show();
+
+			// Add to the 'open' array
+			if ( idx === -1 ) {
+				detailRows.push( tr.attr('id') );
 			}
+		}
+	} );
+
+	// On each draw, loop over the `detailRows` array and show any child rows
+	dt.on( 'draw', function () {
+		$.each( detailRows, function ( i, id ) {
+			$('#'+id+' td:first-child').trigger( 'click' );
+		} );
 	} );
 } );</code>
 

examples/server_side/scripts/ids-arrays.php

@@ -29,7 +29,16 @@ $primaryKey = 'id';
 // parameter represents the DataTables column identifier. In this case simple
 // indexes + the primary key column for the id
 $columns = array(
-	array( 'db' => 'id',         'dt' => 'DT_RowId' ),
+	array(
+		'db' => 'id',
+		'dt' => 'DT_RowId',
+		'formatter' => function( $d, $row ) {
+			// Technically a DOM id cannot start with an integer, so we prefix
+			// a string. This can also be useful if you have multiple tables
+			// to ensure that the id is unique with a different prefix
+			return 'row_'.$d;
+		}
+	),
 	array( 'db' => 'first_name', 'dt' => 0 ),
 	array( 'db' => 'last_name',  'dt' => 1 ),
 	array( 'db' => 'position',   'dt' => 2 ),

examples/server_side/scripts/ids-objects.php

@@ -29,7 +29,16 @@ $primaryKey = 'id';
 // parameter represents the DataTables column identifier - in this case object
 // parameter names
 $columns = array(
-	array( 'db' => 'id',         'dt' => 'DT_RowId' ),
+	array(
+		'db' => 'id',
+		'dt' => 'DT_RowId',
+		'formatter' => function( $d, $row ) {
+			// Technically a DOM id cannot start with an integer, so we prefix
+			// a string. This can also be useful if you have multiple tables
+			// to ensure that the id is unique with a different prefix
+			return 'row_'.$d;
+		}
+	),
 	array( 'db' => 'first_name', 'dt' => 'first_name' ),
 	array( 'db' => 'last_name',  'dt' => 'last_name' ),
 	array( 'db' => 'position',   'dt' => 'position' ),

media/js/jquery.dataTables.js

@@ -6596,6 +6596,16 @@
 		},
 	
 	
+		eq: function ( idx )
+		{
+			var ctx = this.context;
+	
+			return ctx.length > idx ?
+				new _Api( ctx[idx], this[idx] ) :
+				null;
+		},
+	
+	
 		filter: function ( fn )
 		{
 			var a = [];
@@ -7413,11 +7423,19 @@
 			order  = opts.order,   // applied, current, index (original - compatibility with 1.9)
 			page   = opts.page;    // all, current
 	
+		if ( _fnDataSource( settings ) == 'ssp' ) {
+			// In server-side processing mode, most options are irrelevant since
+			// rows not shown don't exist and the index order is the applied order
+			// Removed is a special case - for consistency just return an empty
+			// array
+			return search === 'removed' ?
+				[] :
+				_range( 0, displayMaster.length );
+		}
+		else if ( page == 'current' ) {
 			// Current page implies that order=current and fitler=applied, since it is
 			// fairly senseless otherwise, regardless of what order and search actually
 			// are
-		if ( page == 'current' )
-		{
 			for ( i=settings._iDisplayStart, ien=settings.fnDisplayEnd() ; i<ien ; i++ ) {
 				a.push( displayFiltered[i] );
 			}
@@ -7749,28 +7767,28 @@
 	
 	var __details_events = function ( settings )
 	{
-		var table = $(settings.nTable);
+		var api = new _Api( settings );
 		var namespace = '.dt.DT_details';
+		var drawEvent = 'draw'+namespace;
+		var colvisEvent = 'column-visibility'+namespace;
 	
-		table.off('draw'+namespace);
+		api.off( drawEvent +' '+ colvisEvent );
-		table.off('column-visibility'+namespace);
 	
 		if ( _pluck( settings.aoData, '_details' ).length > 0 ) {
 			// On each draw, insert the required elements into the document
-			table.on('draw'+namespace, function () {
+			api.on( drawEvent, function () {
-				table.find('tbody tr').each( function () {
+				api.rows( {page:'current'} ).eq(0).each( function (idx) {
-					// Look up the row index for each row and append open row
+					// Internal data grab
-					var rowIdx = _fnNodeToDataIndex( settings, this );
+					var row = settings.aoData[ idx ];
-					var row = settings.aoData[ rowIdx ];
 	
 					if ( row._detailsShow ) {
-						row._details.insertAfter( this );
+						row._details.insertAfter( row.nTr );
 					}
 				} );
 			} );
 	
 			// Column visibility change - update the colspan
-			table.on( 'column-visibility'+namespace, function ( e, settings, idx, vis ) {
+			api.on( colvisEvent, function ( e, settings, idx, vis ) {
 				// Update the colspan for the details rows (note, only if it already has
 				// a colspan)
 				var row, visible = _fnVisbleColumns( settings );