datatables.net 2.3.3 → 2.3.5

package/js/dataTables.mjs

@@ -1,4 +1,4 @@
-/*! DataTables 2.3.3
+/*! DataTables 2.3.5
  * © SpryMedia Ltd - datatables.net/license
  */
 
@@ -131,6 +131,9 @@ var DataTable = function ( selector, options )
 			this.id = sId;
 		}
 		
+		// Replacing an existing colgroup with our own. Not ideal, but a merge could take a lot of code
+		$this.children('colgroup').remove();
+		
 		/* Create the settings object for this table and set some of the default parameters */
 		var oSettings = $.extend( true, {}, DataTable.models.oSettings, {
 			"sDestroyWidth": $this[0].style.width,
@@ -2899,12 +2902,12 @@ function _fnInvalidate( settings, rowIdx, src, colIdx )
 
 		// Max length string. Its a fairly cheep recalculation, so not worth
 		// something more complicated
-		cols[ colIdx ].maxLenString = null;
+		cols[ colIdx ].wideStrings = null;
 	}
 	else {
 		for ( i=0, iLen=cols.length ; i<iLen ; i++ ) {
 			cols[i].sType = null;
-			cols[i].maxLenString = null;
+			cols[i].wideStrings = null;
 		}
 
 		// Update DataTables special `DT_*` attributes for the row
@@ -3445,6 +3448,14 @@ function _fnDraw( oSettings, ajaxComplete )
 		{
 			var iDataIndex = aiDisplay[j];
 			var aoData = oSettings.aoData[ iDataIndex ];
+
+			// Row has been deleted - can't be displayed
+			if (aoData === null)
+			{
+				continue;
+			}
+
+			// Row node hasn't been created yet
 			if ( aoData.nTr === null )
 			{
 				_fnCreateTr( oSettings, iDataIndex );
@@ -4123,24 +4134,21 @@ function _fnStart( oSettings )
  *     DataTables - may be augmented by developer callbacks
  * @param {function} fn Callback function to run when data is obtained
  */
-function _fnBuildAjax( oSettings, data, fn )
-{
+function _fnBuildAjax(oSettings, data, fn) {
 	var ajaxData;
 	var ajax = oSettings.ajax;
 	var instance = oSettings.oInstance;
-	var callback = function ( json ) {
-		var status = oSettings.jqXHR
-			? oSettings.jqXHR.status
-			: null;
+	var callback = function (json) {
+		var status = oSettings.jqXHR ? oSettings.jqXHR.status : null;
 
-		if ( json === null || (typeof status === 'number' && status == 204 ) ) {
+		if (json === null || (typeof status === 'number' && status == 204)) {
 			json = {};
-			_fnAjaxDataSrc( oSettings, json, [] );
+			_fnAjaxDataSrc(oSettings, json, []);
 		}
 
 		var error = json.error || json.sError;
-		if ( error ) {
-			_fnLog( oSettings, 0, error );
+		if (error) {
+			_fnLog(oSettings, 0, error);
 		}
 
 		// Microsoft often wrap JSON as a string in another JSON object
@@ -4148,30 +4156,27 @@ function _fnBuildAjax( oSettings, data, fn )
 		if (json.d && typeof json.d === 'string') {
 			try {
 				json = JSON.parse(json.d);
-			}
-			catch (e) {
+			} catch (e) {
 				// noop
 			}
 		}
 
 		oSettings.json = json;
 
-		_fnCallbackFire( oSettings, null, 'xhr', [oSettings, json, oSettings.jqXHR], true );
-		fn( json );
+		_fnCallbackFire(oSettings, null, 'xhr', [oSettings, json, oSettings.jqXHR], true);
+		fn(json);
 	};
 
-	if ( $.isPlainObject( ajax ) && ajax.data )
-	{
+	if ($.isPlainObject(ajax) && ajax.data) {
 		ajaxData = ajax.data;
 
-		var newData = typeof ajaxData === 'function' ?
-			ajaxData( data, oSettings ) :  // fn can manipulate data or return
-			ajaxData;                      // an object or array to merge
+		var newData =
+			typeof ajaxData === 'function'
+				? ajaxData(data, oSettings) // fn can manipulate data or return
+				: ajaxData; // an object or array to merge
 
 		// If the function returned something, use that alone
-		data = typeof ajaxData === 'function' && newData ?
-			newData :
-			$.extend( true, data, newData );
+		data = typeof ajaxData === 'function' && newData ? newData : $.extend(true, data, newData);
 
 		// Remove the data property as we've resolved it already and don't want
 		// jQuery to do it again (it is restored at the end of the function)
@@ -4179,50 +4184,53 @@ function _fnBuildAjax( oSettings, data, fn )
 	}
 
 	var baseAjax = {
-		"url": typeof ajax === 'string' ?
-			ajax :
-			'',
-		"data": data,
-		"success": callback,
-		"dataType": "json",
-		"cache": false,
-		"type": oSettings.sServerMethod,
-		"error": function (xhr, error) {
-			var ret = _fnCallbackFire( oSettings, null, 'xhr', [oSettings, null, oSettings.jqXHR], true );
-
-			if ( ret.indexOf(true) === -1 ) {
-				if ( error == "parsererror" ) {
-					_fnLog( oSettings, 0, 'Invalid JSON response', 1 );
+		url: typeof ajax === 'string' ? ajax : '',
+		data: data,
+		success: callback,
+		dataType: 'json',
+		cache: false,
+		type: oSettings.sServerMethod,
+		error: function (xhr, error) {
+			var ret = _fnCallbackFire(
+				oSettings,
+				null,
+				'xhr',
+				[oSettings, null, oSettings.jqXHR],
+				true
+			);
+
+			if (ret.indexOf(true) === -1) {
+				if (error == 'parsererror') {
+					_fnLog(oSettings, 0, 'Invalid JSON response', 1);
 				}
-				else if ( xhr.readyState === 4 ) {
-					_fnLog( oSettings, 0, 'Ajax error', 7 );
+				else if (xhr.readyState === 4) {
+					_fnLog(oSettings, 0, 'Ajax error', 7);
 				}
 			}
 
-			_fnProcessingDisplay( oSettings, false );
+			_fnProcessingDisplay(oSettings, false);
 		}
 	};
 
 	// If `ajax` option is an object, extend and override our default base
-	if ( $.isPlainObject( ajax ) ) {
-		$.extend( baseAjax, ajax )
+	if ($.isPlainObject(ajax)) {
+		$.extend(baseAjax, ajax);
 	}
 
 	// Store the data submitted for the API
 	oSettings.oAjaxData = data;
 
 	// Allow plug-ins and external processes to modify the data
-	_fnCallbackFire( oSettings, null, 'preXhr', [oSettings, data, baseAjax], true );
+	_fnCallbackFire(oSettings, null, 'preXhr', [oSettings, data, baseAjax], true);
 
 	// Custom Ajax option to submit the parameters as a JSON string
 	if (baseAjax.submitAs === 'json' && typeof data === 'object') {
 		baseAjax.data = JSON.stringify(data);
 	}
 
-	if ( typeof ajax === 'function' )
-	{
+	if (typeof ajax === 'function') {
 		// Is a function - let the caller define what needs to be done
-		oSettings.jqXHR = ajax.call( instance, data, callback, oSettings );
+		oSettings.jqXHR = ajax.call(instance, data, callback, oSettings);
 	}
 	else if (ajax.url === '') {
 		// No url, so don't load any data. Just apply an empty data array
@@ -4234,37 +4242,30 @@ function _fnBuildAjax( oSettings, data, fn )
 	}
 	else {
 		// Object to extend the base settings
-		oSettings.jqXHR = $.ajax( baseAjax );
+		oSettings.jqXHR = $.ajax(baseAjax);
 	}
 
 	// Restore for next time around
-	if ( ajaxData ) {
+	if (ajaxData) {
 		ajax.data = ajaxData;
 	}
 }
 
-
 /**
  * Update the table using an Ajax call
  *  @param {object} settings dataTables settings object
  *  @returns {boolean} Block the table drawing or not
  *  @memberof DataTable#oApi
  */
-function _fnAjaxUpdate( settings )
-{
+function _fnAjaxUpdate(settings) {
 	settings.iDraw++;
-	_fnProcessingDisplay( settings, true );
+	_fnProcessingDisplay(settings, true);
 
-	_fnBuildAjax(
-		settings,
-		_fnAjaxParameters( settings ),
-		function(json) {
-			_fnAjaxUpdateDraw( settings, json );
-		}
-	);
+	_fnBuildAjax(settings, _fnAjaxParameters(settings), function (json) {
+		_fnAjaxUpdateDraw(settings, json);
+	});
 }
 
-
 /**
  * Build up the parameters in an object needed for a server-side processing
  * request.
@@ -4272,22 +4273,18 @@ function _fnAjaxUpdate( settings )
  *  @returns {bool} block the table drawing or not
  *  @memberof DataTable#oApi
  */
-function _fnAjaxParameters( settings )
-{
-	var
-		columns = settings.aoColumns,
+function _fnAjaxParameters(settings) {
+	var columns = settings.aoColumns,
 		features = settings.oFeatures,
 		preSearch = settings.oPreviousSearch,
 		preColSearch = settings.aoPreSearchCols,
-		colData = function ( idx, prop ) {
-			return typeof columns[idx][prop] === 'function' ?
-				'function' :
-				columns[idx][prop];
+		colData = function (idx, prop) {
+			return typeof columns[idx][prop] === 'function' ? 'function' : columns[idx][prop];
 		};
 
 	return {
 		draw: settings.iDraw,
-		columns: columns.map( function ( column, i ) {
+		columns: columns.map(function (column, i) {
 			return {
 				data: colData(i, 'mData'),
 				name: column.sName,
@@ -4296,40 +4293,43 @@ function _fnAjaxParameters( settings )
 				search: {
 					value: preColSearch[i].search,
 					regex: preColSearch[i].regex,
-					fixed: Object.keys(column.searchFixed).map( function(name) {
-						return {
-							name: name,
-							term: column.searchFixed[name].toString()
-						}
-					})
+					fixed: Object.keys(column.searchFixed)
+						.map(function (name) {
+							return {
+								name: name,
+								term: typeof column.searchFixed[name] !== 'function'
+									? column.searchFixed[name].toString()
+									: 'function'
+								};
+						})
 				}
 			};
-		} ),
-		order: _fnSortFlatten( settings ).map( function ( val ) {
+		}),
+		order: _fnSortFlatten(settings).map(function (val) {
 			return {
 				column: val.col,
 				dir: val.dir,
 				name: colData(val.col, 'sName')
 			};
-		} ),
+		}),
 		start: settings._iDisplayStart,
-		length: features.bPaginate ?
-			settings._iDisplayLength :
-			-1,
+		length: features.bPaginate ? settings._iDisplayLength : -1,
 		search: {
 			value: preSearch.search,
 			regex: preSearch.regex,
-			fixed: Object.keys(settings.searchFixed).map( function(name) {
-				return {
-					name: name,
-					term: settings.searchFixed[name].toString()
-				}
-			})
+			fixed: Object.keys(settings.searchFixed)
+				.map(function (name) {
+					return {
+						name: name,
+						term: typeof settings.searchFixed[name] !== 'function'
+							? settings.searchFixed[name].toString()
+							: 'function'
+					};
+				})
 		}
 	};
 }
 
-
 /**
  * Data the data from the server (nuking the old) and redraw the table
  *  @param {object} oSettings dataTables settings object
@@ -4341,42 +4341,40 @@ function _fnAjaxParameters( settings )
  *  @param {string} [json.sColumns] Column ordering (sName, comma separated)
  *  @memberof DataTable#oApi
  */
-function _fnAjaxUpdateDraw ( settings, json )
-{
+function _fnAjaxUpdateDraw(settings, json) {
 	var data = _fnAjaxDataSrc(settings, json);
 	var draw = _fnAjaxDataSrcParam(settings, 'draw', json);
 	var recordsTotal = _fnAjaxDataSrcParam(settings, 'recordsTotal', json);
 	var recordsFiltered = _fnAjaxDataSrcParam(settings, 'recordsFiltered', json);
 
-	if ( draw !== undefined ) {
+	if (draw !== undefined) {
 		// Protect against out of sequence returns
-		if ( draw*1 < settings.iDraw ) {
+		if (draw * 1 < settings.iDraw) {
 			return;
 		}
 		settings.iDraw = draw * 1;
 	}
 
 	// No data in returned object, so rather than an array, we show an empty table
-	if ( ! data ) {
+	if (!data) {
 		data = [];
 	}
 
-	_fnClearTable( settings );
-	settings._iRecordsTotal   = parseInt(recordsTotal, 10);
+	_fnClearTable(settings);
+	settings._iRecordsTotal = parseInt(recordsTotal, 10);
 	settings._iRecordsDisplay = parseInt(recordsFiltered, 10);
 
-	for ( var i=0, iLen=data.length ; i<iLen ; i++ ) {
-		_fnAddData( settings, data[i] );
+	for (var i = 0, iLen = data.length; i < iLen; i++) {
+		_fnAddData(settings, data[i]);
 	}
 	settings.aiDisplay = settings.aiDisplayMaster.slice();
 
 	_fnColumnTypes(settings);
-	_fnDraw( settings, true );
-	_fnInitComplete( settings );
-	_fnProcessingDisplay( settings, false );
+	_fnDraw(settings, true);
+	_fnInitComplete(settings);
+	_fnProcessingDisplay(settings, false);
 }
 
-
 /**
  * Get the data from the JSON data source to use for drawing a table. Using
  * `_fnGetObjectDataFn` allows the data to be sourced from a property of the
@@ -4385,11 +4383,10 @@ function _fnAjaxUpdateDraw ( settings, json )
  *  @param  {object} json Data source object / array from the server
  *  @return {array} Array of data to use
  */
-function _fnAjaxDataSrc ( settings, json, write )
-{
+function _fnAjaxDataSrc(settings, json, write) {
 	var dataProp = 'data';
 
-	if ($.isPlainObject( settings.ajax ) && settings.ajax.dataSrc !== undefined) {
+	if ($.isPlainObject(settings.ajax) && settings.ajax.dataSrc !== undefined) {
 		// Could in inside a `dataSrc` object, or not!
 		var dataSrc = settings.ajax.dataSrc;
 
@@ -4402,20 +4399,18 @@ function _fnAjaxDataSrc ( settings, json, write )
 		}
 	}
 
-	if ( ! write ) {
-		if ( dataProp === 'data' ) {
+	if (!write) {
+		if (dataProp === 'data') {
 			// If the default, then we still want to support the old style, and safely ignore
 			// it if possible
 			return json.aaData || json[dataProp];
 		}
 
-		return dataProp !== "" ?
-			_fnGetObjectDataFn( dataProp )( json ) :
-			json;
+		return dataProp !== '' ? _fnGetObjectDataFn(dataProp)(json) : json;
 	}
-	
+
 	// set
-	_fnSetObjectDataFn( dataProp )( json, write );
+	_fnSetObjectDataFn(dataProp)(json, write);
 }
 
 /**
@@ -4425,14 +4420,12 @@ function _fnAjaxDataSrc ( settings, json, write )
  * @param {*} json JSON data
  * @returns Resolved value
  */
-function _fnAjaxDataSrcParam (settings, param, json) {
-	var dataSrc = $.isPlainObject( settings.ajax )
-		? settings.ajax.dataSrc
-		: null;
+function _fnAjaxDataSrcParam(settings, param, json) {
+	var dataSrc = $.isPlainObject(settings.ajax) ? settings.ajax.dataSrc : null;
 
 	if (dataSrc && dataSrc[param]) {
 		// Get from custom location
-		return _fnGetObjectDataFn( dataSrc[param] )( json );
+		return _fnGetObjectDataFn(dataSrc[param])(json);
 	}
 
 	// else - Default behaviour
@@ -4449,9 +4442,7 @@ function _fnAjaxDataSrcParam (settings, param, json) {
 		old = 'iTotalDisplayRecords';
 	}
 
-	return json[old] !== undefined
-		? json[old]
-		: json[param];
+	return json[old] !== undefined ? json[old] : json[param];
 }
 
 
@@ -5390,7 +5381,7 @@ function _fnCalculateColumnWidths ( settings )
 		visibleColumns = _fnGetColumns( settings, 'bVisible' ),
 		tableWidthAttr = table.getAttribute('width'), // from DOM element
 		tableContainer = table.parentNode,
-		i, column, columnIdx;
+		i, j, column, columnIdx;
 		
 	var styleWidth = table.style.width;
 	var containerWidth = _fnWrapperWidth(settings);
@@ -5424,17 +5415,16 @@ function _fnCalculateColumnWidths ( settings )
 		false
 	);
 
-	// Construct a single row, worst case, table with the widest
-	// node in the data, assign any user defined widths, then insert it into
-	// the DOM and allow the browser to do all the hard work of calculating
-	// table widths
+	// Construct a worst case table with the widest, assign any user defined
+	// widths, then insert it into  the DOM and allow the browser to do all
+	// the hard work of calculating table widths
 	var tmpTable = $(table.cloneNode())
 		.css( 'visibility', 'hidden' )
+		.css( 'margin', 0 )
 		.removeAttr( 'id' );
 
 	// Clean up the table body
 	tmpTable.append('<tbody/>')
-	var tr = $('<tr/>').appendTo( tmpTable.find('tbody') );
 
 	// Clone the table header and footer - we can't use the header / footer
 	// from the cloned table, since if scrolling is active, the table's
@@ -5474,23 +5464,37 @@ function _fnCalculateColumnWidths ( settings )
 		}
 	} );
 
-	// Find the widest piece of data for each column and put it into the table
+	// Get the widest strings for each of the visible columns and add them to
+	// our table to create a "worst case"
+	var longestData = [];
+
 	for ( i=0 ; i<visibleColumns.length ; i++ ) {
-		columnIdx = visibleColumns[i];
-		column = columns[ columnIdx ];
-
-		var longest = _fnGetMaxLenString(settings, columnIdx);
-		var autoClass = _ext.type.className[column.sType];
-		var text = longest + column.sContentPadding;
-		var insert = longest.indexOf('<') === -1
-			? document.createTextNode(text)
-			: text
-		
-		$('<td/>')
-			.addClass(autoClass)
-			.addClass(column.sClass)
-			.append(insert)
-			.appendTo(tr);
+		longestData.push(_fnGetWideStrings(settings, visibleColumns[i]));
+	}
+
+	if (longestData.length) {
+		for ( i=0 ; i<longestData[0].length ; i++ ) {
+			var tr = $('<tr/>').appendTo( tmpTable.find('tbody') );
+
+			for ( j=0 ; j<visibleColumns.length ; j++ ) {
+				columnIdx = visibleColumns[j];
+				column = columns[ columnIdx ];
+
+				var longest = longestData[j][i] || '';
+				var autoClass = _ext.type.className[column.sType];
+				var padding = column.sContentPadding || (scrollX ? '-' : '');
+				var text = longest + padding;
+				var insert = longest.indexOf('<') === -1
+					? document.createTextNode(text)
+					: text
+
+				$('<td/>')
+					.addClass(autoClass)
+					.addClass(column.sClass)
+					.append(insert)
+					.appendTo(tr);
+			}
+		}
 	}
 
 	// Tidy the temporary table - remove name attributes so there aren't
@@ -5629,19 +5633,31 @@ function _fnWrapperWidth(settings) {
 }
 
 /**
- * Get the maximum strlen for each data column
+ * Get the widest strings for each column.
+ *
+ * It is very difficult to determine what the widest string actually is due to variable character
+ * width and kerning. Doing an exact calculation with the DOM or even Canvas would kill performance
+ * and this is a critical point, so we use two techniques to determine a collection of the longest
+ * strings from the column, which will likely contain the widest strings:
+ *
+ * 1) Get the top three longest strings from the column
+ * 2) Get the top three widest words (i.e. an unbreakable phrase)
+ *
  *  @param {object} settings dataTables settings object
  *  @param {int} colIdx column of interest
- *  @returns {string} string of the max length
+ *  @returns {string[]} Array of the longest strings
  *  @memberof DataTable#oApi
  */
-function _fnGetMaxLenString( settings, colIdx )
+function _fnGetWideStrings( settings, colIdx )
 {
 	var column = settings.aoColumns[colIdx];
 
-	if (! column.maxLenString) {
-		var s, max='', maxLen = -1;
-	
+	// Do we need to recalculate (i.e. was invalidated), or just use the cached data?
+	if (! column.wideStrings) {
+		var allStrings = [];
+		var collection = [];
+
+		// Create an array with the string information for the column
 		for ( var i=0, iLen=settings.aiDisplayMaster.length ; i<iLen ; i++ ) {
 			var rowIdx = settings.aiDisplayMaster[i];
 			var data = _fnGetRowDisplay(settings, rowIdx)[colIdx];
@@ -5656,21 +5672,49 @@ function _fnGetMaxLenString( settings, colIdx )
 				.replace(/id=".*?"/g, '')
 				.replace(/name=".*?"/g, '');
 
-			s = _stripHtml(cellString)
+			var s = _stripHtml(cellString)
 				.replace( /&nbsp;/g, ' ' );
 	
-			if ( s.length > maxLen ) {
-				// We want the HTML in the string, but the length that
-				// is important is the stripped string
-				max = cellString;
-				maxLen = s.length;
-			}
+			collection.push({
+				str: s,
+				len: s.length
+			});
+
+			allStrings.push(s);
+		}
+
+		// Order and then cut down to the size we need
+		collection
+			.sort(function (a, b) {
+				return b.len - a.len;
+			})
+			.splice(3);
+
+		column.wideStrings = collection.map(function (item) {
+			return item.str;
+		});
+
+		// Longest unbroken string
+		let parts = allStrings.join(' ').split(' ');
+
+		parts.sort(function (a, b) {
+			return b.length - a.length;
+		});
+
+		if (parts.length) {
+			column.wideStrings.push(parts[0]);
+		}
+
+		if (parts.length > 1) {
+			column.wideStrings.push(parts[1]);
 		}
 
-		column.maxLenString = max;
+		if (parts.length > 2) {
+			column.wideStrings.push(parts[3]);
+		}
 	}
 
-	return column.maxLenString;
+	return column.wideStrings;
 }
 
 
@@ -6466,7 +6510,9 @@ function _fnImplementState ( settings, s, callback) {
 
 			// If the api is defined then we need to adjust the columns once the visibility has been changed
 			if (api) {
-				api.columns.adjust();
+				api.one('draw', function () {
+					api.columns.adjust();
+				});
 			}
 		}
 	}
@@ -9009,13 +9055,16 @@ _api_registerPlural( 'columns().titles()', 'column().title()', function (title,
 
 _api_registerPlural( 'columns().types()', 'column().type()', function () {
 	return this.iterator( 'column', function ( settings, column ) {
-		var type = settings.aoColumns[column].sType;
+		var colObj = settings.aoColumns[column]
+		var type = colObj.sType;
 
 		// If the type was invalidated, then resolve it. This actually does
 		// all columns at the moment. Would only happen once if getting all
 		// column's data types.
 		if (! type) {
 			_fnColumnTypes(settings);
+
+			type = colObj.sType;
 		}
 
 		return type;
@@ -10186,7 +10235,7 @@ function cleanHeader(node, className) {
  *  @type string
  *  @default Version number
  */
-DataTable.version = "2.3.3";
+DataTable.version = "2.3.5";
 
 /**
  * Private data store, containing all of the settings objects that are
@@ -10488,8 +10537,8 @@ DataTable.models.oColumn = {
 	 */
 	"sWidthOrig": null,
 
-	/** Cached string which is the longest in the column */
-	maxLenString: null,
+	/** Cached longest strings from a column */
+	wideStrings: null,
 
 	/**
 	 * Store for named searches
@@ -12603,7 +12652,10 @@ function __mlHelper (localeString) {
 			}
 			
 			var formatted = to === null
-				? __mld(dt, 'toDate', 'toJSDate', '')[localeString]()
+				? __mld(dt, 'toDate', 'toJSDate', '')[localeString](
+					navigator.language,
+					{ timeZone: "UTC" }
+				)
 				: __mld(dt, 'format', 'toFormat', 'toISOString', to);
 
 			// XSS protection