rooty/DataTables
1
0
Fork 0
mirror of https://github.com/DataTables/DataTables.git synced 2025-01-30 23:52:11 +01:00
Code Issues Releases Activity

Dev: Remove trailing white space

Browse Source 
- JSHint flagging warnings on trailing whitespace, so tidying up. Boring
  commit, but these things must be done!
This commit is contained in:
Allan Jardine 2013-02-17 17:59:27 +00:00
parent 6e012c8ee1
commit 4c4bfb04b8
25 changed files with 852 additions and 852 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

852
media/js/jquery.dataTables.js vendored
View File

@ -84,7 +84,7 @@
* Create a mapping object that allows camel case parameters to be looked up * Create a mapping object that allows camel case parameters to be looked up
* for their Hungarian counterparts. The mapping is stored in a private * for their Hungarian counterparts. The mapping is stored in a private
* parameter called `_hungaianMap` which can be accessed on the source object. * parameter called `_hungaianMap` which can be accessed on the source object.
* @param {object} o * @param {object} o
* @memberof DataTable#oApi * @memberof DataTable#oApi
*/ */
function _fnHungarianMap ( o ) function _fnHungarianMap ( o )
@ -347,7 +347,7 @@
/** /**
* Adjust the table column widths for new data. Note: you would probably want to * Adjust the table column widths for new data. Note: you would probably want to
* do a redraw after calling this function! * do a redraw after calling this function!
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @memberof DataTable#oApi * @memberof DataTable#oApi
@ -418,7 +418,7 @@
/** /**
* Get an array of column indexes that match a given property * Get an array of column indexes that match a given property
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @param {string} sParam Parameter in aoColumns to look for - typically * @param {string} sParam Parameter in aoColumns to look for - typically
* bVisible or bSearchable * bVisible or bSearchable
* @returns {array} Array of indexes with matched properties * @returns {array} Array of indexes with matched properties
* @memberof DataTable#oApi * @memberof DataTable#oApi
@ -555,7 +555,7 @@
} }
/** /**
* Add a data array to the table, creating DOM node etc. This is the parallel to * Add a data array to the table, creating DOM node etc. This is the parallel to
* _fnGatherData, but for adding rows from a Javascript source, rather than a * _fnGatherData, but for adding rows from a Javascript source, rather than a
* DOM source. * DOM source.
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
@ -1034,7 +1034,7 @@
/** /**
* Take an array of integers (index array) and remove a target integer (value - not * Take an array of integers (index array) and remove a target integer (value - not
* the key!) * the key!)
* @param {array} a Index array to target * @param {array} a Index array to target
* @param {int} iTarget value to find * @param {int} iTarget value to find
@ -1205,7 +1205,7 @@
_fnDetectHeader( oSettings.aoHeader, oSettings.nTHead ); _fnDetectHeader( oSettings.aoHeader, oSettings.nTHead );
} }
/* ARIA role for the rows */ /* ARIA role for the rows */
$(oSettings.nTHead).children('tr').attr('role', 'row'); $(oSettings.nTHead).children('tr').attr('role', 'row');
/* Add the extra markup needed by jQuery UI's themes */ /* Add the extra markup needed by jQuery UI's themes */
@ -1270,13 +1270,13 @@
* Draw the header (or footer) element based on the column visibility states. The * Draw the header (or footer) element based on the column visibility states. The
* methodology here is to use the layout array from _fnDetectHeader, modified for * methodology here is to use the layout array from _fnDetectHeader, modified for
* the instantaneous column visibility, to construct the new layout. The grid is * the instantaneous column visibility, to construct the new layout. The grid is
* traversed over cell at a time in a rows x columns grid fashion, although each * traversed over cell at a time in a rows x columns grid fashion, although each
* cell insert can cover multiple elements in the grid - which is tracks using the * cell insert can cover multiple elements in the grid - which is tracks using the
* aApplied array. Cell inserts in the grid will only occur where there isn't * aApplied array. Cell inserts in the grid will only occur where there isn't
* already a cell in that position. * already a cell in that position.
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @param array {objects} aoSource Layout array from _fnDetectHeader * @param array {objects} aoSource Layout array from _fnDetectHeader
* @param {boolean} [bIncludeHidden=false] If true then include the hidden columns in the calc, * @param {boolean} [bIncludeHidden=false] If true then include the hidden columns in the calc,
* @memberof DataTable#oApi * @memberof DataTable#oApi
*/ */
function _fnDrawHead( oSettings, aoSource, bIncludeHidden ) function _fnDrawHead( oSettings, aoSource, bIncludeHidden )
@ -1453,7 +1453,7 @@
} }
/* Row callback functions - might want to manipulate the row */ /* Row callback functions - might want to manipulate the row */
_fnCallbackFire( oSettings, 'aoRowCallback', null, _fnCallbackFire( oSettings, 'aoRowCallback', null,
[nRow, oSettings.aoData[ oSettings.aiDisplay[j] ]._aData, iRowCount, j] ); [nRow, oSettings.aoData[ oSettings.aiDisplay[j] ]._aData, iRowCount, j] );
anRows.push( nRow ); anRows.push( nRow );
@ -1501,15 +1501,15 @@
} }
/* Header and footer callbacks */ /* Header and footer callbacks */
_fnCallbackFire( oSettings, 'aoHeaderCallback', 'header', [ $(oSettings.nTHead).children('tr')[0], _fnCallbackFire( oSettings, 'aoHeaderCallback', 'header', [ $(oSettings.nTHead).children('tr')[0],
_fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] ); _fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] );
_fnCallbackFire( oSettings, 'aoFooterCallback', 'footer', [ $(oSettings.nTFoot).children('tr')[0], _fnCallbackFire( oSettings, 'aoFooterCallback', 'footer', [ $(oSettings.nTFoot).children('tr')[0],
_fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] ); _fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] );
/* /*
* Need to remove any old row from the display - note we can't just empty the tbody using * Need to remove any old row from the display - note we can't just empty the tbody using
* $().html('') since this will unbind the jQuery event handlers (even although the node * $().html('') since this will unbind the jQuery event handlers (even although the node
* still exists!) - equally we can't use innerHTML, since IE throws an exception. * still exists!) - equally we can't use innerHTML, since IE throws an exception.
*/ */
var var
@ -1526,7 +1526,7 @@
* up. When not infinite scroll, always do it. * up. When not infinite scroll, always do it.
*/ */
if ( !oSettings.oScroll.bInfinite || !oSettings._bInitComplete || if ( !oSettings.oScroll.bInfinite || !oSettings._bInitComplete ||
oSettings.bSorted || oSettings.bFiltered ) oSettings.bSorted || oSettings.bFiltered )
{ {
while( (n = oSettings.nTBody.firstChild) ) while( (n = oSettings.nTBody.firstChild) )
{ {
@ -1605,7 +1605,7 @@
var nHolding = $('<div></div>')[0]; var nHolding = $('<div></div>')[0];
oSettings.nTable.parentNode.insertBefore( nHolding, oSettings.nTable ); oSettings.nTable.parentNode.insertBefore( nHolding, oSettings.nTable );
/* /*
* All DataTables are wrapped in a div * All DataTables are wrapped in a div
*/ */
oSettings.nTableWrapper = $('<div id="'+oSettings.sTableId+'_wrapper" class="'+oSettings.oClasses.sWrapper+'" role="grid"></div>')[0]; oSettings.nTableWrapper = $('<div id="'+oSettings.sTableId+'_wrapper" class="'+oSettings.oClasses.sWrapper+'" role="grid"></div>')[0];
@ -1798,7 +1798,7 @@
iColspan = (!iColspan || iColspan===0 || iColspan===1) ? 1 : iColspan; iColspan = (!iColspan || iColspan===0 || iColspan===1) ? 1 : iColspan;
iRowspan = (!iRowspan || iRowspan===0 || iRowspan===1) ? 1 : iRowspan; iRowspan = (!iRowspan || iRowspan===0 || iRowspan===1) ? 1 : iRowspan;
/* There might be colspan cells already in this row, so shift our target /* There might be colspan cells already in this row, so shift our target
* accordingly * accordingly
*/ */
iColShifted = fnShiftCol( aLayout, i, iColumn ); iColShifted = fnShiftCol( aLayout, i, iColumn );
@ -1850,7 +1850,7 @@
{ {
for ( var j=0, jLen=aLayout[i].length ; j<jLen ; j++ ) for ( var j=0, jLen=aLayout[i].length ; j<jLen ; j++ )
{ {
if ( aLayout[i][j].unique && if ( aLayout[i][j].unique &&
(!aReturn[j] || !oSettings.bSortCellsTop) ) (!aReturn[j] || !oSettings.bSortCellsTop) )
{ {
aReturn[j] = aLayout[i][j].cell; aReturn[j] = aLayout[i][j].cell;
@ -2171,11 +2171,11 @@
/* Now do the filter */ /* Now do the filter */
if ( val != oPreviousSearch.sSearch ) if ( val != oPreviousSearch.sSearch )
{ {
_fnFilterComplete( oSettings, { _fnFilterComplete( oSettings, {
"sSearch": val, "sSearch": val,
"bRegex": oPreviousSearch.bRegex, "bRegex": oPreviousSearch.bRegex,
"bSmart": oPreviousSearch.bSmart , "bSmart": oPreviousSearch.bSmart ,
"bCaseInsensitive": oPreviousSearch.bCaseInsensitive "bCaseInsensitive": oPreviousSearch.bCaseInsensitive
} ); } );
} }
} ); } );
@ -2224,7 +2224,7 @@
/* Now do the individual column filter */ /* Now do the individual column filter */
for ( var i=0 ; i<oSettings.aoPreSearchCols.length ; i++ ) for ( var i=0 ; i<oSettings.aoPreSearchCols.length ; i++ )
{ {
_fnFilterColumn( oSettings, aoPrevSearch[i].sSearch, i, aoPrevSearch[i].bRegex, _fnFilterColumn( oSettings, aoPrevSearch[i].sSearch, i, aoPrevSearch[i].bRegex,
aoPrevSearch[i].bSmart, aoPrevSearch[i].bCaseInsensitive ); aoPrevSearch[i].bSmart, aoPrevSearch[i].bCaseInsensitive );
} }
@ -2355,9 +2355,9 @@
else else
{ {
/* /*
* We are starting a new search or the new search string is smaller * We are starting a new search or the new search string is smaller
* then the old one (i.e. delete). Search from the master array * then the old one (i.e. delete). Search from the master array
*/ */
if ( oSettings.aiDisplay.length == oSettings.aiDisplayMaster.length || if ( oSettings.aiDisplay.length == oSettings.aiDisplayMaster.length ||
oPrevSearch.sSearch.length > sInput.length || iForce == 1 || oPrevSearch.sSearch.length > sInput.length || iForce == 1 ||
sInput.indexOf(oPrevSearch.sSearch) !== 0 ) sInput.indexOf(oPrevSearch.sSearch) !== 0 )
@ -2369,7 +2369,7 @@
_fnBuildSearchArray( oSettings, 1 ); _fnBuildSearchArray( oSettings, 1 );
/* Search through all records to populate the search array /* Search through all records to populate the search array
* The the oSettings.aiDisplayMaster and asDataSearch arrays have 1 to 1 * The the oSettings.aiDisplayMaster and asDataSearch arrays have 1 to 1
* mapping * mapping
*/ */
for ( i=0 ; i<oSettings.aiDisplayMaster.length ; i++ ) for ( i=0 ; i<oSettings.aiDisplayMaster.length ; i++ )
@ -2379,24 +2379,24 @@
oSettings.aiDisplay.push( oSettings.aiDisplayMaster[i] ); oSettings.aiDisplay.push( oSettings.aiDisplayMaster[i] );
} }
} }
} }
else else
{ {
/* Using old search array - refine it - do it this way for speed /* Using old search array - refine it - do it this way for speed
* Don't have to search the whole master array again * Don't have to search the whole master array again
*/ */
var iIndexCorrector = 0; var iIndexCorrector = 0;
/* Search the current results */ /* Search the current results */
for ( i=0 ; i<oSettings.asDataSearch.length ; i++ ) for ( i=0 ; i<oSettings.asDataSearch.length ; i++ )
{ {
if ( ! rpSearch.test(oSettings.asDataSearch[i]) ) if ( ! rpSearch.test(oSettings.asDataSearch[i]) )
{ {
oSettings.aiDisplay.splice( i-iIndexCorrector, 1 ); oSettings.aiDisplay.splice( i-iIndexCorrector, 1 );
iIndexCorrector++; iIndexCorrector++;
} }
} }
} }
} }
} }
@ -2416,8 +2416,8 @@
var aiFilterColumns = _fnGetColumns( oSettings, 'bSearchable' ); var aiFilterColumns = _fnGetColumns( oSettings, 'bSearchable' );
var aiIndex = (iMaster===1) ? var aiIndex = (iMaster===1) ?
oSettings.aiDisplayMaster : oSettings.aiDisplayMaster :
oSettings.aiDisplay; oSettings.aiDisplay;
for ( var i=0, iLen=aiIndex.length ; i<iLen ; i++ ) for ( var i=0, iLen=aiIndex.length ; i<iLen ; i++ )
{ {
@ -2605,7 +2605,7 @@
if ( oLang.fnInfoCallback !== null ) if ( oLang.fnInfoCallback !== null )
{ {
sOut = oLang.fnInfoCallback.call( oSettings.oInstance, sOut = oLang.fnInfoCallback.call( oSettings.oInstance,
oSettings, iStart, iEnd, iMax, iTotal, sOut ); oSettings, iStart, iEnd, iMax, iTotal, sOut );
} }
@ -2781,7 +2781,7 @@
var i, iLen; var i, iLen;
var aLengthMenu = oSettings.aLengthMenu; var aLengthMenu = oSettings.aLengthMenu;
if ( aLengthMenu.length == 2 && typeof aLengthMenu[0] === 'object' && if ( aLengthMenu.length == 2 && typeof aLengthMenu[0] === 'object' &&
typeof aLengthMenu[1] === 'object' ) typeof aLengthMenu[1] === 'object' )
{ {
for ( i=0, iLen=aLengthMenu[0].length ; i<iLen ; i++ ) for ( i=0, iLen=aLengthMenu[0].length ; i<iLen ; i++ )
@ -2882,7 +2882,7 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Note that most of the paging logic is done in * Note that most of the paging logic is done in
* DataTable.ext.oPagination * DataTable.ext.oPagination
*/ */
@ -2902,7 +2902,7 @@
var nPaginate = document.createElement( 'div' ); var nPaginate = document.createElement( 'div' );
nPaginate.className = oSettings.oClasses.sPaging+oSettings.sPaginationType; nPaginate.className = oSettings.oClasses.sPaging+oSettings.sPaginationType;
DataTable.ext.oPagination[ oSettings.sPaginationType ].fnInit( oSettings, nPaginate, DataTable.ext.oPagination[ oSettings.sPaginationType ].fnInit( oSettings, nPaginate,
function( oSettings ) { function( oSettings ) {
_fnCalculateEnd( oSettings ); _fnCalculateEnd( oSettings );
_fnDraw( oSettings ); _fnDraw( oSettings );
@ -3082,7 +3082,7 @@
nScrollHeadTable = oSettings.nTable.cloneNode(false), nScrollHeadTable = oSettings.nTable.cloneNode(false),
nScrollFootTable = oSettings.nTable.cloneNode(false), nScrollFootTable = oSettings.nTable.cloneNode(false),
nThead = oSettings.nTable.getElementsByTagName('thead')[0], nThead = oSettings.nTable.getElementsByTagName('thead')[0],
nTfoot = oSettings.nTable.getElementsByTagName('tfoot').length === 0 ? null : nTfoot = oSettings.nTable.getElementsByTagName('tfoot').length === 0 ? null :
oSettings.nTable.getElementsByTagName('tfoot')[0], oSettings.nTable.getElementsByTagName('tfoot')[0],
oClasses = oSettings.oClasses; oClasses = oSettings.oClasses;
@ -3192,7 +3192,7 @@
if ( !oSettings.bDrawing && $(this).scrollTop() !== 0 ) if ( !oSettings.bDrawing && $(this).scrollTop() !== 0 )
{ {
/* Check if we should load the next data set */ /* Check if we should load the next data set */
if ( $(this).scrollTop() + $(this).height() > if ( $(this).scrollTop() + $(this).height() >
$(oSettings.nTable).height() - oSettings.oScroll.iLoadGap ) $(oSettings.nTable).height() - oSettings.oScroll.iLoadGap )
{ {
/* Only do the redraw if we have to - we might be at the end of the data */ /* Only do the redraw if we have to - we might be at the end of the data */
@ -3314,7 +3314,7 @@
* the scrollbar - which is shouldn't. When there is a scrollbar we need to take this * the scrollbar - which is shouldn't. When there is a scrollbar we need to take this
* into account. * into account.
*/ */
if ( ie67 && ($('tbody', nScrollBody).height() > nScrollBody.offsetHeight || if ( ie67 && ($('tbody', nScrollBody).height() > nScrollBody.offsetHeight ||
$(nScrollBody).css('overflow-y') == "scroll") ) $(nScrollBody).css('overflow-y') == "scroll") )
{ {
o.nTable.style.width = _fnStringToCss( $(o.nTable).outerWidth() - o.oScroll.iBarWidth); o.nTable.style.width = _fnStringToCss( $(o.nTable).outerWidth() - o.oScroll.iBarWidth);
@ -3355,16 +3355,16 @@
* set the width based on the real headers * set the width based on the real headers
*/ */
// Apply all styles in one pass. Invalidates layout only once because we don't read any // Apply all styles in one pass. Invalidates layout only once because we don't read any
// DOM properties. // DOM properties.
_fnApplyToChildren( zeroOut, anHeadSizers ); _fnApplyToChildren( zeroOut, anHeadSizers );
// Read all widths in next pass. Forces layout only once because we do not change // Read all widths in next pass. Forces layout only once because we do not change
// any DOM properties. // any DOM properties.
_fnApplyToChildren( function(nSizer) { _fnApplyToChildren( function(nSizer) {
aApplied.push( _fnStringToCss( $(nSizer).width() ) ); aApplied.push( _fnStringToCss( $(nSizer).width() ) );
}, anHeadSizers ); }, anHeadSizers );
// Apply all widths in final pass. Invalidates layout only once because we do not // Apply all widths in final pass. Invalidates layout only once because we do not
// read any DOM properties. // read any DOM properties.
_fnApplyToChildren( function(nToSize, i) { _fnApplyToChildren( function(nToSize, i) {
@ -3377,11 +3377,11 @@
if ( o.nTFoot !== null ) if ( o.nTFoot !== null )
{ {
_fnApplyToChildren( zeroOut, anFootSizers ); _fnApplyToChildren( zeroOut, anFootSizers );
_fnApplyToChildren( function(nSizer) { _fnApplyToChildren( function(nSizer) {
aAppliedFooter.push( _fnStringToCss( $(nSizer).width() ) ); aAppliedFooter.push( _fnStringToCss( $(nSizer).width() ) );
}, anFootSizers ); }, anFootSizers );
_fnApplyToChildren( function(nToSize, i) { _fnApplyToChildren( function(nToSize, i) {
nToSize.style.width = aAppliedFooter[i]; nToSize.style.width = aAppliedFooter[i];
}, anFootToSize ); }, anFootToSize );
@ -3415,12 +3415,12 @@
if ( $(o.nTable).outerWidth() < iSanityWidth ) if ( $(o.nTable).outerWidth() < iSanityWidth )
{ {
/* The min width depends upon if we have a vertical scrollbar visible or not */ /* The min width depends upon if we have a vertical scrollbar visible or not */
var iCorrection = ((nScrollBody.scrollHeight > nScrollBody.offsetHeight || var iCorrection = ((nScrollBody.scrollHeight > nScrollBody.offsetHeight ||
$(nScrollBody).css('overflow-y') == "scroll")) ? $(nScrollBody).css('overflow-y') == "scroll")) ?
iSanityWidth+o.oScroll.iBarWidth : iSanityWidth; iSanityWidth+o.oScroll.iBarWidth : iSanityWidth;
/* IE6/7 are a law unto themselves... */ /* IE6/7 are a law unto themselves... */
if ( ie67 && (nScrollBody.scrollHeight > if ( ie67 && (nScrollBody.scrollHeight >
nScrollBody.offsetHeight || $(nScrollBody).css('overflow-y') == "scroll") ) nScrollBody.offsetHeight || $(nScrollBody).css('overflow-y') == "scroll") )
{ {
o.nTable.style.width = _fnStringToCss( iCorrection-o.oScroll.iBarWidth ); o.nTable.style.width = _fnStringToCss( iCorrection-o.oScroll.iBarWidth );
@ -3611,7 +3611,7 @@
if ( oSettings.aoColumns[i].sWidth !== null ) if ( oSettings.aoColumns[i].sWidth !== null )
{ {
iTmpWidth = _fnConvertToWidth( oSettings.aoColumns[i].sWidthOrig, iTmpWidth = _fnConvertToWidth( oSettings.aoColumns[i].sWidthOrig,
nWrapper ); nWrapper );
if ( iTmpWidth !== null ) if ( iTmpWidth !== null )
{ {
@ -3623,8 +3623,8 @@
} }
} }
/* If the number of columns in the DOM equals the number that we have to process in /* If the number of columns in the DOM equals the number that we have to process in
* DataTables, then we can use the offsets that are created by the web-browser. No custom * DataTables, then we can use the offsets that are created by the web-browser. No custom
* sizes can be set in order for this to happen, nor scrolling used * sizes can be set in order for this to happen, nor scrolling used
*/ */
if ( iColums == oHeaders.length && iUserInputs === 0 && iVisibleColumns == iColums && if ( iColums == oHeaders.length && iUserInputs === 0 && iVisibleColumns == iColums &&
@ -3753,7 +3753,7 @@
oNodes = _fnGetUniqueThs( oSettings, $('thead', nCalcTmp)[0] ); oNodes = _fnGetUniqueThs( oSettings, $('thead', nCalcTmp)[0] );
} }
/* Browsers need a bit of a hand when a width is assigned to any columns when /* Browsers need a bit of a hand when a width is assigned to any columns when
* x-scrolling as they tend to collapse the table to the min-width, even if * x-scrolling as they tend to collapse the table to the min-width, even if
* we sent the column widths. So we need to keep track of what the table width * we sent the column widths. So we need to keep track of what the table width
* should be by summing the user given values, and the automatic values * should be by summing the user given values, and the automatic values
@ -3925,7 +3925,7 @@
* @memberof DataTable#oApi * @memberof DataTable#oApi
*/ */
function _fnScrollBarWidth () function _fnScrollBarWidth ()
{ {
var inner = document.createElement('p'); var inner = document.createElement('p');
var style = inner.style; var style = inner.style;
style.width = "100%"; style.width = "100%";
@ -3954,7 +3954,7 @@
} }
document.body.removeChild(outer); document.body.removeChild(outer);
return (w1 - w2); return (w1 - w2);
} }
/** /**
@ -3970,7 +3970,7 @@
i, iLen, j, jLen, k, kLen, i, iLen, j, jLen, k, kLen,
sDataType, nTh, sDataType, nTh,
aSort = [], aSort = [],
aiOrig = [], aiOrig = [],
oExtSort = DataTable.ext.oSort, oExtSort = DataTable.ext.oSort,
aoData = oSettings.aoData, aoData = oSettings.aoData,
aoColumns = oSettings.aoColumns, aoColumns = oSettings.aoColumns,
@ -4024,7 +4024,7 @@
sDataType = oSettings.aoColumns[ iColumn ].sSortDataType; sDataType = oSettings.aoColumns[ iColumn ].sSortDataType;
if ( DataTable.ext.afnSortData[sDataType] ) if ( DataTable.ext.afnSortData[sDataType] )
{ {
var aData = DataTable.ext.afnSortData[sDataType].call( var aData = DataTable.ext.afnSortData[sDataType].call(
oSettings.oInstance, oSettings, iColumn, iVisColumn oSettings.oInstance, oSettings, iColumn, iVisColumn
); );
if ( aData.length === aoData.length ) if ( aData.length === aoData.length )
@ -4072,17 +4072,17 @@
* and sorting function (from oSort) in a certain direction. It's reasonably complex to * and sorting function (from oSort) in a certain direction. It's reasonably complex to
* follow on it's own, but this is what we want (example two column sorting): * follow on it's own, but this is what we want (example two column sorting):
* fnLocalSorting = function(a,b){ * fnLocalSorting = function(a,b){
* var iTest; * var iTest;
* iTest = oSort['string-asc']('data11', 'data12'); * iTest = oSort['string-asc']('data11', 'data12');
* if (iTest !== 0) * if (iTest !== 0)
* return iTest; * return iTest;
* iTest = oSort['numeric-desc']('data21', 'data22'); * iTest = oSort['numeric-desc']('data21', 'data22');
* if (iTest !== 0) * if (iTest !== 0)
* return iTest; * return iTest;
* return oSort['numeric-asc']( aiOrig[a], aiOrig[b] ); * return oSort['numeric-asc']( aiOrig[a], aiOrig[b] );
* } * }
* Basically we have a test for each sorting column, if the data in that column is equal, * Basically we have a test for each sorting column, if the data in that column is equal,
* test the next column. If all columns match, then we use a numeric sort on the row * test the next column. If all columns match, then we use a numeric sort on the row
* positions in the original data array to provide a stable sort. * positions in the original data array to provide a stable sort.
* *
* Note - I know it seems excessive to have two sorting methods, but the first is around * Note - I know it seems excessive to have two sorting methods, but the first is around
@ -4169,7 +4169,7 @@
{ {
nTh.setAttribute('aria-sort', aSort[0].dir=="asc" ? "ascending" : "descending" ); nTh.setAttribute('aria-sort', aSort[0].dir=="asc" ? "ascending" : "descending" );
var nextSort = (aoColumns[i].asSorting[ aSort[0].index+1 ]) ? var nextSort = (aoColumns[i].asSorting[ aSort[0].index+1 ]) ?
aoColumns[i].asSorting[ aSort[0].index+1 ] : aoColumns[i].asSorting[0]; aoColumns[i].asSorting[ aSort[0].index+1 ] : aoColumns[i].asSorting[0];
nTh.setAttribute('aria-label', sTitle+ nTh.setAttribute('aria-label', sTitle+
(nextSort=="asc" ? oAria.sSortAscending : oAria.sSortDescending) ); (nextSort=="asc" ? oAria.sSortAscending : oAria.sSortDescending) );
@ -4225,14 +4225,14 @@
/* /*
* This is a little bit odd I admit... I declare a temporary function inside the scope of * This is a little bit odd I admit... I declare a temporary function inside the scope of
* _fnBuildHead and the click handler in order that the code presented here can be used * _fnBuildHead and the click handler in order that the code presented here can be used
* twice - once for when bProcessing is enabled, and another time for when it is * twice - once for when bProcessing is enabled, and another time for when it is
* disabled, as we need to perform slightly different actions. * disabled, as we need to perform slightly different actions.
* Basically the issue here is that the Javascript engine in modern browsers don't * Basically the issue here is that the Javascript engine in modern browsers don't
* appear to allow the rendering engine to update the display while it is still executing * appear to allow the rendering engine to update the display while it is still executing
* it's thread (well - it does but only after long intervals). This means that the * it's thread (well - it does but only after long intervals). This means that the
* 'processing' display doesn't appear for a table sort. To break the js thread up a bit * 'processing' display doesn't appear for a table sort. To break the js thread up a bit
* I force an execution break by using setTimeout - but this breaks the expected * I force an execution break by using setTimeout - but this breaks the expected
* thread continuation for the end-developer's point of view (their code would execute * thread continuation for the end-developer's point of view (their code would execute
* too early), so we only do it when we absolutely have to. * too early), so we only do it when we absolutely have to.
*/ */
@ -4270,7 +4270,7 @@
/* No sort yet - add it in */ /* No sort yet - add it in */
if ( bFound === false ) if ( bFound === false )
{ {
oSettings.aaSorting.push( [ iDataIndex, oSettings.aaSorting.push( [ iDataIndex,
oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] ); oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] );
} }
} }
@ -4291,7 +4291,7 @@
else else
{ {
oSettings.aaSorting.splice( 0, oSettings.aaSorting.length ); oSettings.aaSorting.splice( 0, oSettings.aaSorting.length );
oSettings.aaSorting.push( [ iDataIndex, oSettings.aaSorting.push( [ iDataIndex,
oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] ); oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] );
} }
} }
@ -4326,7 +4326,7 @@
/** /**
* Set the sorting classes on the header, Note: it is safe to call this function * Set the sorting classes on the header, Note: it is safe to call this function
* when bSort and bSortClasses are false * when bSort and bSortClasses are false
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @memberof DataTable#oApi * @memberof DataTable#oApi
@ -4379,13 +4379,13 @@
{ {
/* jQuery UI uses extra markup */ /* jQuery UI uses extra markup */
var jqSpan = $("span."+oClasses.sSortIcon, oSettings.aoColumns[i].nTh); var jqSpan = $("span."+oClasses.sSortIcon, oSettings.aoColumns[i].nTh);
jqSpan.removeClass(oClasses.sSortJUIAsc +" "+ oClasses.sSortJUIDesc +" "+ jqSpan.removeClass(oClasses.sSortJUIAsc +" "+ oClasses.sSortJUIDesc +" "+
oClasses.sSortJUI +" "+ oClasses.sSortJUIAscAllowed +" "+ oClasses.sSortJUIDescAllowed ); oClasses.sSortJUI +" "+ oClasses.sSortJUIAscAllowed +" "+ oClasses.sSortJUIDescAllowed );
var sSpanClass; var sSpanClass;
if ( iFound == -1 ) if ( iFound == -1 )
{ {
sSpanClass = oSettings.aoColumns[i].sSortingClassJUI; sSpanClass = oSettings.aoColumns[i].sSortingClassJUI;
} }
else if ( aaSort[iFound][1] == "asc" ) else if ( aaSort[iFound][1] == "asc" )
{ {
@ -4408,11 +4408,11 @@
} }
} }
/* /*
* Apply the required classes to the table body * Apply the required classes to the table body
* Note that this is given as a feature switch since it can significantly slow down a sort * Note that this is given as a feature switch since it can significantly slow down a sort
* on large data sets (adding and removing of classes is always slow at the best of times..) * on large data sets (adding and removing of classes is always slow at the best of times..)
* Further to this, note that this code is admittedly fairly ugly. It could be made a lot * Further to this, note that this code is admittedly fairly ugly. It could be made a lot
* simpler using jQuery selectors and add/removeClass, but that is significantly slower * simpler using jQuery selectors and add/removeClass, but that is significantly slower
* (on the order of 5 times slower) - hence the direct DOM manipulation here. * (on the order of 5 times slower) - hence the direct DOM manipulation here.
* Note that for deferred drawing we do use jQuery - the reason being that taking the first * Note that for deferred drawing we do use jQuery - the reason being that taking the first
@ -4618,7 +4618,7 @@
/** /**
* Return an flat array with all TD nodes for the table, or row * Return an flat array with all TD nodes for the table, or row
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @param {int} [iIndividualRow] aoData index to get the nodes for - optional * @param {int} [iIndividualRow] aoData index to get the nodes for - optional
* if not given then the return array will contain all nodes for the table * if not given then the return array will contain all nodes for the table
* @returns {array} TD array * @returns {array} TD array
* @memberof DataTable#oApi * @memberof DataTable#oApi
@ -4860,7 +4860,7 @@
* Can be either 'current', whereby the current sorting of the table is used, or * Can be either 'current', whereby the current sorting of the table is used, or
* 'original' whereby the original order the data was read into the table is used. * 'original' whereby the original order the data was read into the table is used.
* @param {string} [oOpts.page=all] Limit the selection to the currently displayed page * @param {string} [oOpts.page=all] Limit the selection to the currently displayed page
* ("current") or not ("all"). If 'current' is given, then order is assumed to be * ("current") or not ("all"). If 'current' is given, then order is assumed to be
* 'current' and filter is 'applied', regardless of what they might be given as. * 'current' and filter is 'applied', regardless of what they might be given as.
* @returns {object} jQuery object, filtered by the given selector. * @returns {object} jQuery object, filtered by the given selector.
* @dtopt API * @dtopt API
@ -4981,7 +4981,7 @@
* Almost identical to $ in operation, but in this case returns the data for the matched * Almost identical to $ in operation, but in this case returns the data for the matched
* rows - as such, the jQuery selector used should match TR row nodes or TD/TH cell nodes * rows - as such, the jQuery selector used should match TR row nodes or TD/TH cell nodes
* rather than any descendants, so the data can be obtained for the row/cell. If matching * rather than any descendants, so the data can be obtained for the row/cell. If matching
* rows are found, the data returned is the original data array/object that was used to * rows are found, the data returned is the original data array/object that was used to
* create the row (or a generated array if from a DOM source). * create the row (or a generated array if from a DOM source).
* *
* This method is often useful in-combination with $ where both functions are given the * This method is often useful in-combination with $ where both functions are given the
@ -4994,10 +4994,10 @@
* Can be either 'current', whereby the current sorting of the table is used, or * Can be either 'current', whereby the current sorting of the table is used, or
* 'original' whereby the original order the data was read into the table is used. * 'original' whereby the original order the data was read into the table is used.
* @param {string} [oOpts.page=all] Limit the selection to the currently displayed page * @param {string} [oOpts.page=all] Limit the selection to the currently displayed page
* ("current") or not ("all"). If 'current' is given, then order is assumed to be * ("current") or not ("all"). If 'current' is given, then order is assumed to be
* 'current' and filter is 'applied', regardless of what they might be given as. * 'current' and filter is 'applied', regardless of what they might be given as.
* @returns {array} Data for the matched elements. If any elements, as a result of the * @returns {array} Data for the matched elements. If any elements, as a result of the
* selector, were not TR, TD or TH elements in the DataTable, they will have a null * selector, were not TR, TD or TH elements in the DataTable, they will have a null
* entry in the array. * entry in the array.
* @dtopt API * @dtopt API
* *
@ -5016,10 +5016,10 @@
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Filter to 'Webkit' and get all data for * // Filter to 'Webkit' and get all data for
* oTable.fnFilter('Webkit'); * oTable.fnFilter('Webkit');
* var data = oTable._('tr', {"filter": "applied"}); * var data = oTable._('tr', {"filter": "applied"});
* *
* // Do something with the data * // Do something with the data
* alert( data.length+" rows matched the filter" ); * alert( data.length+" rows matched the filter" );
* } ); * } );
@ -5041,7 +5041,7 @@
/** /**
* Add a single new row or multiple rows of data to the table. Please note * Add a single new row or multiple rows of data to the table. Please note
* that this is suitable for client-side processing only - if you are using * that this is suitable for client-side processing only - if you are using
* server-side processing (i.e. "bServerSide": true), then to add data, you * server-side processing (i.e. "bServerSide": true), then to add data, you
* must add it to the data source, i.e. the server-side, through an Ajax call. * must add it to the data source, i.e. the server-side, through an Ajax call.
* @param {array|object} mData The data to be added to the table. This can be: * @param {array|object} mData The data to be added to the table. This can be:
@ -5052,19 +5052,19 @@
* <li>array of objects - multiple data objects when using <i>mData</i></li> * <li>array of objects - multiple data objects when using <i>mData</i></li>
* </ul> * </ul>
* @param {bool} [bRedraw=true] redraw the table or not * @param {bool} [bRedraw=true] redraw the table or not
* @returns {array} An array of integers, representing the list of indexes in * @returns {array} An array of integers, representing the list of indexes in
* <i>aoData</i> ({@link DataTable.models.oSettings}) that have been added to * <i>aoData</i> ({@link DataTable.models.oSettings}) that have been added to
* the table. * the table.
* @dtopt API * @dtopt API
* *
* @example * @example
* // Global var for counter * // Global var for counter
* var giCount = 2; * var giCount = 2;
* *
* $(document).ready(function() { * $(document).ready(function() {
* $('#example').dataTable(); * $('#example').dataTable();
* } ); * } );
* *
* function fnClickAddRow() { * function fnClickAddRow() {
* $('#example').dataTable().fnAddData( [ * $('#example').dataTable().fnAddData( [
* giCount+".1", * giCount+".1",
@ -5072,7 +5072,7 @@
* giCount+".3", * giCount+".3",
* giCount+".4" ] * giCount+".4" ]
* ); * );
* *
* giCount++; * giCount++;
* } * }
*/ */
@ -5123,9 +5123,9 @@
/** /**
* This function will make DataTables recalculate the column sizes, based on the data * This function will make DataTables recalculate the column sizes, based on the data
* contained in the table and the sizes applied to the columns (in the DOM, CSS or * contained in the table and the sizes applied to the columns (in the DOM, CSS or
* through the sWidth parameter). This can be useful when the width of the table's * through the sWidth parameter). This can be useful when the width of the table's
* parent element changes (for example a window resize). * parent element changes (for example a window resize).
* @param {boolean} [bRedraw=true] Redraw the table or not, you will typically want to * @param {boolean} [bRedraw=true] Redraw the table or not, you will typically want to
* @dtopt API * @dtopt API
@ -5136,7 +5136,7 @@
* "sScrollY": "200px", * "sScrollY": "200px",
* "bPaginate": false * "bPaginate": false
* } ); * } );
* *
* $(window).bind('resize', function () { * $(window).bind('resize', function () {
* oTable.fnAdjustColumnSizing(); * oTable.fnAdjustColumnSizing();
* } ); * } );
@ -5167,7 +5167,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Immediately 'nuke' the current rows (perhaps waiting for an Ajax callback...) * // Immediately 'nuke' the current rows (perhaps waiting for an Ajax callback...)
* oTable.fnClearTable(); * oTable.fnClearTable();
* } ); * } );
@ -5186,7 +5186,7 @@
/** /**
* The exact opposite of 'opening' a row, this function will close any rows which * The exact opposite of 'opening' a row, this function will close any rows which
* are currently 'open'. * are currently 'open'.
* @param {node} nTr the table row to 'close' * @param {node} nTr the table row to 'close'
* @returns {int} 0 on success, or 1 if failed (can't find the row) * @returns {int} 0 on success, or 1 if failed (can't find the row)
@ -5195,7 +5195,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable; * var oTable;
* *
* // 'open' an information row when a row is clicked on * // 'open' an information row when a row is clicked on
* $('#example tbody tr').click( function () { * $('#example tbody tr').click( function () {
* if ( oTable.fnIsOpen(this) ) { * if ( oTable.fnIsOpen(this) ) {
@ -5204,7 +5204,7 @@
* oTable.fnOpen( this, "Temporary row opened", "info_row" ); * oTable.fnOpen( this, "Temporary row opened", "info_row" );
* } * }
* } ); * } );
* *
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
*/ */
@ -5243,7 +5243,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Immediately remove the first row * // Immediately remove the first row
* oTable.fnDeleteRow( 0 ); * oTable.fnDeleteRow( 0 );
* } ); * } );
@ -5254,7 +5254,7 @@
var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] ); var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] );
var i, iLen, iAODataIndex; var i, iLen, iAODataIndex;
iAODataIndex = (typeof mTarget === 'object') ? iAODataIndex = (typeof mTarget === 'object') ?
_fnNodeToDataIndex(oSettings, mTarget) : mTarget; _fnNodeToDataIndex(oSettings, mTarget) : mTarget;
/* Return the data array from this row */ /* Return the data array from this row */
@ -5304,7 +5304,7 @@
/** /**
* Restore the table to it's original state in the DOM by removing all of DataTables * Restore the table to it's original state in the DOM by removing all of DataTables
* enhancements, alterations to the DOM structure of the table and event listeners. * enhancements, alterations to the DOM structure of the table and event listeners.
* @param {boolean} [bRemove=false] Completely remove the table from the DOM * @param {boolean} [bRemove=false] Completely remove the table from the DOM
* @dtopt API * @dtopt API
@ -5452,7 +5452,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Re-draw the table - you wouldn't want to do it here, but it's an example :-) * // Re-draw the table - you wouldn't want to do it here, but it's an example :-)
* oTable.fnDraw(); * oTable.fnDraw();
* } ); * } );
@ -5485,7 +5485,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Sometime later - filter... * // Sometime later - filter...
* oTable.fnFilter( 'test string' ); * oTable.fnFilter( 'test string' );
* } ); * } );
@ -5563,7 +5563,7 @@
/** /**
* Get the data for the whole table, an individual row or an individual cell based on the * Get the data for the whole table, an individual row or an individual cell based on the
* provided parameters. * provided parameters.
* @param {int|node} [mRow] A TR row node, TD/TH cell node or an integer. If given as * @param {int|node} [mRow] A TR row node, TD/TH cell node or an integer. If given as
* a TR node then the data source for the whole row will be returned. If given as a * a TR node then the data source for the whole row will be returned. If given as a
@ -5631,8 +5631,8 @@
/** /**
* Get an array of the TR nodes that are used in the table's body. Note that you will * Get an array of the TR nodes that are used in the table's body. Note that you will
* typically want to use the '$' API method in preference to this as it is more * typically want to use the '$' API method in preference to this as it is more
* flexible. * flexible.
* @param {int} [iRow] Optional row index for the TR element you want * @param {int} [iRow] Optional row index for the TR element you want
* @returns {array|node} If iRow is undefined, returns an array of all TR elements * @returns {array|node} If iRow is undefined, returns an array of all TR elements
@ -5642,7 +5642,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Get the nodes from the table * // Get the nodes from the table
* var nNodes = oTable.fnGetNodes( ); * var nNodes = oTable.fnGetNodes( );
* } ); * } );
@ -5664,7 +5664,7 @@
* and column index including hidden columns * and column index including hidden columns
* @param {node} nNode this can either be a TR, TD or TH in the table's body * @param {node} nNode this can either be a TR, TD or TH in the table's body
* @returns {int} If nNode is given as a TR, then a single index is returned, or * @returns {int} If nNode is given as a TR, then a single index is returned, or
* if given as a cell, an array of [row index, column index (visible), * if given as a cell, an array of [row index, column index (visible),
* column index (all)] is given. * column index (all)] is given.
* @dtopt API * @dtopt API
* *
@ -5673,15 +5673,15 @@
* $('#example tbody td').click( function () { * $('#example tbody td').click( function () {
* // Get the position of the current data from the node * // Get the position of the current data from the node
* var aPos = oTable.fnGetPosition( this ); * var aPos = oTable.fnGetPosition( this );
* *
* // Get the data array for this row * // Get the data array for this row
* var aData = oTable.fnGetData( aPos[0] ); * var aData = oTable.fnGetData( aPos[0] );
* *
* // Update the data array and return the value * // Update the data array and return the value
* aData[ aPos[1] ] = 'clicked'; * aData[ aPos[1] ] = 'clicked';
* this.innerHTML = 'clicked'; * this.innerHTML = 'clicked';
* } ); * } );
* *
* // Init DataTables * // Init DataTables
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
@ -5714,7 +5714,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable; * var oTable;
* *
* // 'open' an information row when a row is clicked on * // 'open' an information row when a row is clicked on
* $('#example tbody tr').click( function () { * $('#example tbody tr').click( function () {
* if ( oTable.fnIsOpen(this) ) { * if ( oTable.fnIsOpen(this) ) {
@ -5723,7 +5723,7 @@
* oTable.fnOpen( this, "Temporary row opened", "info_row" ); * oTable.fnOpen( this, "Temporary row opened", "info_row" );
* } * }
* } ); * } );
* *
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
*/ */
@ -5744,9 +5744,9 @@
/** /**
* This function will place a new row directly after a row which is currently * This function will place a new row directly after a row which is currently
* on display on the page, with the HTML contents that is passed into the * on display on the page, with the HTML contents that is passed into the
* function. This can be used, for example, to ask for confirmation that a * function. This can be used, for example, to ask for confirmation that a
* particular record should be deleted. * particular record should be deleted.
* @param {node} nTr The table row to 'open' * @param {node} nTr The table row to 'open'
* @param {string|node|jQuery} mHtml The HTML to put into the row * @param {string|node|jQuery} mHtml The HTML to put into the row
@ -5759,7 +5759,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable; * var oTable;
* *
* // 'open' an information row when a row is clicked on * // 'open' an information row when a row is clicked on
* $('#example tbody tr').click( function () { * $('#example tbody tr').click( function () {
* if ( oTable.fnIsOpen(this) ) { * if ( oTable.fnIsOpen(this) ) {
@ -5768,7 +5768,7 @@
* oTable.fnOpen( this, "Temporary row opened", "info_row" ); * oTable.fnOpen( this, "Temporary row opened", "info_row" );
* } * }
* } ); * } );
* *
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
*/ */
@ -5819,8 +5819,8 @@
/** /**
* Change the pagination - provides the internal logic for pagination in a simple API * Change the pagination - provides the internal logic for pagination in a simple API
* function. With this function you can have a DataTables table go to the next, * function. With this function you can have a DataTables table go to the next,
* previous, first or last pages. * previous, first or last pages.
* @param {string|int} mAction Paging action to take: "first", "previous", "next" or "last" * @param {string|int} mAction Paging action to take: "first", "previous", "next" or "last"
* or page number to jump to (integer), note that page 0 is the first page. * or page number to jump to (integer), note that page 0 is the first page.
@ -5856,7 +5856,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Hide the second column after initialisation * // Hide the second column after initialisation
* oTable.fnSetColumnVis( 1, false ); * oTable.fnSetColumnVis( 1, false );
* } ); * } );
@ -5909,14 +5909,14 @@
{ {
if ( bAppend ) if ( bAppend )
{ {
aoData[i].nTr.appendChild( aoData[i].nTr.appendChild(
aoData[i]._anHidden[iCol] aoData[i]._anHidden[iCol]
); );
} }
else else
{ {
aoData[i].nTr.insertBefore( aoData[i].nTr.insertBefore(
aoData[i]._anHidden[iCol], aoData[i]._anHidden[iCol],
_fnGetTdNodes( oSettings, i )[iBefore] ); _fnGetTdNodes( oSettings, i )[iBefore] );
} }
} }
@ -5952,8 +5952,8 @@
oSettings.aoOpenRows[i].nTr.colSpan = _fnVisbleColumns( oSettings ); oSettings.aoOpenRows[i].nTr.colSpan = _fnVisbleColumns( oSettings );
} }
/* Do a redraw incase anything depending on the table columns needs it /* Do a redraw incase anything depending on the table columns needs it
* (built-in: scrolling) * (built-in: scrolling)
*/ */
if ( bRedraw === undefined || bRedraw ) if ( bRedraw === undefined || bRedraw )
{ {
@ -5967,7 +5967,7 @@
/** /**
* Get the settings for a particular table for external manipulation * Get the settings for a particular table for external manipulation
* @returns {object} DataTables settings object. See * @returns {object} DataTables settings object. See
* {@link DataTable.models.oSettings} * {@link DataTable.models.oSettings}
* @dtopt API * @dtopt API
* *
@ -5975,7 +5975,7 @@
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* var oSettings = oTable.fnSettings(); * var oSettings = oTable.fnSettings();
* *
* // Show an example parameter from the settings * // Show an example parameter from the settings
* alert( oSettings._iDisplayStart ); * alert( oSettings._iDisplayStart );
* } ); * } );
@ -5988,14 +5988,14 @@
/** /**
* Sort the table by a particular column * Sort the table by a particular column
* @param {int} iCol the data index to sort on. Note that this will not match the * @param {int} iCol the data index to sort on. Note that this will not match the
* 'display index' if you have hidden data entries * 'display index' if you have hidden data entries
* @dtopt API * @dtopt API
* *
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Sort immediately with columns 0 and 1 * // Sort immediately with columns 0 and 1
* oTable.fnSort( [ [0,'asc'], [1,'asc'] ] ); * oTable.fnSort( [ [0,'asc'], [1,'asc'] ] );
* } ); * } );
@ -6018,7 +6018,7 @@
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Sort on column 1, when 'sorter' is clicked on * // Sort on column 1, when 'sorter' is clicked on
* oTable.fnSortListener( document.getElementById('sorter'), 1 ); * oTable.fnSortListener( document.getElementById('sorter'), 1 );
* } ); * } );
@ -6055,7 +6055,7 @@
{ {
var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] ); var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] );
var i, sDisplay; var i, sDisplay;
var iRow = (typeof mRow === 'object') ? var iRow = (typeof mRow === 'object') ?
_fnNodeToDataIndex(oSettings, mRow) : mRow; _fnNodeToDataIndex(oSettings, mRow) : mRow;
if ( iColumn === undefined || iColumn === null ) if ( iColumn === undefined || iColumn === null )
@ -6087,7 +6087,7 @@
*/ */
var iDisplayIndex = $.inArray( iRow, oSettings.aiDisplay ); var iDisplayIndex = $.inArray( iRow, oSettings.aiDisplay );
oSettings.asDataSearch[iDisplayIndex] = _fnBuildSearchRow( oSettings.asDataSearch[iDisplayIndex] = _fnBuildSearchRow(
oSettings, oSettings,
_fnGetRowData( oSettings, iRow, 'filter', _fnGetColumns( oSettings, 'bSearchable' ) ) _fnGetRowData( oSettings, iRow, 'filter', _fnGetColumns( oSettings, 'bSearchable' ) )
); );
@ -6140,7 +6140,7 @@
function _fnExternApiFunc (sFunc) function _fnExternApiFunc (sFunc)
{ {
return function() { return function() {
var aArgs = [_fnSettingsFromNode(this[DataTable.ext.iApiIndex])].concat( var aArgs = [_fnSettingsFromNode(this[DataTable.ext.iApiIndex])].concat(
Array.prototype.slice.call(arguments) ); Array.prototype.slice.call(arguments) );
return DataTable.ext.oApi[sFunc].apply( this, aArgs ); return DataTable.ext.oApi[sFunc].apply( this, aArgs );
}; };
@ -6428,8 +6428,8 @@
if ( oInit.bJQueryUI ) if ( oInit.bJQueryUI )
{ {
/* Use the JUI classes object for display. You could clone the oStdClasses object if /* Use the JUI classes object for display. You could clone the oStdClasses object if
* you want to have multiple tables with multiple independent classes * you want to have multiple tables with multiple independent classes
*/ */
$.extend( oSettings.oClasses, DataTable.ext.oJUIClasses ); $.extend( oSettings.oClasses, DataTable.ext.oJUIClasses );
@ -6483,7 +6483,7 @@
if ( oInit.oLanguage.sUrl !== "" ) if ( oInit.oLanguage.sUrl !== "" )
{ {
/* Get the language definitions from a file - because this Ajax call makes the language /* Get the language definitions from a file - because this Ajax call makes the language
* get async to the remainder of this function we use bInitHandedOff to indicate that * get async to the remainder of this function we use bInitHandedOff to indicate that
* _fnInitialise will be fired by the returned Ajax handler, rather than the constructor * _fnInitialise will be fired by the returned Ajax handler, rather than the constructor
*/ */
oSettings.oLanguage.sUrl = oInit.oLanguage.sUrl; oSettings.oLanguage.sUrl = oInit.oLanguage.sUrl;
@ -6762,7 +6762,7 @@
/** /**
* Get all DataTable tables that have been initialised - optionally you can select to * Get all DataTable tables that have been initialised - optionally you can select to
* get only currently visible tables. * get only currently visible tables.
* @param {boolean} [bVisible=false] Flag to indicate if you want all (default) or * @param {boolean} [bVisible=false] Flag to indicate if you want all (default) or
* visible tables only. * visible tables only.
* @returns {array} Array of TABLE nodes (not DataTable instances) which are DataTables * @returns {array} Array of TABLE nodes (not DataTable instances) which are DataTables
* @static * @static
@ -6827,7 +6827,7 @@
* for plug-ins that can be used to extend the default DataTables behaviour - indeed many * for plug-ins that can be used to extend the default DataTables behaviour - indeed many
* of the build in methods use this method to provide their own capabilities (sorting methods * of the build in methods use this method to provide their own capabilities (sorting methods
* for example). * for example).
* *
* Note that this namespace is aliased to jQuery.fn.dataTableExt so it can be readily accessed * Note that this namespace is aliased to jQuery.fn.dataTableExt so it can be readily accessed
* and modified by plug-ins. * and modified by plug-ins.
* @namespace * @namespace
@ -6862,7 +6862,7 @@
* *
* @example * @example
* // The following example shows custom filtering being applied to the fourth column (i.e. * // The following example shows custom filtering being applied to the fourth column (i.e.
* // the aData[3] index) based on two input values from the end-user, matching the data in * // the aData[3] index) based on two input values from the end-user, matching the data in
* // a certain range. * // a certain range.
* $.fn.dataTableExt.afnFiltering.push( * $.fn.dataTableExt.afnFiltering.push(
* function( oSettings, aData, iDataIndex ) { * function( oSettings, aData, iDataIndex ) {
@ -6896,7 +6896,7 @@
* static string that DataTables knows of. The way these plug-ins work is that you create * static string that DataTables knows of. The way these plug-ins work is that you create
* an array of the values you wish to be sorted for the column in question and then return * an array of the values you wish to be sorted for the column in question and then return
* that array. Which pre-sorting function is run here depends on the sSortDataType parameter * that array. Which pre-sorting function is run here depends on the sSortDataType parameter
* that is used for the column (if any). This is the corollary of <i>ofnSearch</i> for sort * that is used for the column (if any). This is the corollary of <i>ofnSearch</i> for sort
* data. * data.
* <ul> * <ul>
* <li> * <li>
@ -6913,10 +6913,10 @@
* </ul> * </ul>
* </il> * </il>
* </ul> * </ul>
* *
* Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for * Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for
* the different uses that DataTables can put the data to. Specifically <i>mData</i> when * the different uses that DataTables can put the data to. Specifically <i>mData</i> when
* used as a function will give you a 'type' (sorting, filtering etc) that you can use to * used as a function will give you a 'type' (sorting, filtering etc) that you can use to
* prepare the data as required for the different types. As such, this method is deprecated. * prepare the data as required for the different types. As such, this method is deprecated.
* @type array * @type array
* @default [] * @default []
@ -6955,8 +6955,8 @@
* Function return: * Function return:
* <ul> * <ul>
* <li>{node|null} The element which contains your feature. Note that the return * <li>{node|null} The element which contains your feature. Note that the return
* may also be void if your plug-in does not require to inject any DOM elements * may also be void if your plug-in does not require to inject any DOM elements
* into DataTables control (sDom) - for example this might be useful when * into DataTables control (sDom) - for example this might be useful when
* developing a plug-in which allows table control via keyboard entry.</li> * developing a plug-in which allows table control via keyboard entry.</li>
* </ul> * </ul>
* </il> * </il>
@ -6967,7 +6967,7 @@
* </ul> * </ul>
* @type array * @type array
* @default [] * @default []
* *
* @example * @example
* // How TableTools initialises itself. * // How TableTools initialises itself.
* $.fn.dataTableExt.aoFeatures.push( { * $.fn.dataTableExt.aoFeatures.push( {
@ -6985,9 +6985,9 @@
* Type detection plug-in functions - DataTables utilises types to define how sorting and * Type detection plug-in functions - DataTables utilises types to define how sorting and
* filtering behave, and types can be either be defined by the developer (sType for the * filtering behave, and types can be either be defined by the developer (sType for the
* column) or they can be automatically detected by the methods in this array. The functions * column) or they can be automatically detected by the methods in this array. The functions
* defined in the array are quite simple, taking a single parameter (the data to analyse) * defined in the array are quite simple, taking a single parameter (the data to analyse)
* and returning the type if it is a known type, or null otherwise. * and returning the type if it is a known type, or null otherwise.
* *
* * Function input parameters: * * Function input parameters:
* * {*} Data from the column cell to be analysed * * {*} Data from the column cell to be analysed
* * Function return: * * Function return:
@ -6996,7 +6996,7 @@
* *
* @type array * @type array
* @default [] * @default []
* *
* @example * @example
* // Currency type detection plug-in: * // Currency type detection plug-in:
* jQuery.fn.dataTableExt.aTypes.push( * jQuery.fn.dataTableExt.aTypes.push(
@ -7005,7 +7005,7 @@
* if ( ! $.isNumeric( data.substring(1) ) ) { * if ( ! $.isNumeric( data.substring(1) ) ) {
* return null; * return null;
* } * }
* *
* // Check prefixed by currency * // Check prefixed by currency
* if ( data.charAt(0) == '$' || data.charAt(0) == '&pound;' ) { * if ( data.charAt(0) == '$' || data.charAt(0) == '&pound;' ) {
* return 'currency'; * return 'currency';
@ -7018,12 +7018,12 @@
/** /**
* Provide a common method for plug-ins to check the version of DataTables being used, * Provide a common method for plug-ins to check the version of DataTables being used,
* in order to ensure compatibility. * in order to ensure compatibility.
* @type function * @type function
* @param {string} sVersion Version string to check for, in the format "X.Y.Z". Note * @param {string} sVersion Version string to check for, in the format "X.Y.Z". Note
* that the formats "X" and "X.Y" are also acceptable. * that the formats "X" and "X.Y" are also acceptable.
* @returns {boolean} true if this version of DataTables is greater or equal to the * @returns {boolean} true if this version of DataTables is greater or equal to the
* required version, or false if this version of DataTales is not suitable * required version, or false if this version of DataTales is not suitable
* *
* @example * @example
@ -7045,10 +7045,10 @@
/** /**
* Pre-processing of filtering data plug-ins - When you assign the sType for a column * Pre-processing of filtering data plug-ins - When you assign the sType for a column
* (or have it automatically detected for you by DataTables or a type detection plug-in), * (or have it automatically detected for you by DataTables or a type detection plug-in),
* you will typically be using this for custom sorting, but it can also be used to provide * you will typically be using this for custom sorting, but it can also be used to provide
* custom filtering by allowing you to pre-processing the data and returning the data in * custom filtering by allowing you to pre-processing the data and returning the data in
* the format that should be filtered upon. This is done by adding functions this object * the format that should be filtered upon. This is done by adding functions this object
* with a parameter name which matches the sType for that target column. This is the * with a parameter name which matches the sType for that target column. This is the
* corollary of <i>afnSortData</i> for filtering data. * corollary of <i>afnSortData</i> for filtering data.
* <ul> * <ul>
@ -7065,10 +7065,10 @@
* </ul> * </ul>
* </il> * </il>
* </ul> * </ul>
* *
* Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for * Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for
* the different uses that DataTables can put the data to. Specifically <i>mData</i> when * the different uses that DataTables can put the data to. Specifically <i>mData</i> when
* used as a function will give you a 'type' (sorting, filtering etc) that you can use to * used as a function will give you a 'type' (sorting, filtering etc) that you can use to
* prepare the data as required for the different types. As such, this method is deprecated. * prepare the data as required for the different types. As such, this method is deprecated.
* @type object * @type object
* @default {} * @default {}
@ -7107,8 +7107,8 @@
/** /**
* Pagination plug-in methods - The style and controls of the pagination can significantly * Pagination plug-in methods - The style and controls of the pagination can significantly
* impact on how the end user interacts with the data in your table, and DataTables allows * impact on how the end user interacts with the data in your table, and DataTables allows
* the addition of pagination controls by extending this object, which can then be enabled * the addition of pagination controls by extending this object, which can then be enabled
* through the <i>sPaginationType</i> initialisation parameter. Each pagination type that * through the <i>sPaginationType</i> initialisation parameter. Each pagination type that
* is added is an object (the property name of which is what <i>sPaginationType</i> refers * is added is an object (the property name of which is what <i>sPaginationType</i> refers
@ -7116,12 +7116,12 @@
* control's state. * control's state.
* <ul> * <ul>
* <li> * <li>
* fnInit - Initialisation of the paging controls. Called only during initialisation * fnInit - Initialisation of the paging controls. Called only during initialisation
* of the table. It is expected that this function will add the required DOM elements * of the table. It is expected that this function will add the required DOM elements
* to the page for the paging controls to work. The element pointer * to the page for the paging controls to work. The element pointer
* 'oSettings.aanFeatures.p' array is provided by DataTables to contain the paging * 'oSettings.aanFeatures.p' array is provided by DataTables to contain the paging
* controls (note that this is a 2D array to allow for multiple instances of each * controls (note that this is a 2D array to allow for multiple instances of each
* DataTables DOM element). It is suggested that you add the controls to this element * DataTables DOM element). It is suggested that you add the controls to this element
* as children * as children
* <ul> * <ul>
* <li> * <li>
@ -7143,7 +7143,7 @@
* </il> * </il>
* <li> * <li>
* fnInit - This function is called whenever the paging status of the table changes and is * fnInit - This function is called whenever the paging status of the table changes and is
* typically used to update classes and/or text of the paging controls to reflex the new * typically used to update classes and/or text of the paging controls to reflex the new
* status. * status.
* <ul> * <ul>
* <li> * <li>
@ -7173,53 +7173,53 @@
* nPrevious = document.createElement( 'span' ); * nPrevious = document.createElement( 'span' );
* nNext = document.createElement( 'span' ); * nNext = document.createElement( 'span' );
* nLast = document.createElement( 'span' ); * nLast = document.createElement( 'span' );
* *
* nFirst.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sFirst ) ); * nFirst.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sFirst ) );
* nPrevious.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sPrevious ) ); * nPrevious.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sPrevious ) );
* nNext.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sNext ) ); * nNext.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sNext ) );
* nLast.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sLast ) ); * nLast.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sLast ) );
* *
* nFirst.className = "paginate_button first"; * nFirst.className = "paginate_button first";
* nPrevious.className = "paginate_button previous"; * nPrevious.className = "paginate_button previous";
* nNext.className="paginate_button next"; * nNext.className="paginate_button next";
* nLast.className = "paginate_button last"; * nLast.className = "paginate_button last";
* *
* nPaging.appendChild( nFirst ); * nPaging.appendChild( nFirst );
* nPaging.appendChild( nPrevious ); * nPaging.appendChild( nPrevious );
* nPaging.appendChild( nNext ); * nPaging.appendChild( nNext );
* nPaging.appendChild( nLast ); * nPaging.appendChild( nLast );
* *
* $(nFirst).click( function () { * $(nFirst).click( function () {
* oSettings.oApi._fnPageChange( oSettings, "first" ); * oSettings.oApi._fnPageChange( oSettings, "first" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nPrevious).click( function() { * $(nPrevious).click( function() {
* oSettings.oApi._fnPageChange( oSettings, "previous" ); * oSettings.oApi._fnPageChange( oSettings, "previous" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nNext).click( function() { * $(nNext).click( function() {
* oSettings.oApi._fnPageChange( oSettings, "next" ); * oSettings.oApi._fnPageChange( oSettings, "next" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nLast).click( function() { * $(nLast).click( function() {
* oSettings.oApi._fnPageChange( oSettings, "last" ); * oSettings.oApi._fnPageChange( oSettings, "last" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nFirst).bind( 'selectstart', function () { return false; } ); * $(nFirst).bind( 'selectstart', function () { return false; } );
* $(nPrevious).bind( 'selectstart', function () { return false; } ); * $(nPrevious).bind( 'selectstart', function () { return false; } );
* $(nNext).bind( 'selectstart', function () { return false; } ); * $(nNext).bind( 'selectstart', function () { return false; } );
* $(nLast).bind( 'selectstart', function () { return false; } ); * $(nLast).bind( 'selectstart', function () { return false; } );
* }, * },
* *
* "fnUpdate": function ( oSettings, fnCallbackDraw ) { * "fnUpdate": function ( oSettings, fnCallbackDraw ) {
* if ( !oSettings.aanFeatures.p ) { * if ( !oSettings.aanFeatures.p ) {
* return; * return;
* } * }
* *
* // Loop over each instance of the pager * // Loop over each instance of the pager
* var an = oSettings.aanFeatures.p; * var an = oSettings.aanFeatures.p;
* for ( var i=0, iLen=an.length ; i<iLen ; i++ ) { * for ( var i=0, iLen=an.length ; i<iLen ; i++ ) {
@ -7232,7 +7232,7 @@
* buttons[0].className = "paginate_enabled_previous"; * buttons[0].className = "paginate_enabled_previous";
* buttons[1].className = "paginate_enabled_previous"; * buttons[1].className = "paginate_enabled_previous";
* } * }
* *
* if ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) { * if ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) {
* buttons[2].className = "paginate_disabled_next"; * buttons[2].className = "paginate_disabled_next";
* buttons[3].className = "paginate_disabled_next"; * buttons[3].className = "paginate_disabled_next";
@ -7250,8 +7250,8 @@
/** /**
* Sorting plug-in methods - Sorting in DataTables is based on the detected type of the * Sorting plug-in methods - Sorting in DataTables is based on the detected type of the
* data column (you can add your own type detection functions, or override automatic * data column (you can add your own type detection functions, or override automatic
* detection using sType). With this specific type given to the column, DataTables will * detection using sType). With this specific type given to the column, DataTables will
* apply the required sort from the functions in the object. Each sort type must provide * apply the required sort from the functions in the object. Each sort type must provide
* two mandatory methods, one each for ascending and descending sorting, and can optionally * two mandatory methods, one each for ascending and descending sorting, and can optionally
* provide a pre-formatting method that will help speed up sorting by allowing DataTables * provide a pre-formatting method that will help speed up sorting by allowing DataTables
@ -7379,7 +7379,7 @@
/** /**
* Template object for the way in which DataTables holds information about * Template object for the way in which DataTables holds information about
* each individual row. This is the object format used for the settings * each individual row. This is the object format used for the settings
* aoData array. * aoData array.
* @namespace * @namespace
*/ */
@ -7395,7 +7395,7 @@
* Data object from the original data source for the row. This is either * Data object from the original data source for the row. This is either
* an array if using the traditional form of DataTables, or an object if * an array if using the traditional form of DataTables, or an object if
* using mData options. The exact type will depend on the passed in * using mData options. The exact type will depend on the passed in
* data from the data source, or will be an array if using DOM a data * data from the data source, or will be an array if using DOM a data
* source. * source.
* @type array|object * @type array|object
* @default [] * @default []
@ -7404,7 +7404,7 @@
/** /**
* Sorting data cache - this array is ostensibly the same length as the * Sorting data cache - this array is ostensibly the same length as the
* number of columns (although each index is generated only as it is * number of columns (although each index is generated only as it is
* needed), and holds the data that is used for sorting each column in the * needed), and holds the data that is used for sorting each column in the
* row. We do this cache generation at the start of the sort in order that * row. We do this cache generation at the start of the sort in order that
* the formatting of the sort data need be done only once for each cell * the formatting of the sort data need be done only once for each cell
@ -7419,7 +7419,7 @@
/** /**
* Array of TD elements that are cached for hidden rows, so they can be * Array of TD elements that are cached for hidden rows, so they can be
* reinserted into the table if a column is made visible again (or to act * reinserted into the table if a column is made visible again (or to act
* as a store if a column is made hidden). Only hidden columns have a * as a store if a column is made hidden). Only hidden columns have a
* reference in the array. For non-hidden columns the value is either * reference in the array. For non-hidden columns the value is either
* undefined or null. * undefined or null.
* @type array nodes * @type array nodes
@ -7445,8 +7445,8 @@
* Template object for the column information object in DataTables. This object * Template object for the column information object in DataTables. This object
* is held in the settings aoColumns array and contains all the information that * is held in the settings aoColumns array and contains all the information that
* DataTables needs about each individual column. * DataTables needs about each individual column.
* *
* Note that this object is related to {@link DataTable.defaults.column} * Note that this object is related to {@link DataTable.defaults.column}
* but this one is the internal data store for DataTables's cache of columns. * but this one is the internal data store for DataTables's cache of columns.
* It should NOT be manipulated outside of DataTables. Any configuration should * It should NOT be manipulated outside of DataTables. Any configuration should
* be done through the initialisation options. * be done through the initialisation options.
@ -7520,12 +7520,12 @@
* Function to get data from a cell in a column. You should <b>never</b> * Function to get data from a cell in a column. You should <b>never</b>
* access data directly through _aData internally in DataTables - always use * access data directly through _aData internally in DataTables - always use
* the method attached to this property. It allows mData to function as * the method attached to this property. It allows mData to function as
* required. This function is automatically assigned by the column * required. This function is automatically assigned by the column
* initialisation method * initialisation method
* @type function * @type function
* @param {array|object} oData The data array/object for the array * @param {array|object} oData The data array/object for the array
* (i.e. aoData[]._aData) * (i.e. aoData[]._aData)
* @param {string} sSpecific The specific data type you want to get - * @param {string} sSpecific The specific data type you want to get -
* 'display', 'type' 'filter' 'sort' * 'display', 'type' 'filter' 'sort'
* @returns {*} The data for the cell from the given row's data * @returns {*} The data for the cell from the given row's data
* @default null * @default null
@ -7533,12 +7533,12 @@
"fnGetData": null, "fnGetData": null,
/** /**
* Function to set data for a cell in the column. You should <b>never</b> * Function to set data for a cell in the column. You should <b>never</b>
* set the data directly to _aData internally in DataTables - always use * set the data directly to _aData internally in DataTables - always use
* this method. It allows mData to function as required. This function * this method. It allows mData to function as required. This function
* is automatically assigned by the column initialisation method * is automatically assigned by the column initialisation method
* @type function * @type function
* @param {array|object} oData The data array/object for the array * @param {array|object} oData The data array/object for the array
* (i.e. aoData[]._aData) * (i.e. aoData[]._aData)
* @param {*} sValue Value to set * @param {*} sValue Value to set
* @default null * @default null
@ -7546,7 +7546,7 @@
"fnSetData": null, "fnSetData": null,
/** /**
* Property to read the value for the cells in the column from the data * Property to read the value for the cells in the column from the data
* source array / object. If null, then the default content is used, if a * source array / object. If null, then the default content is used, if a
* function is given then the return from the function is used. * function is given then the return from the function is used.
* @type function|int|string|null * @type function|int|string|null
@ -7573,8 +7573,8 @@
"nTh": null, "nTh": null,
/** /**
* Unique footer TH/TD element for this column (if there is one). Not used * Unique footer TH/TD element for this column (if there is one). Not used
* in DataTables as such, but can be used for plug-ins to reference the * in DataTables as such, but can be used for plug-ins to reference the
* footer for each column. * footer for each column.
* @type node * @type node
* @default null * @default null
@ -7592,7 +7592,7 @@
* When DataTables calculates the column widths to assign to each column, * When DataTables calculates the column widths to assign to each column,
* it finds the longest string in each column and then constructs a * it finds the longest string in each column and then constructs a
* temporary table and reads the widths from that. The problem with this * temporary table and reads the widths from that. The problem with this
* is that "mmm" is much wider then "iiii", but the latter is a longer * is that "mmm" is much wider then "iiii", but the latter is a longer
* string - thus the calculation can go wrong (doing it properly and putting * string - thus the calculation can go wrong (doing it properly and putting
* it into an DOM object and measuring that is horribly(!) slow). Thus as * it into an DOM object and measuring that is horribly(!) slow). Thus as
* a "work around" we provide this option. It will append its value to the * a "work around" we provide this option. It will append its value to the
@ -7686,13 +7686,13 @@
*/ */
/** /**
* Initialisation options that can be given to DataTables at initialisation * Initialisation options that can be given to DataTables at initialisation
* time. * time.
* @namespace * @namespace
*/ */
DataTable.defaults = { DataTable.defaults = {
/** /**
* An array of data to use for the table, passed in at initialisation which * An array of data to use for the table, passed in at initialisation which
* will be used in preference to any data which is already in the DOM. This is * will be used in preference to any data which is already in the DOM. This is
* particularly useful for constructing tables purely in Javascript, for * particularly useful for constructing tables purely in Javascript, for
* example with a custom Ajax call. * example with a custom Ajax call.
@ -7701,7 +7701,7 @@
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.data * @name DataTable.defaults.data
* *
* @example * @example
* // Using a 2D array data source * // Using a 2D array data source
* $(document).ready( function () { * $(document).ready( function () {
@ -7719,7 +7719,7 @@
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using an array of objects as a data source (`data`) * // Using an array of objects as a data source (`data`)
* $(document).ready( function () { * $(document).ready( function () {
@ -7754,17 +7754,17 @@
/** /**
* If sorting is enabled, then DataTables will perform a first pass sort on * If sorting is enabled, then DataTables will perform a first pass sort on
* initialisation. You can define which column(s) the sort is performed upon, * initialisation. You can define which column(s) the sort is performed upon,
* and the sorting direction, with this variable. The `sorting` array should * and the sorting direction, with this variable. The `sorting` array should
* contain an array for each column to be sorted initially containing the * contain an array for each column to be sorted initially containing the
* column's index and a direction string ('asc' or 'desc'). * column's index and a direction string ('asc' or 'desc').
* @type array * @type array
* @default [[0,'asc']] * @default [[0,'asc']]
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.sorting * @name DataTable.defaults.sorting
* *
* @example * @example
* // Sort by 3rd column first, and then 4th column * // Sort by 3rd column first, and then 4th column
* $(document).ready( function() { * $(document).ready( function() {
@ -7772,7 +7772,7 @@
* "sorting": [[2,'asc'], [3,'desc']] * "sorting": [[2,'asc'], [3,'desc']]
* } ); * } );
* } ); * } );
* *
* // No initial sorting * // No initial sorting
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -7784,18 +7784,18 @@
/** /**
* This parameter is basically identical to the `sorting` parameter, but * This parameter is basically identical to the `sorting` parameter, but
* cannot be overridden by user interaction with the table. What this means * cannot be overridden by user interaction with the table. What this means
* is that you could have a column (visible or hidden) which the sorting will * is that you could have a column (visible or hidden) which the sorting will
* always be forced on first - any sorting after that (from the user) will * always be forced on first - any sorting after that (from the user) will
* then be performed as required. This can be useful for grouping rows * then be performed as required. This can be useful for grouping rows
* together. * together.
* @type array * @type array
* @default null * @default null
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.sortingFixed * @name DataTable.defaults.sortingFixed
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -7953,7 +7953,7 @@
* $('#example').dataTable( { * $('#example').dataTable( {
* "ajax": function (data, callback, settings) { * "ajax": function (data, callback, settings) {
* callback( * callback(
* JSON.parse( localStorage.getItem('dataTablesData') ) * JSON.parse( localStorage.getItem('dataTablesData') )
* ); * );
* } * }
* } ); * } );
@ -7963,10 +7963,10 @@
/** /**
* This parameter allows you to readily specify the entries in the length drop * This parameter allows you to readily specify the entries in the length drop
* down menu that DataTables shows when pagination is enabled. It can be * down menu that DataTables shows when pagination is enabled. It can be
* either a 1D array of options which will be used for both the displayed * either a 1D array of options which will be used for both the displayed
* option and the value, or a 2D array which will use the array in the first * option and the value, or a 2D array which will use the array in the first
* position as the value, and the array in the second position as the * position as the value, and the array in the second position as the
* displayed options (useful for language strings such as 'All'). * displayed options (useful for language strings such as 'All').
* *
* Note that the `displayLength` property will be automatically set to the * Note that the `displayLength` property will be automatically set to the
@ -7976,7 +7976,7 @@
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.lengthMenu * @name DataTable.defaults.lengthMenu
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -7990,7 +7990,7 @@
/** /**
* The `columns` option in the initialisation parameter allows you to define * The `columns` option in the initialisation parameter allows you to define
* details about the way individual columns behave. For a full list of * details about the way individual columns behave. For a full list of
* column options that can be set, please see * column options that can be set, please see
* {@link DataTable.defaults.column}. Note that if you use `columns` to * {@link DataTable.defaults.column}. Note that if you use `columns` to
* define your columns, you must have an entry in the array for every single * define your columns, you must have an entry in the array for every single
* column that you have in your table (these can be null if you don't which * column that you have in your table (these can be null if you don't which
@ -8002,11 +8002,11 @@
"aoColumns": null, "aoColumns": null,
/** /**
* Very similar to `columns`, `columnDefs` allows you to target a specific * Very similar to `columns`, `columnDefs` allows you to target a specific
* column, multiple columns, or all columns, using the `targets` property of * column, multiple columns, or all columns, using the `targets` property of
* each object in the array. This allows great flexibility when creating * each object in the array. This allows great flexibility when creating
* tables, as the `columnDefs` arrays can be of any length, targeting the * tables, as the `columnDefs` arrays can be of any length, targeting the
* columns you specifically want. `columnDefs` may use any of the column * columns you specifically want. `columnDefs` may use any of the column
* options available: {@link DataTable.defaults.column}, but it _must_ * options available: {@link DataTable.defaults.column}, but it _must_
* have `targets` defined in each object in the array. Values in the `targets` * have `targets` defined in each object in the array. Values in the `targets`
* array may be: * array may be:
@ -8025,7 +8025,7 @@
/** /**
* Basically the same as `search`, this parameter defines the individual column * Basically the same as `search`, this parameter defines the individual column
* filtering state at initialisation time. The array must be of the same size * filtering state at initialisation time. The array must be of the same size
* as the number of columns, and each element be an object with the parameters * as the number of columns, and each element be an object with the parameters
* `search` and `escapeRegex` (the latter is optional). 'null' is also * `search` and `escapeRegex` (the latter is optional). 'null' is also
* accepted and the default will be used. * accepted and the default will be used.
@ -8034,7 +8034,7 @@
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.searchCols * @name DataTable.defaults.searchCols
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8051,8 +8051,8 @@
/** /**
* An array of CSS classes that should be applied to displayed rows. This * An array of CSS classes that should be applied to displayed rows. This
* array may be of any length, and DataTables will apply each class * array may be of any length, and DataTables will apply each class
* sequentially, looping when required. * sequentially, looping when required.
* @type array * @type array
* @default null <i>Will take the values determined by the `oClasses.stripe*` * @default null <i>Will take the values determined by the `oClasses.stripe*`
@ -8060,7 +8060,7 @@
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.stripeClasses * @name DataTable.defaults.stripeClasses
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8080,7 +8080,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.autoWidth * @name DataTable.defaults.autoWidth
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8102,7 +8102,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.deferRender * @name DataTable.defaults.deferRender
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8115,7 +8115,7 @@
/** /**
* Replace a DataTable which matches the given selector and replace it with * Replace a DataTable which matches the given selector and replace it with
* one which has the properties of the new initialisation object passed. If no * one which has the properties of the new initialisation object passed. If no
* table matches the selector, then the new DataTable will be constructed as * table matches the selector, then the new DataTable will be constructed as
* per normal. * per normal.
@ -8124,14 +8124,14 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.destroy * @name DataTable.defaults.destroy
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "srollY": "200px", * "srollY": "200px",
* "paginate": false * "paginate": false
* } ); * } );
* *
* // Some time later.... * // Some time later....
* $('#example').dataTable( { * $('#example').dataTable( {
* "filter": false, * "filter": false,
@ -8155,7 +8155,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.filter * @name DataTable.defaults.filter
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8167,7 +8167,7 @@
/** /**
* Enable or disable the table information display. This shows information * Enable or disable the table information display. This shows information
* about the data that is currently visible on the page, including information * about the data that is currently visible on the page, including information
* about filtered data if that action is being performed. * about filtered data if that action is being performed.
* @type boolean * @type boolean
@ -8175,7 +8175,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.info * @name DataTable.defaults.info
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8195,7 +8195,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.jQueryUI * @name DataTable.defaults.jQueryUI
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8214,7 +8214,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.lengthChange * @name DataTable.defaults.lengthChange
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8232,7 +8232,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.paginate * @name DataTable.defaults.paginate
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8253,7 +8253,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.processing * @name DataTable.defaults.processing
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8277,13 +8277,13 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.retrieve * @name DataTable.defaults.retrieve
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* initTable(); * initTable();
* tableActions(); * tableActions();
* } ); * } );
* *
* function initTable () * function initTable ()
* { * {
* return $('#example').dataTable( { * return $('#example').dataTable( {
@ -8292,11 +8292,11 @@
* "retrieve": true * "retrieve": true
* } ); * } );
* } * }
* *
* function tableActions () * function tableActions ()
* { * {
* var table = initTable(); * var table = initTable();
* // perform API operations with oTable * // perform API operations with oTable
* } * }
*/ */
"bRetrieve": false, "bRetrieve": false,
@ -8311,7 +8311,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollAutoCss * @name DataTable.defaults.scrollAutoCss
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8335,7 +8335,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollCollapse * @name DataTable.defaults.scrollCollapse
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8359,7 +8359,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.scrollInfinite * @name DataTable.defaults.scrollInfinite
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8382,7 +8382,7 @@
* @dtopt Features * @dtopt Features
* @dtopt Server-side * @dtopt Server-side
* @name DataTable.defaults.serverSide * @name DataTable.defaults.serverSide
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8402,7 +8402,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.sort * @name DataTable.defaults.sort
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8422,7 +8422,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.sortCellsTop * @name DataTable.defaults.sortCellsTop
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8444,7 +8444,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.sortClasses * @name DataTable.defaults.sortClasses
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8456,11 +8456,11 @@
/** /**
* Enable or disable state saving. When enabled HTML5 `localStorage` will be * Enable or disable state saving. When enabled HTML5 `localStorage` will be
* used to save table display information such as pagination information, * used to save table display information such as pagination information,
* display length, filtering and sorting. As such when the end user reloads * display length, filtering and sorting. As such when the end user reloads
* the page the display display will match what thy had previously set up. * the page the display display will match what thy had previously set up.
* *
* Due to the use of `localStorage` the default state saving is not supported * Due to the use of `localStorage` the default state saving is not supported
* in IE6 or 7. If state saving is required in those browsers, use * in IE6 or 7. If state saving is required in those browsers, use
* `stateSaveCallback` to provide a storage solution such as cookies. * `stateSaveCallback` to provide a storage solution such as cookies.
@ -8469,7 +8469,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.stateSave * @name DataTable.defaults.stateSave
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8491,7 +8491,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.createdRow * @name DataTable.defaults.createdRow
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8516,7 +8516,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.drawCallback * @name DataTable.defaults.drawCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8535,16 +8535,16 @@
* @type function * @type function
* @param {node} foot "TR" element for the footer * @param {node} foot "TR" element for the footer
* @param {array} data Full table data (as derived from the original HTML) * @param {array} data Full table data (as derived from the original HTML)
* @param {int} start Index for the current display starting point in the * @param {int} start Index for the current display starting point in the
* display array * display array
* @param {int} end Index for the current display ending point in the * @param {int} end Index for the current display ending point in the
* display array * display array
* @param {array int} display Index array to translate the visual position * @param {array int} display Index array to translate the visual position
* to the full data array * to the full data array
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.footerCallback * @name DataTable.defaults.footerCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8570,7 +8570,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.formatNumber * @name DataTable.defaults.formatNumber
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8578,11 +8578,11 @@
* if ( toFormat &lt; 1000 ) { * if ( toFormat &lt; 1000 ) {
* return toFormat; * return toFormat;
* } else { * } else {
* var * var
* s=(toFormat+""), * s=(toFormat+""),
* a=s.split(""), out="", * a=s.split(""), out="",
* iLen=s.length; * iLen=s.length;
* *
* for ( var i=0 ; i&lt;iLen ; i++ ) { * for ( var i=0 ; i&lt;iLen ; i++ ) {
* if ( i%3 === 0 &amp;&amp; i !== 0 ) { * if ( i%3 === 0 &amp;&amp; i !== 0 ) {
* out = "'"+out; * out = "'"+out;
@ -8632,7 +8632,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.headerCallback * @name DataTable.defaults.headerCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8664,7 +8664,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.infoCallback * @name DataTable.defaults.infoCallback
* *
* @example * @example
* $('#example').dataTable( { * $('#example').dataTable( {
* "infoCallback": function( settings, start, end, nax, total, pre ) { * "infoCallback": function( settings, start, end, nax, total, pre ) {
@ -8687,7 +8687,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.initComplete * @name DataTable.defaults.initComplete
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8711,7 +8711,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.preDrawCallback * @name DataTable.defaults.preDrawCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8739,7 +8739,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.rowCallback * @name DataTable.defaults.rowCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8819,14 +8819,14 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateLoadCallback * @name DataTable.defaults.stateLoadCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "stateSave": true, * "stateSave": true,
* "stateLoadCallback": function (settings) { * "stateLoadCallback": function (settings) {
* var o; * var o;
* *
* // Send an Ajax request to the server to get the data. Note that * // Send an Ajax request to the server to get the data. Note that
* // this is a synchronous request. * // this is a synchronous request.
* $.ajax( { * $.ajax( {
@ -8837,7 +8837,7 @@
* o = json; * o = json;
* } * }
* } ); * } );
* *
* return o; * return o;
* } * }
* } ); * } );
@ -8845,7 +8845,7 @@
*/ */
"fnStateLoadCallback": function ( settings ) { "fnStateLoadCallback": function ( settings ) {
try { try {
return JSON.parse( return JSON.parse(
localStorage.getItem('DataTables_'+settings.sInstance+'_'+window.location.pathname) localStorage.getItem('DataTables_'+settings.sInstance+'_'+window.location.pathname)
); );
} catch (e) {} } catch (e) {}
@ -8855,8 +8855,8 @@
/** /**
* Callback which allows modification of the saved state prior to loading that state. * Callback which allows modification of the saved state prior to loading that state.
* This callback is called when the table is loading state from the stored data, but * This callback is called when the table is loading state from the stored data, but
* prior to the settings object being modified by the saved state. Note that for * prior to the settings object being modified by the saved state. Note that for
* plug-in authors, you should use the `stateLoadParams` event to load parameters for * plug-in authors, you should use the `stateLoadParams` event to load parameters for
* a plug-in. * a plug-in.
* @type function * @type function
* @param {object} settings DataTables settings object * @param {object} settings DataTables settings object
@ -8864,7 +8864,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateLoadParams * @name DataTable.defaults.stateLoadParams
* *
* @example * @example
* // Remove a saved filter, so filtering is never loaded * // Remove a saved filter, so filtering is never loaded
* $(document).ready( function() { * $(document).ready( function() {
@ -8875,7 +8875,7 @@
* } * }
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Disallow state loading by returning false * // Disallow state loading by returning false
* $(document).ready( function() { * $(document).ready( function() {
@ -8899,7 +8899,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateLoaded * @name DataTable.defaults.stateLoaded
* *
* @example * @example
* // Show an alert with the filtering value that was saved * // Show an alert with the filtering value that was saved
* $(document).ready( function() { * $(document).ready( function() {
@ -8925,7 +8925,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateSaveCallback * @name DataTable.defaults.stateSaveCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -8954,10 +8954,10 @@
/** /**
* Callback which allows modification of the state to be saved. Called when the table * Callback which allows modification of the state to be saved. Called when the table
* has changed state a new state save is required. This method allows modification of * has changed state a new state save is required. This method allows modification of
* the state saving object prior to actually doing the save, including addition or * the state saving object prior to actually doing the save, including addition or
* other state properties or modification. Note that for plug-in authors, you should * other state properties or modification. Note that for plug-in authors, you should
* use the `stateSaveParams` event to save parameters for a plug-in. * use the `stateSaveParams` event to save parameters for a plug-in.
* @type function * @type function
* @param {object} settings DataTables settings object * @param {object} settings DataTables settings object
@ -8965,7 +8965,7 @@
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateSaveParams * @name DataTable.defaults.stateSaveParams
* *
* @example * @example
* // Remove a saved filter, so filtering is never saved * // Remove a saved filter, so filtering is never saved
* $(document).ready( function() { * $(document).ready( function() {
@ -8989,7 +8989,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.stateDuration * @name DataTable.defaults.stateDuration
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9017,7 +9017,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.deferLoading * @name DataTable.defaults.deferLoading
* *
* @example * @example
* // 57 records available in the table, no filtering applied * // 57 records available in the table, no filtering applied
* $(document).ready( function() { * $(document).ready( function() {
@ -9027,7 +9027,7 @@
* "deferLoading": 57 * "deferLoading": 57
* } ); * } );
* } ); * } );
* *
* @example * @example
* // 57 records after filtering, 100 without filtering (an initial filter applied) * // 57 records after filtering, 100 without filtering (an initial filter applied)
* $(document).ready( function() { * $(document).ready( function() {
@ -9053,7 +9053,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.displayLength * @name DataTable.defaults.displayLength
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9074,7 +9074,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.displayStart * @name DataTable.defaults.displayStart
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9096,7 +9096,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollLoadGap * @name DataTable.defaults.scrollLoadGap
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9122,7 +9122,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.tabIndex * @name DataTable.defaults.tabIndex
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9158,7 +9158,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.aria.sortAscending * @name DataTable.defaults.language.aria.sortAscending
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9181,7 +9181,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.aria.sortDescending * @name DataTable.defaults.language.aria.sortDescending
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9211,7 +9211,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.first * @name DataTable.defaults.language.paginate.first
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9234,7 +9234,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.last * @name DataTable.defaults.language.paginate.last
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9250,14 +9250,14 @@
/** /**
* Text to use for the 'next' pagination button (to take the user to the * Text to use for the 'next' pagination button (to take the user to the
* next page). * next page).
* @type string * @type string
* @default Next * @default Next
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.next * @name DataTable.defaults.language.paginate.next
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9273,14 +9273,14 @@
/** /**
* Text to use for the 'previous' pagination button (to take the user to * Text to use for the 'previous' pagination button (to take the user to
* the previous page). * the previous page).
* @type string * @type string
* @default Previous * @default Previous
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.previous * @name DataTable.defaults.language.paginate.previous
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9305,7 +9305,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.emptyTable * @name DataTable.defaults.language.emptyTable
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9319,16 +9319,16 @@
/** /**
* This string gives information to the end user about the information that * This string gives information to the end user about the information that
* is current on display on the page. The _START_, _END_ and _TOTAL_ * is current on display on the page. The _START_, _END_ and _TOTAL_
* variables are all dynamically replaced as the table display updates, and * variables are all dynamically replaced as the table display updates, and
* can be freely moved or removed as the language requirements change. * can be freely moved or removed as the language requirements change.
* @type string * @type string
* @default Showing _START_ to _END_ of _TOTAL_ entries * @default Showing _START_ to _END_ of _TOTAL_ entries
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.info * @name DataTable.defaults.language.info
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9342,14 +9342,14 @@
/** /**
* Display information string for when the table is empty. Typically the * Display information string for when the table is empty. Typically the
* format of this string should match `info`. * format of this string should match `info`.
* @type string * @type string
* @default Showing 0 to 0 of 0 entries * @default Showing 0 to 0 of 0 entries
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoEmpty * @name DataTable.defaults.language.infoEmpty
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9363,15 +9363,15 @@
/** /**
* When a user filters the information in a table, this string is appended * When a user filters the information in a table, this string is appended
* to the information (`info`) to give an idea of how strong the filtering * to the information (`info`) to give an idea of how strong the filtering
* is. The variable _MAX_ is dynamically updated. * is. The variable _MAX_ is dynamically updated.
* @type string * @type string
* @default (filtered from _MAX_ total entries) * @default (filtered from _MAX_ total entries)
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoFiltered * @name DataTable.defaults.language.infoFiltered
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9394,7 +9394,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoPostFix * @name DataTable.defaults.language.infoPostFix
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9417,7 +9417,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoThousands * @name DataTable.defaults.language.infoThousands
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9437,10 +9437,10 @@
* with a custom select box if required. * with a custom select box if required.
* @type string * @type string
* @default Show _MENU_ entries * @default Show _MENU_ entries
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.lengthMenu * @name DataTable.defaults.language.lengthMenu
* *
* @example * @example
* // Language change only * // Language change only
* $(document).ready( function() { * $(document).ready( function() {
@ -9450,7 +9450,7 @@
* } * }
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Language and options change * // Language and options change
* $(document).ready( function() { * $(document).ready( function() {
@ -9482,7 +9482,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.loadingRecords * @name DataTable.defaults.language.loadingRecords
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9503,7 +9503,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.processing * @name DataTable.defaults.language.processing
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9527,7 +9527,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.search * @name DataTable.defaults.language.search
* *
* @example * @example
* // Input text box will be appended at the end automatically * // Input text box will be appended at the end automatically
* $(document).ready( function() { * $(document).ready( function() {
@ -9537,7 +9537,7 @@
* } * }
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Specify where the filter should appear * // Specify where the filter should appear
* $(document).ready( function() { * $(document).ready( function() {
@ -9563,7 +9563,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.url * @name DataTable.defaults.language.url
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9585,7 +9585,7 @@
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.zeroRecords * @name DataTable.defaults.language.zeroRecords
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9612,7 +9612,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.search * @name DataTable.defaults.search
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9626,7 +9626,7 @@
/** /**
* __Deprecated__ The functionality provided by this parameter has now been * __Deprecated__ The functionality provided by this parameter has now been
* superseded by that provided through `ajax`, which should be used instead. * superseded by that provided through `ajax`, which should be used instead.
* *
* By default DataTables will look for the property 'aaData' when obtaining * By default DataTables will look for the property 'aaData' when obtaining
* data from an Ajax source or for server-side processing - this parameter * data from an Ajax source or for server-side processing - this parameter
* allows that property to be changed. You can use Javascript dotted object * allows that property to be changed. You can use Javascript dotted object
@ -9671,7 +9671,7 @@
* table). DIV elements (with or without a custom class) can also be added to * table). DIV elements (with or without a custom class) can also be added to
* aid styling. The follow syntax is used: * aid styling. The follow syntax is used:
* <ul> * <ul>
* <li>The following options are allowed: * <li>The following options are allowed:
* <ul> * <ul>
* <li>'l' - Length changing</li * <li>'l' - Length changing</li
* <li>'f' - Filtering input</li> * <li>'f' - Filtering input</li>
@ -9702,12 +9702,12 @@
* </li> * </li>
* </ul> * </ul>
* @type string * @type string
* @default lfrtip <i>(when `jQueryUI` is false)</i> <b>or</b> * @default lfrtip <i>(when `jQueryUI` is false)</i> <b>or</b>
* <"H"lfr>t<"F"ip> <i>(when `jQueryUI` is true)</i> * <"H"lfr>t<"F"ip> <i>(when `jQueryUI` is true)</i>
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.dom * @name DataTable.defaults.dom
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9727,7 +9727,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.paginationType * @name DataTable.defaults.paginationType
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9749,7 +9749,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.scrollX * @name DataTable.defaults.scrollX
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9773,7 +9773,7 @@
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollXInner * @name DataTable.defaults.scrollXInner
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9797,7 +9797,7 @@
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.scrollY * @name DataTable.defaults.scrollY
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -9832,7 +9832,7 @@
/* /*
* Developer note - See note in model.defaults.js about the use of Hungarian * Developer note - See note in model.defaults.js about the use of Hungarian
* notation and camel case. * notation and camel case.
*/ */
@ -9842,15 +9842,15 @@
*/ */
DataTable.defaults.column = { DataTable.defaults.column = {
/** /**
* Allows a column's sorting to take multiple columns into account when * Allows a column's sorting to take multiple columns into account when
* doing a sort. For example first name / last name columns make sense to * doing a sort. For example first name / last name columns make sense to
* do a multi-column sort over the two columns. * do a multi-column sort over the two columns.
* @type array * @type array
* @default null <i>Takes the value of the column index automatically</i> * @default null <i>Takes the value of the column index automatically</i>
* *
* @name DataTable.defaults.column.dataSort * @name DataTable.defaults.column.dataSort
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
@ -9862,7 +9862,7 @@
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
@ -9889,7 +9889,7 @@
* *
* @name DataTable.defaults.column.sorting * @name DataTable.defaults.column.sorting
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
@ -9901,7 +9901,7 @@
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
@ -9926,21 +9926,21 @@
* *
* @name DataTable.defaults.column.searchable * @name DataTable.defaults.column.searchable
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "searchable": false, "targets": [ 0 ] } * { "searchable": false, "targets": [ 0 ] }
* ] } ); * ] } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "searchable": false }, * { "searchable": false },
* null, * null,
* null, * null,
@ -9959,21 +9959,21 @@
* *
* @name DataTable.defaults.column.sortable * @name DataTable.defaults.column.sortable
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "sortable": false, "targets": [ 0 ] } * { "sortable": false, "targets": [ 0 ] }
* ] } ); * ] } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "sortable": false }, * { "sortable": false },
* null, * null,
* null, * null,
@ -9992,21 +9992,21 @@
* *
* @name DataTable.defaults.column.visible * @name DataTable.defaults.column.visible
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "visible": false, "targets": [ 0 ] } * { "visible": false, "targets": [ 0 ] }
* ] } ); * ] } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "visible": false }, * { "visible": false },
* null, * null,
* null, * null,
@ -10032,7 +10032,7 @@
* *
* @name DataTable.defaults.column.createdCell * @name DataTable.defaults.column.createdCell
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -10059,22 +10059,22 @@
* *
* @name DataTable.defaults.column.dataSort * @name DataTable.defaults.column.dataSort
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "dataSort": 1, "targets": [ 0 ] } * { "dataSort": 1, "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "dataSort": 1 }, * { "dataSort": 1 },
* null, * null,
* null, * null,
@ -10276,7 +10276,7 @@
* but this parameter is much easier to use as there is no 'set' option. * but this parameter is much easier to use as there is no 'set' option.
* Like `data` this option can be given in a number of different ways to * Like `data` this option can be given in a number of different ways to
* effect its behaviour: * effect its behaviour:
* *
* * `integer` - treated as an array index for the data source. This is the * * `integer` - treated as an array index for the data source. This is the
* default that DataTables uses (incrementally increased for each column). * default that DataTables uses (incrementally increased for each column).
* * `string` - read an object property from the data source. There are * * `string` - read an object property from the data source. There are
@ -10316,7 +10316,7 @@
* *
* @name DataTable.defaults.column.render * @name DataTable.defaults.column.render
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Create a comma separated list from an array of objects * // Create a comma separated list from an array of objects
* $(document).ready( function() { * $(document).ready( function() {
@ -10332,7 +10332,7 @@
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Execute a function to obtain data * // Execute a function to obtain data
* $(document).ready( function() { * $(document).ready( function() {
@ -10344,7 +10344,7 @@
* } ] * } ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Use as a function to create a link from the data source * // Use as a function to create a link from the data source
* $(document).ready( function() { * $(document).ready( function() {
@ -10371,7 +10371,7 @@
* *
* @name DataTable.defaults.column.cellType * @name DataTable.defaults.column.cellType
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Make the first column use TH cells * // Make the first column use TH cells
* $(document).ready( function() { * $(document).ready( function() {
@ -10393,22 +10393,22 @@
* *
* @name DataTable.defaults.column.class * @name DataTable.defaults.column.class
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "class": "my_class", "targets": [ 0 ] } * { "class": "my_class", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "class": "my_class" }, * { "class": "my_class" },
* null, * null,
* null, * null,
@ -10424,7 +10424,7 @@
* When DataTables calculates the column widths to assign to each column, * When DataTables calculates the column widths to assign to each column,
* it finds the longest string in each column and then constructs a * it finds the longest string in each column and then constructs a
* temporary table and reads the widths from that. The problem with this * temporary table and reads the widths from that. The problem with this
* is that "mmm" is much wider then "iiii", but the latter is a longer * is that "mmm" is much wider then "iiii", but the latter is a longer
* string - thus the calculation can go wrong (doing it properly and putting * string - thus the calculation can go wrong (doing it properly and putting
* it into an DOM object and measuring that is horribly(!) slow). Thus as * it into an DOM object and measuring that is horribly(!) slow). Thus as
* a "work around" we provide this option. It will append its value to the * a "work around" we provide this option. It will append its value to the
@ -10435,12 +10435,12 @@
* *
* @name DataTable.defaults.column.contentPadding * @name DataTable.defaults.column.contentPadding
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* null, * null,
* null, * null,
* null, * null,
@ -10463,12 +10463,12 @@
* *
* @name DataTable.defaults.column.defaultContent * @name DataTable.defaults.column.defaultContent
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { * {
* "data": null, * "data": null,
* "defaultContent": "Edit", * "defaultContent": "Edit",
@ -10477,12 +10477,12 @@
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* null, * null,
* null, * null,
* null, * null,
@ -10509,12 +10509,12 @@
* *
* @name DataTable.defaults.column.name * @name DataTable.defaults.column.name
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "name": "engine", "targets": [ 0 ] }, * { "name": "engine", "targets": [ 0 ] },
* { "name": "browser", "targets": [ 1 ] }, * { "name": "browser", "targets": [ 1 ] },
* { "name": "platform", "targets": [ 2 ] }, * { "name": "platform", "targets": [ 2 ] },
@ -10523,12 +10523,12 @@
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "name": "engine" }, * { "name": "engine" },
* { "name": "browser" }, * { "name": "browser" },
* { "name": "platform" }, * { "name": "platform" },
@ -10551,7 +10551,7 @@
* *
* @name DataTable.defaults.column.sortDataType * @name DataTable.defaults.column.sortDataType
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
@ -10564,7 +10564,7 @@
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
@ -10586,27 +10586,27 @@
/** /**
* The title of this column. * The title of this column.
* @type string * @type string
* @default null <i>Derived from the 'TH' value for this column in the * @default null <i>Derived from the 'TH' value for this column in the
* original HTML table.</i> * original HTML table.</i>
* *
* @name DataTable.defaults.column.title * @name DataTable.defaults.column.title
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "title": "My column title", "targets": [ 0 ] } * { "title": "My column title", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "title": "My column title" }, * { "title": "My column title" },
* null, * null,
* null, * null,
@ -10632,22 +10632,22 @@
* *
* @name DataTable.defaults.column.type * @name DataTable.defaults.column.type
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "type": "html", "targets": [ 0 ] } * { "type": "html", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "type": "html" }, * { "type": "html" },
* null, * null,
* null, * null,
@ -10670,22 +10670,22 @@
* *
* @name DataTable.defaults.column.width * @name DataTable.defaults.column.width
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "width": "20%", "targets": [ 0 ] } * { "width": "20%", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "width": "20%" }, * { "width": "20%" },
* null, * null,
* null, * null,
@ -10707,11 +10707,11 @@
* given table, including configuration, data and current application of the * given table, including configuration, data and current application of the
* table options. DataTables does not have a single instance for each DataTable * table options. DataTables does not have a single instance for each DataTable
* with the settings attached to that instance, but rather instances of the * with the settings attached to that instance, but rather instances of the
* DataTable "class" are created on-the-fly as needed (typically by a * DataTable "class" are created on-the-fly as needed (typically by a
* $().dataTable() call) and the settings object is then applied to that * $().dataTable() call) and the settings object is then applied to that
* instance. * instance.
* *
* Note that this object is related to {@link DataTable.defaults} but this * Note that this object is related to {@link DataTable.defaults} but this
* one is the internal data store for DataTables's cache of columns. It should * one is the internal data store for DataTables's cache of columns. It should
* NOT be manipulated outside of DataTables. Any configuration should be done * NOT be manipulated outside of DataTables. Any configuration should be done
* through the initialisation options. * through the initialisation options.
@ -10719,7 +10719,7 @@
* @todo Really should attach the settings object to individual instances so we * @todo Really should attach the settings object to individual instances so we
* don't need to create new instances on each $().dataTable() call (if the * don't need to create new instances on each $().dataTable() call (if the
* table already exists). It would also save passing oSettings around and * table already exists). It would also save passing oSettings around and
* into every single function. However, this is a very significant * into every single function. However, this is a very significant
* architecture change for DataTables and will almost certainly break * architecture change for DataTables and will almost certainly break
* backwards compatibility with older installations. This is something that * backwards compatibility with older installations. This is something that
* will be done in 2.0. * will be done in 2.0.
@ -10877,7 +10877,7 @@
"iBarWidth": 0, "iBarWidth": 0,
/** /**
* Space (in pixels) between the bottom of the scrolling container and * Space (in pixels) between the bottom of the scrolling container and
* the bottom of the scrolling viewport before the next page is loaded * the bottom of the scrolling viewport before the next page is loaded
* when using infinite scrolling. * when using infinite scrolling.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
@ -10887,7 +10887,7 @@
"iLoadGap": null, "iLoadGap": null,
/** /**
* Viewport width for horizontal scrolling. Horizontal scrolling is * Viewport width for horizontal scrolling. Horizontal scrolling is
* disabled if an empty string. * disabled if an empty string.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -10922,7 +10922,7 @@
*/ */
"oLanguage": { "oLanguage": {
/** /**
* Information callback function. See * Information callback function. See
* {@link DataTable.defaults.fnInfoCallback} * {@link DataTable.defaults.fnInfoCallback}
* @type function * @type function
* @default null * @default null
@ -10958,7 +10958,7 @@
/** /**
* Array referencing the nodes which are used for the features. The * Array referencing the nodes which are used for the features. The
* parameters of this object match what is allowed by sDom - i.e. * parameters of this object match what is allowed by sDom - i.e.
* <ul> * <ul>
* <li>'l' - Length changing</li> * <li>'l' - Length changing</li>
@ -11024,7 +11024,7 @@
"asDataSearch": [], "asDataSearch": [],
/** /**
* Store the applied global search information in case we want to force a * Store the applied global search information in case we want to force a
* research or compare the old search to a new one. * research or compare the old search to a new one.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -11034,7 +11034,7 @@
"oPreviousSearch": {}, "oPreviousSearch": {},
/** /**
* Store the applied search for each column - see * Store the applied search for each column - see
* {@link DataTable.models.oSearch} for the format that is used for the * {@link DataTable.models.oSearch} for the format that is used for the
* filtering information for each column. * filtering information for each column.
* @type array * @type array
@ -11084,7 +11084,7 @@
"asDestroyStripes": [], "asDestroyStripes": [],
/** /**
* If restoring a table - we should restore its width * If restoring a table - we should restore its width
* @type int * @type int
* @default 0 * @default 0
*/ */
@ -11126,7 +11126,7 @@
"aoRowCreatedCallback": [], "aoRowCreatedCallback": [],
/** /**
* Callback functions for just before the table is redrawn. A return of * Callback functions for just before the table is redrawn. A return of
* false will be used to cancel the draw. * false will be used to cancel the draw.
* @type array * @type array
* @default [] * @default []
@ -11208,7 +11208,7 @@
"nTableWrapper": null, "nTableWrapper": null,
/** /**
* Indicate if when using server-side processing the loading of data * Indicate if when using server-side processing the loading of data
* should be deferred until the second draw. * should be deferred until the second draw.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -11246,7 +11246,7 @@
* Which type of pagination should be used. * Which type of pagination should be used.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
* @type string * @type string
* @default two_button * @default two_button
*/ */
"sPaginationType": "two_button", "sPaginationType": "two_button",
@ -11261,12 +11261,12 @@
"iStateDuration": 0, "iStateDuration": 0,
/** /**
* Array of callback functions for state saving. Each array element is an * Array of callback functions for state saving. Each array element is an
* object with the following parameters: * object with the following parameters:
* <ul> * <ul>
* <li>function:fn - function to call. Takes two parameters, oSettings * <li>function:fn - function to call. Takes two parameters, oSettings
* and the JSON string to save that has been thus far created. Returns * and the JSON string to save that has been thus far created. Returns
* a JSON string to be inserted into a json object * a JSON string to be inserted into a json object
* (i.e. '"param": [ 0, 1, 2]')</li> * (i.e. '"param": [ 0, 1, 2]')</li>
* <li>string:sName - name of callback</li> * <li>string:sName - name of callback</li>
* </ul> * </ul>
@ -11276,10 +11276,10 @@
"aoStateSave": [], "aoStateSave": [],
/** /**
* Array of callback functions for state loading. Each array element is an * Array of callback functions for state loading. Each array element is an
* object with the following parameters: * object with the following parameters:
* <ul> * <ul>
* <li>function:fn - function to call. Takes two parameters, oSettings * <li>function:fn - function to call. Takes two parameters, oSettings
* and the object stored. May return false to cancel state loading</li> * and the object stored. May return false to cancel state loading</li>
* <li>string:sName - name of callback</li> * <li>string:sName - name of callback</li>
* </ul> * </ul>
@ -11306,7 +11306,7 @@
/** /**
* Property from a given object from which to read the table data from. This * Property from a given object from which to read the table data from. This
* can be an empty string (when not server-side processing), in which case * can be an empty string (when not server-side processing), in which case
* it is assumed an an array is given directly. * it is assumed an an array is given directly.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -11322,8 +11322,8 @@
"bAjaxDataGet": true, "bAjaxDataGet": true,
/** /**
* The last jQuery XHR object that was used for server-side data gathering. * The last jQuery XHR object that was used for server-side data gathering.
* This can be used for working with the XHR information in one of the * This can be used for working with the XHR information in one of the
* callbacks * callbacks
* @type object * @type object
* @default null * @default null
@ -11339,7 +11339,7 @@
"fnServerData": null, "fnServerData": null,
/** /**
* Functions which are called prior to sending an Ajax request so extra * Functions which are called prior to sending an Ajax request so extra
* parameters can easily be sent to the server * parameters can easily be sent to the server
* @type array * @type array
* @default [] * @default []
@ -11347,7 +11347,7 @@
"aoServerParams": [], "aoServerParams": [],
/** /**
* Send the XHR HTTP method - GET or POST (could be PUT or DELETE if * Send the XHR HTTP method - GET or POST (could be PUT or DELETE if
* required). * required).
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -11455,7 +11455,7 @@
"oClasses": {}, "oClasses": {},
/** /**
* Flag attached to the settings object so you can check in the draw * Flag attached to the settings object so you can check in the draw
* callback if filtering has been done in the draw. Deprecated in favour of * callback if filtering has been done in the draw. Deprecated in favour of
* events. * events.
* @type boolean * @type boolean
@ -11465,7 +11465,7 @@
"bFiltered": false, "bFiltered": false,
/** /**
* Flag attached to the settings object so you can check in the draw * Flag attached to the settings object so you can check in the draw
* callback if sorting has been done in the draw. Deprecated in favour of * callback if sorting has been done in the draw. Deprecated in favour of
* events. * events.
* @type boolean * @type boolean
@ -11475,8 +11475,8 @@
"bSorted": false, "bSorted": false,
/** /**
* Indicate that if multiple rows are in the header and there is more than * Indicate that if multiple rows are in the header and there is more than
* one unique cell per column, if the top one (true) or bottom one (false) * one unique cell per column, if the top one (true) or bottom one (false)
* should be used for sorting / title by DataTables. * should be used for sorting / title by DataTables.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -11537,7 +11537,7 @@
if ( this.oFeatures.bPaginate === false || this._iDisplayLength == -1 ) { if ( this.oFeatures.bPaginate === false || this._iDisplayLength == -1 ) {
return this._iDisplayStart+this.aiDisplay.length; return this._iDisplayStart+this.aiDisplay.length;
} else { } else {
return Math.min( this._iDisplayStart+this._iDisplayLength, return Math.min( this._iDisplayStart+this._iDisplayLength,
this._iRecordsDisplay ); this._iRecordsDisplay );
} }
} else { } else {
@ -11703,7 +11703,7 @@
/* /*
* Variable: oPagination * Variable: oPagination
* Purpose: * Purpose:
* Scope: jQuery.fn.dataTableExt * Scope: jQuery.fn.dataTableExt
*/ */
$.extend( DataTable.ext.oPagination, { $.extend( DataTable.ext.oPagination, {
@ -11786,7 +11786,7 @@
/* Previous page */ /* Previous page */
nNode.className = ( oSettings._iDisplayStart === 0 ) ? nNode.className = ( oSettings._iDisplayStart === 0 ) ?
oClasses.sPagePrevDisabled : oClasses.sPagePrevEnabled; oClasses.sPagePrevDisabled : oClasses.sPagePrevEnabled;
/* Next page */ /* Next page */
nNode = nNode.nextSibling; nNode = nNode.nextSibling;
nNode.className = ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) ? nNode.className = ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) ?
@ -11944,12 +11944,12 @@
/* Update the permanent button's classes */ /* Update the permanent button's classes */
anButtons = nNode.getElementsByTagName('a'); anButtons = nNode.getElementsByTagName('a');
anStatic = [ anStatic = [
anButtons[0], anButtons[1], anButtons[0], anButtons[1],
anButtons[anButtons.length-2], anButtons[anButtons.length-1] anButtons[anButtons.length-2], anButtons[anButtons.length-1]
]; ];
$(anStatic).removeClass( oClasses.sPageButton+" "+oClasses.sPageButtonActive+" "+oClasses.sPageButtonStaticDisabled ); $(anStatic).removeClass( oClasses.sPageButton+" "+oClasses.sPageButtonActive+" "+oClasses.sPageButtonStaticDisabled );
$([anStatic[0], anStatic[1]]).addClass( $([anStatic[0], anStatic[1]]).addClass(
(iCurrentPage==1) ? (iCurrentPage==1) ?
oClasses.sPageButtonStaticDisabled : oClasses.sPageButtonStaticDisabled :
oClasses.sPageButton oClasses.sPageButton
@ -11980,7 +11980,7 @@
return a.toLowerCase(); return a.toLowerCase();
}, },
// string-asc and -desc are retained only for compatibility with // string-asc and -desc are retained only for compatibility with
"string-asc": function ( x, y ) "string-asc": function ( x, y )
{ {
return ((x < y) ? -1 : ((x > y) ? 1 : 0)); return ((x < y) ? -1 : ((x > y) ? 1 : 0));

2
media/src/api/api.internal.js
View File

@ -14,7 +14,7 @@
function _fnExternApiFunc (sFunc) function _fnExternApiFunc (sFunc)
{ {
return function() { return function() {
var aArgs = [_fnSettingsFromNode(this[DataTable.ext.iApiIndex])].concat( var aArgs = [_fnSettingsFromNode(this[DataTable.ext.iApiIndex])].concat(
Array.prototype.slice.call(arguments) ); Array.prototype.slice.call(arguments) );
return DataTable.ext.oApi[sFunc].apply( this, aArgs ); return DataTable.ext.oApi[sFunc].apply( this, aArgs );
}; };

108
media/src/api/api.methods.js
View File

@ -9,7 +9,7 @@
* Can be either 'current', whereby the current sorting of the table is used, or * Can be either 'current', whereby the current sorting of the table is used, or
* 'original' whereby the original order the data was read into the table is used. * 'original' whereby the original order the data was read into the table is used.
* @param {string} [oOpts.page=all] Limit the selection to the currently displayed page * @param {string} [oOpts.page=all] Limit the selection to the currently displayed page
* ("current") or not ("all"). If 'current' is given, then order is assumed to be * ("current") or not ("all"). If 'current' is given, then order is assumed to be
* 'current' and filter is 'applied', regardless of what they might be given as. * 'current' and filter is 'applied', regardless of what they might be given as.
* @returns {object} jQuery object, filtered by the given selector. * @returns {object} jQuery object, filtered by the given selector.
* @dtopt API * @dtopt API
@ -130,7 +130,7 @@ this.$ = function ( sSelector, oOpts )
* Almost identical to $ in operation, but in this case returns the data for the matched * Almost identical to $ in operation, but in this case returns the data for the matched
* rows - as such, the jQuery selector used should match TR row nodes or TD/TH cell nodes * rows - as such, the jQuery selector used should match TR row nodes or TD/TH cell nodes
* rather than any descendants, so the data can be obtained for the row/cell. If matching * rather than any descendants, so the data can be obtained for the row/cell. If matching
* rows are found, the data returned is the original data array/object that was used to * rows are found, the data returned is the original data array/object that was used to
* create the row (or a generated array if from a DOM source). * create the row (or a generated array if from a DOM source).
* *
* This method is often useful in-combination with $ where both functions are given the * This method is often useful in-combination with $ where both functions are given the
@ -143,10 +143,10 @@ this.$ = function ( sSelector, oOpts )
* Can be either 'current', whereby the current sorting of the table is used, or * Can be either 'current', whereby the current sorting of the table is used, or
* 'original' whereby the original order the data was read into the table is used. * 'original' whereby the original order the data was read into the table is used.
* @param {string} [oOpts.page=all] Limit the selection to the currently displayed page * @param {string} [oOpts.page=all] Limit the selection to the currently displayed page
* ("current") or not ("all"). If 'current' is given, then order is assumed to be * ("current") or not ("all"). If 'current' is given, then order is assumed to be
* 'current' and filter is 'applied', regardless of what they might be given as. * 'current' and filter is 'applied', regardless of what they might be given as.
* @returns {array} Data for the matched elements. If any elements, as a result of the * @returns {array} Data for the matched elements. If any elements, as a result of the
* selector, were not TR, TD or TH elements in the DataTable, they will have a null * selector, were not TR, TD or TH elements in the DataTable, they will have a null
* entry in the array. * entry in the array.
* @dtopt API * @dtopt API
* *
@ -165,10 +165,10 @@ this.$ = function ( sSelector, oOpts )
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Filter to 'Webkit' and get all data for * // Filter to 'Webkit' and get all data for
* oTable.fnFilter('Webkit'); * oTable.fnFilter('Webkit');
* var data = oTable._('tr', {"filter": "applied"}); * var data = oTable._('tr', {"filter": "applied"});
* *
* // Do something with the data * // Do something with the data
* alert( data.length+" rows matched the filter" ); * alert( data.length+" rows matched the filter" );
* } ); * } );
@ -190,7 +190,7 @@ this._ = function ( sSelector, oOpts )
/** /**
* Add a single new row or multiple rows of data to the table. Please note * Add a single new row or multiple rows of data to the table. Please note
* that this is suitable for client-side processing only - if you are using * that this is suitable for client-side processing only - if you are using
* server-side processing (i.e. "bServerSide": true), then to add data, you * server-side processing (i.e. "bServerSide": true), then to add data, you
* must add it to the data source, i.e. the server-side, through an Ajax call. * must add it to the data source, i.e. the server-side, through an Ajax call.
* @param {array|object} mData The data to be added to the table. This can be: * @param {array|object} mData The data to be added to the table. This can be:
@ -201,19 +201,19 @@ this._ = function ( sSelector, oOpts )
* <li>array of objects - multiple data objects when using <i>mData</i></li> * <li>array of objects - multiple data objects when using <i>mData</i></li>
* </ul> * </ul>
* @param {bool} [bRedraw=true] redraw the table or not * @param {bool} [bRedraw=true] redraw the table or not
* @returns {array} An array of integers, representing the list of indexes in * @returns {array} An array of integers, representing the list of indexes in
* <i>aoData</i> ({@link DataTable.models.oSettings}) that have been added to * <i>aoData</i> ({@link DataTable.models.oSettings}) that have been added to
* the table. * the table.
* @dtopt API * @dtopt API
* *
* @example * @example
* // Global var for counter * // Global var for counter
* var giCount = 2; * var giCount = 2;
* *
* $(document).ready(function() { * $(document).ready(function() {
* $('#example').dataTable(); * $('#example').dataTable();
* } ); * } );
* *
* function fnClickAddRow() { * function fnClickAddRow() {
* $('#example').dataTable().fnAddData( [ * $('#example').dataTable().fnAddData( [
* giCount+".1", * giCount+".1",
@ -221,7 +221,7 @@ this._ = function ( sSelector, oOpts )
* giCount+".3", * giCount+".3",
* giCount+".4" ] * giCount+".4" ]
* ); * );
* *
* giCount++; * giCount++;
* } * }
*/ */
@ -272,9 +272,9 @@ this.fnAddData = function( mData, bRedraw )
/** /**
* This function will make DataTables recalculate the column sizes, based on the data * This function will make DataTables recalculate the column sizes, based on the data
* contained in the table and the sizes applied to the columns (in the DOM, CSS or * contained in the table and the sizes applied to the columns (in the DOM, CSS or
* through the sWidth parameter). This can be useful when the width of the table's * through the sWidth parameter). This can be useful when the width of the table's
* parent element changes (for example a window resize). * parent element changes (for example a window resize).
* @param {boolean} [bRedraw=true] Redraw the table or not, you will typically want to * @param {boolean} [bRedraw=true] Redraw the table or not, you will typically want to
* @dtopt API * @dtopt API
@ -285,7 +285,7 @@ this.fnAddData = function( mData, bRedraw )
* "sScrollY": "200px", * "sScrollY": "200px",
* "bPaginate": false * "bPaginate": false
* } ); * } );
* *
* $(window).bind('resize', function () { * $(window).bind('resize', function () {
* oTable.fnAdjustColumnSizing(); * oTable.fnAdjustColumnSizing();
* } ); * } );
@ -316,7 +316,7 @@ this.fnAdjustColumnSizing = function ( bRedraw )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Immediately 'nuke' the current rows (perhaps waiting for an Ajax callback...) * // Immediately 'nuke' the current rows (perhaps waiting for an Ajax callback...)
* oTable.fnClearTable(); * oTable.fnClearTable();
* } ); * } );
@ -335,7 +335,7 @@ this.fnClearTable = function( bRedraw )
/** /**
* The exact opposite of 'opening' a row, this function will close any rows which * The exact opposite of 'opening' a row, this function will close any rows which
* are currently 'open'. * are currently 'open'.
* @param {node} nTr the table row to 'close' * @param {node} nTr the table row to 'close'
* @returns {int} 0 on success, or 1 if failed (can't find the row) * @returns {int} 0 on success, or 1 if failed (can't find the row)
@ -344,7 +344,7 @@ this.fnClearTable = function( bRedraw )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable; * var oTable;
* *
* // 'open' an information row when a row is clicked on * // 'open' an information row when a row is clicked on
* $('#example tbody tr').click( function () { * $('#example tbody tr').click( function () {
* if ( oTable.fnIsOpen(this) ) { * if ( oTable.fnIsOpen(this) ) {
@ -353,7 +353,7 @@ this.fnClearTable = function( bRedraw )
* oTable.fnOpen( this, "Temporary row opened", "info_row" ); * oTable.fnOpen( this, "Temporary row opened", "info_row" );
* } * }
* } ); * } );
* *
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
*/ */
@ -392,7 +392,7 @@ this.fnClose = function( nTr )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Immediately remove the first row * // Immediately remove the first row
* oTable.fnDeleteRow( 0 ); * oTable.fnDeleteRow( 0 );
* } ); * } );
@ -403,7 +403,7 @@ this.fnDeleteRow = function( mTarget, fnCallBack, bRedraw )
var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] ); var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] );
var i, iLen, iAODataIndex; var i, iLen, iAODataIndex;
iAODataIndex = (typeof mTarget === 'object') ? iAODataIndex = (typeof mTarget === 'object') ?
_fnNodeToDataIndex(oSettings, mTarget) : mTarget; _fnNodeToDataIndex(oSettings, mTarget) : mTarget;
/* Return the data array from this row */ /* Return the data array from this row */
@ -453,7 +453,7 @@ this.fnDeleteRow = function( mTarget, fnCallBack, bRedraw )
/** /**
* Restore the table to it's original state in the DOM by removing all of DataTables * Restore the table to it's original state in the DOM by removing all of DataTables
* enhancements, alterations to the DOM structure of the table and event listeners. * enhancements, alterations to the DOM structure of the table and event listeners.
* @param {boolean} [bRemove=false] Completely remove the table from the DOM * @param {boolean} [bRemove=false] Completely remove the table from the DOM
* @dtopt API * @dtopt API
@ -601,7 +601,7 @@ this.fnDestroy = function ( bRemove )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Re-draw the table - you wouldn't want to do it here, but it's an example :-) * // Re-draw the table - you wouldn't want to do it here, but it's an example :-)
* oTable.fnDraw(); * oTable.fnDraw();
* } ); * } );
@ -634,7 +634,7 @@ this.fnDraw = function( bComplete )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Sometime later - filter... * // Sometime later - filter...
* oTable.fnFilter( 'test string' ); * oTable.fnFilter( 'test string' );
* } ); * } );
@ -712,7 +712,7 @@ this.fnFilter = function( sInput, iColumn, bRegex, bSmart, bShowGlobal, bCaseIns
/** /**
* Get the data for the whole table, an individual row or an individual cell based on the * Get the data for the whole table, an individual row or an individual cell based on the
* provided parameters. * provided parameters.
* @param {int|node} [mRow] A TR row node, TD/TH cell node or an integer. If given as * @param {int|node} [mRow] A TR row node, TD/TH cell node or an integer. If given as
* a TR node then the data source for the whole row will be returned. If given as a * a TR node then the data source for the whole row will be returned. If given as a
@ -780,8 +780,8 @@ this.fnGetData = function( mRow, iCol )
/** /**
* Get an array of the TR nodes that are used in the table's body. Note that you will * Get an array of the TR nodes that are used in the table's body. Note that you will
* typically want to use the '$' API method in preference to this as it is more * typically want to use the '$' API method in preference to this as it is more
* flexible. * flexible.
* @param {int} [iRow] Optional row index for the TR element you want * @param {int} [iRow] Optional row index for the TR element you want
* @returns {array|node} If iRow is undefined, returns an array of all TR elements * @returns {array|node} If iRow is undefined, returns an array of all TR elements
@ -791,7 +791,7 @@ this.fnGetData = function( mRow, iCol )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Get the nodes from the table * // Get the nodes from the table
* var nNodes = oTable.fnGetNodes( ); * var nNodes = oTable.fnGetNodes( );
* } ); * } );
@ -813,7 +813,7 @@ this.fnGetNodes = function( iRow )
* and column index including hidden columns * and column index including hidden columns
* @param {node} nNode this can either be a TR, TD or TH in the table's body * @param {node} nNode this can either be a TR, TD or TH in the table's body
* @returns {int} If nNode is given as a TR, then a single index is returned, or * @returns {int} If nNode is given as a TR, then a single index is returned, or
* if given as a cell, an array of [row index, column index (visible), * if given as a cell, an array of [row index, column index (visible),
* column index (all)] is given. * column index (all)] is given.
* @dtopt API * @dtopt API
* *
@ -822,15 +822,15 @@ this.fnGetNodes = function( iRow )
* $('#example tbody td').click( function () { * $('#example tbody td').click( function () {
* // Get the position of the current data from the node * // Get the position of the current data from the node
* var aPos = oTable.fnGetPosition( this ); * var aPos = oTable.fnGetPosition( this );
* *
* // Get the data array for this row * // Get the data array for this row
* var aData = oTable.fnGetData( aPos[0] ); * var aData = oTable.fnGetData( aPos[0] );
* *
* // Update the data array and return the value * // Update the data array and return the value
* aData[ aPos[1] ] = 'clicked'; * aData[ aPos[1] ] = 'clicked';
* this.innerHTML = 'clicked'; * this.innerHTML = 'clicked';
* } ); * } );
* *
* // Init DataTables * // Init DataTables
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
@ -863,7 +863,7 @@ this.fnGetPosition = function( nNode )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable; * var oTable;
* *
* // 'open' an information row when a row is clicked on * // 'open' an information row when a row is clicked on
* $('#example tbody tr').click( function () { * $('#example tbody tr').click( function () {
* if ( oTable.fnIsOpen(this) ) { * if ( oTable.fnIsOpen(this) ) {
@ -872,7 +872,7 @@ this.fnGetPosition = function( nNode )
* oTable.fnOpen( this, "Temporary row opened", "info_row" ); * oTable.fnOpen( this, "Temporary row opened", "info_row" );
* } * }
* } ); * } );
* *
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
*/ */
@ -893,9 +893,9 @@ this.fnIsOpen = function( nTr )
/** /**
* This function will place a new row directly after a row which is currently * This function will place a new row directly after a row which is currently
* on display on the page, with the HTML contents that is passed into the * on display on the page, with the HTML contents that is passed into the
* function. This can be used, for example, to ask for confirmation that a * function. This can be used, for example, to ask for confirmation that a
* particular record should be deleted. * particular record should be deleted.
* @param {node} nTr The table row to 'open' * @param {node} nTr The table row to 'open'
* @param {string|node|jQuery} mHtml The HTML to put into the row * @param {string|node|jQuery} mHtml The HTML to put into the row
@ -908,7 +908,7 @@ this.fnIsOpen = function( nTr )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable; * var oTable;
* *
* // 'open' an information row when a row is clicked on * // 'open' an information row when a row is clicked on
* $('#example tbody tr').click( function () { * $('#example tbody tr').click( function () {
* if ( oTable.fnIsOpen(this) ) { * if ( oTable.fnIsOpen(this) ) {
@ -917,7 +917,7 @@ this.fnIsOpen = function( nTr )
* oTable.fnOpen( this, "Temporary row opened", "info_row" ); * oTable.fnOpen( this, "Temporary row opened", "info_row" );
* } * }
* } ); * } );
* *
* oTable = $('#example').dataTable(); * oTable = $('#example').dataTable();
* } ); * } );
*/ */
@ -968,8 +968,8 @@ this.fnOpen = function( nTr, mHtml, sClass )
/** /**
* Change the pagination - provides the internal logic for pagination in a simple API * Change the pagination - provides the internal logic for pagination in a simple API
* function. With this function you can have a DataTables table go to the next, * function. With this function you can have a DataTables table go to the next,
* previous, first or last pages. * previous, first or last pages.
* @param {string|int} mAction Paging action to take: "first", "previous", "next" or "last" * @param {string|int} mAction Paging action to take: "first", "previous", "next" or "last"
* or page number to jump to (integer), note that page 0 is the first page. * or page number to jump to (integer), note that page 0 is the first page.
@ -1005,7 +1005,7 @@ this.fnPageChange = function ( mAction, bRedraw )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Hide the second column after initialisation * // Hide the second column after initialisation
* oTable.fnSetColumnVis( 1, false ); * oTable.fnSetColumnVis( 1, false );
* } ); * } );
@ -1058,14 +1058,14 @@ this.fnSetColumnVis = function ( iCol, bShow, bRedraw )
{ {
if ( bAppend ) if ( bAppend )
{ {
aoData[i].nTr.appendChild( aoData[i].nTr.appendChild(
aoData[i]._anHidden[iCol] aoData[i]._anHidden[iCol]
); );
} }
else else
{ {
aoData[i].nTr.insertBefore( aoData[i].nTr.insertBefore(
aoData[i]._anHidden[iCol], aoData[i]._anHidden[iCol],
_fnGetTdNodes( oSettings, i )[iBefore] ); _fnGetTdNodes( oSettings, i )[iBefore] );
} }
} }
@ -1101,8 +1101,8 @@ this.fnSetColumnVis = function ( iCol, bShow, bRedraw )
oSettings.aoOpenRows[i].nTr.colSpan = _fnVisbleColumns( oSettings ); oSettings.aoOpenRows[i].nTr.colSpan = _fnVisbleColumns( oSettings );
} }
/* Do a redraw incase anything depending on the table columns needs it /* Do a redraw incase anything depending on the table columns needs it
* (built-in: scrolling) * (built-in: scrolling)
*/ */
if ( bRedraw === undefined || bRedraw ) if ( bRedraw === undefined || bRedraw )
{ {
@ -1116,7 +1116,7 @@ this.fnSetColumnVis = function ( iCol, bShow, bRedraw )
/** /**
* Get the settings for a particular table for external manipulation * Get the settings for a particular table for external manipulation
* @returns {object} DataTables settings object. See * @returns {object} DataTables settings object. See
* {@link DataTable.models.oSettings} * {@link DataTable.models.oSettings}
* @dtopt API * @dtopt API
* *
@ -1124,7 +1124,7 @@ this.fnSetColumnVis = function ( iCol, bShow, bRedraw )
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* var oSettings = oTable.fnSettings(); * var oSettings = oTable.fnSettings();
* *
* // Show an example parameter from the settings * // Show an example parameter from the settings
* alert( oSettings._iDisplayStart ); * alert( oSettings._iDisplayStart );
* } ); * } );
@ -1137,14 +1137,14 @@ this.fnSettings = function()
/** /**
* Sort the table by a particular column * Sort the table by a particular column
* @param {int} iCol the data index to sort on. Note that this will not match the * @param {int} iCol the data index to sort on. Note that this will not match the
* 'display index' if you have hidden data entries * 'display index' if you have hidden data entries
* @dtopt API * @dtopt API
* *
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Sort immediately with columns 0 and 1 * // Sort immediately with columns 0 and 1
* oTable.fnSort( [ [0,'asc'], [1,'asc'] ] ); * oTable.fnSort( [ [0,'asc'], [1,'asc'] ] );
* } ); * } );
@ -1167,7 +1167,7 @@ this.fnSort = function( aaSort )
* @example * @example
* $(document).ready(function() { * $(document).ready(function() {
* var oTable = $('#example').dataTable(); * var oTable = $('#example').dataTable();
* *
* // Sort on column 1, when 'sorter' is clicked on * // Sort on column 1, when 'sorter' is clicked on
* oTable.fnSortListener( document.getElementById('sorter'), 1 ); * oTable.fnSortListener( document.getElementById('sorter'), 1 );
* } ); * } );
@ -1204,7 +1204,7 @@ this.fnUpdate = function( mData, mRow, iColumn, bRedraw, bAction )
{ {
var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] ); var oSettings = _fnSettingsFromNode( this[DataTable.ext.iApiIndex] );
var i, sDisplay; var i, sDisplay;
var iRow = (typeof mRow === 'object') ? var iRow = (typeof mRow === 'object') ?
_fnNodeToDataIndex(oSettings, mRow) : mRow; _fnNodeToDataIndex(oSettings, mRow) : mRow;
if ( iColumn === undefined || iColumn === null ) if ( iColumn === undefined || iColumn === null )
@ -1236,7 +1236,7 @@ this.fnUpdate = function( mData, mRow, iColumn, bRedraw, bAction )
*/ */
var iDisplayIndex = $.inArray( iRow, oSettings.aiDisplay ); var iDisplayIndex = $.inArray( iRow, oSettings.aiDisplay );
oSettings.asDataSearch[iDisplayIndex] = _fnBuildSearchRow( oSettings.asDataSearch[iDisplayIndex] = _fnBuildSearchRow(
oSettings, oSettings,
_fnGetRowData( oSettings, iRow, 'filter', _fnGetColumns( oSettings, 'bSearchable' ) ) _fnGetRowData( oSettings, iRow, 'filter', _fnGetColumns( oSettings, 'bSearchable' ) )
); );

2
media/src/api/api.static.js
View File

@ -67,7 +67,7 @@ DataTable.fnIsDataTable = function ( nTable )
/** /**
* Get all DataTable tables that have been initialised - optionally you can select to * Get all DataTable tables that have been initialised - optionally you can select to
* get only currently visible tables. * get only currently visible tables.
* @param {boolean} [bVisible=false] Flag to indicate if you want all (default) or * @param {boolean} [bVisible=false] Flag to indicate if you want all (default) or
* visible tables only. * visible tables only.
* @returns {array} Array of TABLE nodes (not DataTable instances) which are DataTables * @returns {array} Array of TABLE nodes (not DataTable instances) which are DataTables
* @static * @static

4
media/src/core/core.columns.js
View File

@ -139,7 +139,7 @@ function _fnColumnOptions( oSettings, iCol, oOptions )
/** /**
* Adjust the table column widths for new data. Note: you would probably want to * Adjust the table column widths for new data. Note: you would probably want to
* do a redraw after calling this function! * do a redraw after calling this function!
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @memberof DataTable#oApi * @memberof DataTable#oApi
@ -210,7 +210,7 @@ function _fnVisbleColumns( oSettings )
/** /**
* Get an array of column indexes that match a given property * Get an array of column indexes that match a given property
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @param {string} sParam Parameter in aoColumns to look for - typically * @param {string} sParam Parameter in aoColumns to look for - typically
* bVisible or bSearchable * bVisible or bSearchable
* @returns {array} Array of indexes with matched properties * @returns {array} Array of indexes with matched properties
* @memberof DataTable#oApi * @memberof DataTable#oApi

2
media/src/core/core.compat.js
View File

@ -4,7 +4,7 @@
* Create a mapping object that allows camel case parameters to be looked up * Create a mapping object that allows camel case parameters to be looked up
* for their Hungarian counterparts. The mapping is stored in a private * for their Hungarian counterparts. The mapping is stored in a private
* parameter called `_hungaianMap` which can be accessed on the source object. * parameter called `_hungaianMap` which can be accessed on the source object.
* @param {object} o * @param {object} o
* @memberof DataTable#oApi * @memberof DataTable#oApi
*/ */
function _fnHungarianMap ( o ) function _fnHungarianMap ( o )

6
media/src/core/core.constructor.js
View File

@ -171,8 +171,8 @@ else if ( oSettings.oFeatures.bDeferRender )
if ( oInit.bJQueryUI ) if ( oInit.bJQueryUI )
{ {
/* Use the JUI classes object for display. You could clone the oStdClasses object if /* Use the JUI classes object for display. You could clone the oStdClasses object if
* you want to have multiple tables with multiple independent classes * you want to have multiple tables with multiple independent classes
*/ */
$.extend( oSettings.oClasses, DataTable.ext.oJUIClasses ); $.extend( oSettings.oClasses, DataTable.ext.oJUIClasses );
@ -226,7 +226,7 @@ if ( oInit.aaData !== null )
if ( oInit.oLanguage.sUrl !== "" ) if ( oInit.oLanguage.sUrl !== "" )
{ {
/* Get the language definitions from a file - because this Ajax call makes the language /* Get the language definitions from a file - because this Ajax call makes the language
* get async to the remainder of this function we use bInitHandedOff to indicate that * get async to the remainder of this function we use bInitHandedOff to indicate that
* _fnInitialise will be fired by the returned Ajax handler, rather than the constructor * _fnInitialise will be fired by the returned Ajax handler, rather than the constructor
*/ */
oSettings.oLanguage.sUrl = oInit.oLanguage.sUrl; oSettings.oLanguage.sUrl = oInit.oLanguage.sUrl;

4
media/src/core/core.data.js
View File

@ -1,5 +1,5 @@
/** /**
* Add a data array to the table, creating DOM node etc. This is the parallel to * Add a data array to the table, creating DOM node etc. This is the parallel to
* _fnGatherData, but for adding rows from a Javascript source, rather than a * _fnGatherData, but for adding rows from a Javascript source, rather than a
* DOM source. * DOM source.
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
@ -478,7 +478,7 @@ function _fnClearTable( oSettings )
/** /**
* Take an array of integers (index array) and remove a target integer (value - not * Take an array of integers (index array) and remove a target integer (value - not
* the key!) * the key!)
* @param {array} a Index array to target * @param {array} a Index array to target
* @param {int} iTarget value to find * @param {int} iTarget value to find

24
media/src/core/core.draw.js
View File

@ -141,7 +141,7 @@ function _fnBuildHead( oSettings )
_fnDetectHeader( oSettings.aoHeader, oSettings.nTHead ); _fnDetectHeader( oSettings.aoHeader, oSettings.nTHead );
} }
/* ARIA role for the rows */ /* ARIA role for the rows */
$(oSettings.nTHead).children('tr').attr('role', 'row'); $(oSettings.nTHead).children('tr').attr('role', 'row');
/* Add the extra markup needed by jQuery UI's themes */ /* Add the extra markup needed by jQuery UI's themes */
@ -206,13 +206,13 @@ function _fnBuildHead( oSettings )
* Draw the header (or footer) element based on the column visibility states. The * Draw the header (or footer) element based on the column visibility states. The
* methodology here is to use the layout array from _fnDetectHeader, modified for * methodology here is to use the layout array from _fnDetectHeader, modified for
* the instantaneous column visibility, to construct the new layout. The grid is * the instantaneous column visibility, to construct the new layout. The grid is
* traversed over cell at a time in a rows x columns grid fashion, although each * traversed over cell at a time in a rows x columns grid fashion, although each
* cell insert can cover multiple elements in the grid - which is tracks using the * cell insert can cover multiple elements in the grid - which is tracks using the
* aApplied array. Cell inserts in the grid will only occur where there isn't * aApplied array. Cell inserts in the grid will only occur where there isn't
* already a cell in that position. * already a cell in that position.
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @param array {objects} aoSource Layout array from _fnDetectHeader * @param array {objects} aoSource Layout array from _fnDetectHeader
* @param {boolean} [bIncludeHidden=false] If true then include the hidden columns in the calc, * @param {boolean} [bIncludeHidden=false] If true then include the hidden columns in the calc,
* @memberof DataTable#oApi * @memberof DataTable#oApi
*/ */
function _fnDrawHead( oSettings, aoSource, bIncludeHidden ) function _fnDrawHead( oSettings, aoSource, bIncludeHidden )
@ -389,7 +389,7 @@ function _fnDraw( oSettings )
} }
/* Row callback functions - might want to manipulate the row */ /* Row callback functions - might want to manipulate the row */
_fnCallbackFire( oSettings, 'aoRowCallback', null, _fnCallbackFire( oSettings, 'aoRowCallback', null,
[nRow, oSettings.aoData[ oSettings.aiDisplay[j] ]._aData, iRowCount, j] ); [nRow, oSettings.aoData[ oSettings.aiDisplay[j] ]._aData, iRowCount, j] );
anRows.push( nRow ); anRows.push( nRow );
@ -437,15 +437,15 @@ function _fnDraw( oSettings )
} }
/* Header and footer callbacks */ /* Header and footer callbacks */
_fnCallbackFire( oSettings, 'aoHeaderCallback', 'header', [ $(oSettings.nTHead).children('tr')[0], _fnCallbackFire( oSettings, 'aoHeaderCallback', 'header', [ $(oSettings.nTHead).children('tr')[0],
_fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] ); _fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] );
_fnCallbackFire( oSettings, 'aoFooterCallback', 'footer', [ $(oSettings.nTFoot).children('tr')[0], _fnCallbackFire( oSettings, 'aoFooterCallback', 'footer', [ $(oSettings.nTFoot).children('tr')[0],
_fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] ); _fnGetDataMaster( oSettings ), oSettings._iDisplayStart, oSettings.fnDisplayEnd(), oSettings.aiDisplay ] );
/* /*
* Need to remove any old row from the display - note we can't just empty the tbody using * Need to remove any old row from the display - note we can't just empty the tbody using
* $().html('') since this will unbind the jQuery event handlers (even although the node * $().html('') since this will unbind the jQuery event handlers (even although the node
* still exists!) - equally we can't use innerHTML, since IE throws an exception. * still exists!) - equally we can't use innerHTML, since IE throws an exception.
*/ */
var var
@ -462,7 +462,7 @@ function _fnDraw( oSettings )
* up. When not infinite scroll, always do it. * up. When not infinite scroll, always do it.
*/ */
if ( !oSettings.oScroll.bInfinite || !oSettings._bInitComplete || if ( !oSettings.oScroll.bInfinite || !oSettings._bInitComplete ||
oSettings.bSorted || oSettings.bFiltered ) oSettings.bSorted || oSettings.bFiltered )
{ {
while( (n = oSettings.nTBody.firstChild) ) while( (n = oSettings.nTBody.firstChild) )
{ {
@ -541,7 +541,7 @@ function _fnAddOptionsHtml ( oSettings )
var nHolding = $('<div></div>')[0]; var nHolding = $('<div></div>')[0];
oSettings.nTable.parentNode.insertBefore( nHolding, oSettings.nTable ); oSettings.nTable.parentNode.insertBefore( nHolding, oSettings.nTable );
/* /*
* All DataTables are wrapped in a div * All DataTables are wrapped in a div
*/ */
oSettings.nTableWrapper = $('<div id="'+oSettings.sTableId+'_wrapper" class="'+oSettings.oClasses.sWrapper+'" role="grid"></div>')[0]; oSettings.nTableWrapper = $('<div id="'+oSettings.sTableId+'_wrapper" class="'+oSettings.oClasses.sWrapper+'" role="grid"></div>')[0];
@ -734,7 +734,7 @@ function _fnDetectHeader ( aLayout, nThead )
iColspan = (!iColspan || iColspan===0 || iColspan===1) ? 1 : iColspan; iColspan = (!iColspan || iColspan===0 || iColspan===1) ? 1 : iColspan;
iRowspan = (!iRowspan || iRowspan===0 || iRowspan===1) ? 1 : iRowspan; iRowspan = (!iRowspan || iRowspan===0 || iRowspan===1) ? 1 : iRowspan;
/* There might be colspan cells already in this row, so shift our target /* There might be colspan cells already in this row, so shift our target
* accordingly * accordingly
*/ */
iColShifted = fnShiftCol( aLayout, i, iColumn ); iColShifted = fnShiftCol( aLayout, i, iColumn );
@ -786,7 +786,7 @@ function _fnGetUniqueThs ( oSettings, nHeader, aLayout )
{ {
for ( var j=0, jLen=aLayout[i].length ; j<jLen ; j++ ) for ( var j=0, jLen=aLayout[i].length ; j<jLen ; j++ )
{ {
if ( aLayout[i][j].unique && if ( aLayout[i][j].unique &&
(!aReturn[j] || !oSettings.bSortCellsTop) ) (!aReturn[j] || !oSettings.bSortCellsTop) )
{ {
aReturn[j] = aLayout[i][j].cell; aReturn[j] = aLayout[i][j].cell;

46
media/src/core/core.filter.js
View File

@ -45,11 +45,11 @@ function _fnFeatureHtmlFilter ( oSettings )
/* Now do the filter */ /* Now do the filter */
if ( val != oPreviousSearch.sSearch ) if ( val != oPreviousSearch.sSearch )
{ {
_fnFilterComplete( oSettings, { _fnFilterComplete( oSettings, {
"sSearch": val, "sSearch": val,
"bRegex": oPreviousSearch.bRegex, "bRegex": oPreviousSearch.bRegex,
"bSmart": oPreviousSearch.bSmart , "bSmart": oPreviousSearch.bSmart ,
"bCaseInsensitive": oPreviousSearch.bCaseInsensitive "bCaseInsensitive": oPreviousSearch.bCaseInsensitive
} ); } );
} }
} ); } );
@ -98,7 +98,7 @@ function _fnFilterComplete ( oSettings, oInput, iForce )
/* Now do the individual column filter */ /* Now do the individual column filter */
for ( var i=0 ; i<oSettings.aoPreSearchCols.length ; i++ ) for ( var i=0 ; i<oSettings.aoPreSearchCols.length ; i++ )
{ {
_fnFilterColumn( oSettings, aoPrevSearch[i].sSearch, i, aoPrevSearch[i].bRegex, _fnFilterColumn( oSettings, aoPrevSearch[i].sSearch, i, aoPrevSearch[i].bRegex,
aoPrevSearch[i].bSmart, aoPrevSearch[i].bCaseInsensitive ); aoPrevSearch[i].bSmart, aoPrevSearch[i].bCaseInsensitive );
} }
@ -229,9 +229,9 @@ function _fnFilter( oSettings, sInput, iForce, bRegex, bSmart, bCaseInsensitive
else else
{ {
/* /*
* We are starting a new search or the new search string is smaller * We are starting a new search or the new search string is smaller
* then the old one (i.e. delete). Search from the master array * then the old one (i.e. delete). Search from the master array
*/ */
if ( oSettings.aiDisplay.length == oSettings.aiDisplayMaster.length || if ( oSettings.aiDisplay.length == oSettings.aiDisplayMaster.length ||
oPrevSearch.sSearch.length > sInput.length || iForce == 1 || oPrevSearch.sSearch.length > sInput.length || iForce == 1 ||
sInput.indexOf(oPrevSearch.sSearch) !== 0 ) sInput.indexOf(oPrevSearch.sSearch) !== 0 )
@ -243,7 +243,7 @@ function _fnFilter( oSettings, sInput, iForce, bRegex, bSmart, bCaseInsensitive
_fnBuildSearchArray( oSettings, 1 ); _fnBuildSearchArray( oSettings, 1 );
/* Search through all records to populate the search array /* Search through all records to populate the search array
* The the oSettings.aiDisplayMaster and asDataSearch arrays have 1 to 1 * The the oSettings.aiDisplayMaster and asDataSearch arrays have 1 to 1
* mapping * mapping
*/ */
for ( i=0 ; i<oSettings.aiDisplayMaster.length ; i++ ) for ( i=0 ; i<oSettings.aiDisplayMaster.length ; i++ )
@ -253,24 +253,24 @@ function _fnFilter( oSettings, sInput, iForce, bRegex, bSmart, bCaseInsensitive
oSettings.aiDisplay.push( oSettings.aiDisplayMaster[i] ); oSettings.aiDisplay.push( oSettings.aiDisplayMaster[i] );
} }
} }
} }
else else
{ {
/* Using old search array - refine it - do it this way for speed /* Using old search array - refine it - do it this way for speed
* Don't have to search the whole master array again * Don't have to search the whole master array again
*/ */
var iIndexCorrector = 0; var iIndexCorrector = 0;
/* Search the current results */ /* Search the current results */
for ( i=0 ; i<oSettings.asDataSearch.length ; i++ ) for ( i=0 ; i<oSettings.asDataSearch.length ; i++ )
{ {
if ( ! rpSearch.test(oSettings.asDataSearch[i]) ) if ( ! rpSearch.test(oSettings.asDataSearch[i]) )
{ {
oSettings.aiDisplay.splice( i-iIndexCorrector, 1 ); oSettings.aiDisplay.splice( i-iIndexCorrector, 1 );
iIndexCorrector++; iIndexCorrector++;
} }
} }
} }
} }
} }
@ -290,8 +290,8 @@ function _fnBuildSearchArray ( oSettings, iMaster )
var aiFilterColumns = _fnGetColumns( oSettings, 'bSearchable' ); var aiFilterColumns = _fnGetColumns( oSettings, 'bSearchable' );
var aiIndex = (iMaster===1) ? var aiIndex = (iMaster===1) ?
oSettings.aiDisplayMaster : oSettings.aiDisplayMaster :
oSettings.aiDisplay; oSettings.aiDisplay;
for ( var i=0, iLen=aiIndex.length ; i<iLen ; i++ ) for ( var i=0, iLen=aiIndex.length ; i<iLen ; i++ )
{ {

2
media/src/core/core.info.js
View File

@ -70,7 +70,7 @@ function _fnUpdateInfo ( oSettings )
if ( oLang.fnInfoCallback !== null ) if ( oLang.fnInfoCallback !== null )
{ {
sOut = oLang.fnInfoCallback.call( oSettings.oInstance, sOut = oLang.fnInfoCallback.call( oSettings.oInstance,
oSettings, iStart, iEnd, iMax, iTotal, sOut ); oSettings, iStart, iEnd, iMax, iTotal, sOut );
} }

2
media/src/core/core.length.js
View File

@ -19,7 +19,7 @@ function _fnFeatureHtmlLength ( oSettings )
var i, iLen; var i, iLen;
var aLengthMenu = oSettings.aLengthMenu; var aLengthMenu = oSettings.aLengthMenu;
if ( aLengthMenu.length == 2 && typeof aLengthMenu[0] === 'object' && if ( aLengthMenu.length == 2 && typeof aLengthMenu[0] === 'object' &&
typeof aLengthMenu[1] === 'object' ) typeof aLengthMenu[1] === 'object' )
{ {
for ( i=0, iLen=aLengthMenu[0].length ; i<iLen ; i++ ) for ( i=0, iLen=aLengthMenu[0].length ; i<iLen ; i++ )

4
media/src/core/core.page.js
View File

@ -1,7 +1,7 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Note that most of the paging logic is done in * Note that most of the paging logic is done in
* DataTable.ext.oPagination * DataTable.ext.oPagination
*/ */
@ -21,7 +21,7 @@ function _fnFeatureHtmlPaginate ( oSettings )
var nPaginate = document.createElement( 'div' ); var nPaginate = document.createElement( 'div' );
nPaginate.className = oSettings.oClasses.sPaging+oSettings.sPaginationType; nPaginate.className = oSettings.oClasses.sPaging+oSettings.sPaginationType;
DataTable.ext.oPagination[ oSettings.sPaginationType ].fnInit( oSettings, nPaginate, DataTable.ext.oPagination[ oSettings.sPaginationType ].fnInit( oSettings, nPaginate,
function( oSettings ) { function( oSettings ) {
_fnCalculateEnd( oSettings ); _fnCalculateEnd( oSettings );
_fnDraw( oSettings ); _fnDraw( oSettings );

22
media/src/core/core.scrolling.js
View File

@ -38,7 +38,7 @@ function _fnFeatureHtmlTable ( oSettings )
nScrollHeadTable = oSettings.nTable.cloneNode(false), nScrollHeadTable = oSettings.nTable.cloneNode(false),
nScrollFootTable = oSettings.nTable.cloneNode(false), nScrollFootTable = oSettings.nTable.cloneNode(false),
nThead = oSettings.nTable.getElementsByTagName('thead')[0], nThead = oSettings.nTable.getElementsByTagName('thead')[0],
nTfoot = oSettings.nTable.getElementsByTagName('tfoot').length === 0 ? null : nTfoot = oSettings.nTable.getElementsByTagName('tfoot').length === 0 ? null :
oSettings.nTable.getElementsByTagName('tfoot')[0], oSettings.nTable.getElementsByTagName('tfoot')[0],
oClasses = oSettings.oClasses; oClasses = oSettings.oClasses;
@ -148,7 +148,7 @@ function _fnFeatureHtmlTable ( oSettings )
if ( !oSettings.bDrawing && $(this).scrollTop() !== 0 ) if ( !oSettings.bDrawing && $(this).scrollTop() !== 0 )
{ {
/* Check if we should load the next data set */ /* Check if we should load the next data set */
if ( $(this).scrollTop() + $(this).height() > if ( $(this).scrollTop() + $(this).height() >
$(oSettings.nTable).height() - oSettings.oScroll.iLoadGap ) $(oSettings.nTable).height() - oSettings.oScroll.iLoadGap )
{ {
/* Only do the redraw if we have to - we might be at the end of the data */ /* Only do the redraw if we have to - we might be at the end of the data */
@ -270,7 +270,7 @@ function _fnScrollDraw ( o )
* the scrollbar - which is shouldn't. When there is a scrollbar we need to take this * the scrollbar - which is shouldn't. When there is a scrollbar we need to take this
* into account. * into account.
*/ */
if ( ie67 && ($('tbody', nScrollBody).height() > nScrollBody.offsetHeight || if ( ie67 && ($('tbody', nScrollBody).height() > nScrollBody.offsetHeight ||
$(nScrollBody).css('overflow-y') == "scroll") ) $(nScrollBody).css('overflow-y') == "scroll") )
{ {
o.nTable.style.width = _fnStringToCss( $(o.nTable).outerWidth() - o.oScroll.iBarWidth); o.nTable.style.width = _fnStringToCss( $(o.nTable).outerWidth() - o.oScroll.iBarWidth);
@ -311,16 +311,16 @@ function _fnScrollDraw ( o )
* set the width based on the real headers * set the width based on the real headers
*/ */
// Apply all styles in one pass. Invalidates layout only once because we don't read any // Apply all styles in one pass. Invalidates layout only once because we don't read any
// DOM properties. // DOM properties.
_fnApplyToChildren( zeroOut, anHeadSizers ); _fnApplyToChildren( zeroOut, anHeadSizers );
// Read all widths in next pass. Forces layout only once because we do not change // Read all widths in next pass. Forces layout only once because we do not change
// any DOM properties. // any DOM properties.
_fnApplyToChildren( function(nSizer) { _fnApplyToChildren( function(nSizer) {
aApplied.push( _fnStringToCss( $(nSizer).width() ) ); aApplied.push( _fnStringToCss( $(nSizer).width() ) );
}, anHeadSizers ); }, anHeadSizers );
// Apply all widths in final pass. Invalidates layout only once because we do not // Apply all widths in final pass. Invalidates layout only once because we do not
// read any DOM properties. // read any DOM properties.
_fnApplyToChildren( function(nToSize, i) { _fnApplyToChildren( function(nToSize, i) {
@ -333,11 +333,11 @@ function _fnScrollDraw ( o )
if ( o.nTFoot !== null ) if ( o.nTFoot !== null )
{ {
_fnApplyToChildren( zeroOut, anFootSizers ); _fnApplyToChildren( zeroOut, anFootSizers );
_fnApplyToChildren( function(nSizer) { _fnApplyToChildren( function(nSizer) {
aAppliedFooter.push( _fnStringToCss( $(nSizer).width() ) ); aAppliedFooter.push( _fnStringToCss( $(nSizer).width() ) );
}, anFootSizers ); }, anFootSizers );
_fnApplyToChildren( function(nToSize, i) { _fnApplyToChildren( function(nToSize, i) {
nToSize.style.width = aAppliedFooter[i]; nToSize.style.width = aAppliedFooter[i];
}, anFootToSize ); }, anFootToSize );
@ -371,12 +371,12 @@ function _fnScrollDraw ( o )
if ( $(o.nTable).outerWidth() < iSanityWidth ) if ( $(o.nTable).outerWidth() < iSanityWidth )
{ {
/* The min width depends upon if we have a vertical scrollbar visible or not */ /* The min width depends upon if we have a vertical scrollbar visible or not */
var iCorrection = ((nScrollBody.scrollHeight > nScrollBody.offsetHeight || var iCorrection = ((nScrollBody.scrollHeight > nScrollBody.offsetHeight ||
$(nScrollBody).css('overflow-y') == "scroll")) ? $(nScrollBody).css('overflow-y') == "scroll")) ?
iSanityWidth+o.oScroll.iBarWidth : iSanityWidth; iSanityWidth+o.oScroll.iBarWidth : iSanityWidth;
/* IE6/7 are a law unto themselves... */ /* IE6/7 are a law unto themselves... */
if ( ie67 && (nScrollBody.scrollHeight > if ( ie67 && (nScrollBody.scrollHeight >
nScrollBody.offsetHeight || $(nScrollBody).css('overflow-y') == "scroll") ) nScrollBody.offsetHeight || $(nScrollBody).css('overflow-y') == "scroll") )
{ {
o.nTable.style.width = _fnStringToCss( iCorrection-o.oScroll.iBarWidth ); o.nTable.style.width = _fnStringToCss( iCorrection-o.oScroll.iBarWidth );

12
media/src/core/core.sizing.js
View File

@ -55,7 +55,7 @@ function _fnCalculateColumnWidths ( oSettings )
if ( oSettings.aoColumns[i].sWidth !== null ) if ( oSettings.aoColumns[i].sWidth !== null )
{ {
iTmpWidth = _fnConvertToWidth( oSettings.aoColumns[i].sWidthOrig, iTmpWidth = _fnConvertToWidth( oSettings.aoColumns[i].sWidthOrig,
nWrapper ); nWrapper );
if ( iTmpWidth !== null ) if ( iTmpWidth !== null )
{ {
@ -67,8 +67,8 @@ function _fnCalculateColumnWidths ( oSettings )
} }
} }
/* If the number of columns in the DOM equals the number that we have to process in /* If the number of columns in the DOM equals the number that we have to process in
* DataTables, then we can use the offsets that are created by the web-browser. No custom * DataTables, then we can use the offsets that are created by the web-browser. No custom
* sizes can be set in order for this to happen, nor scrolling used * sizes can be set in order for this to happen, nor scrolling used
*/ */
if ( iColums == oHeaders.length && iUserInputs === 0 && iVisibleColumns == iColums && if ( iColums == oHeaders.length && iUserInputs === 0 && iVisibleColumns == iColums &&
@ -197,7 +197,7 @@ function _fnCalculateColumnWidths ( oSettings )
oNodes = _fnGetUniqueThs( oSettings, $('thead', nCalcTmp)[0] ); oNodes = _fnGetUniqueThs( oSettings, $('thead', nCalcTmp)[0] );
} }
/* Browsers need a bit of a hand when a width is assigned to any columns when /* Browsers need a bit of a hand when a width is assigned to any columns when
* x-scrolling as they tend to collapse the table to the min-width, even if * x-scrolling as they tend to collapse the table to the min-width, even if
* we sent the column widths. So we need to keep track of what the table width * we sent the column widths. So we need to keep track of what the table width
* should be by summing the user given values, and the automatic values * should be by summing the user given values, and the automatic values
@ -369,7 +369,7 @@ function _fnStringToCss( s )
* @memberof DataTable#oApi * @memberof DataTable#oApi
*/ */
function _fnScrollBarWidth () function _fnScrollBarWidth ()
{ {
var inner = document.createElement('p'); var inner = document.createElement('p');
var style = inner.style; var style = inner.style;
style.width = "100%"; style.width = "100%";
@ -398,6 +398,6 @@ function _fnScrollBarWidth ()
} }
document.body.removeChild(outer); document.body.removeChild(outer);
return (w1 - w2); return (w1 - w2);
} }

44
media/src/core/core.sort.js
View File

@ -11,7 +11,7 @@ function _fnSort ( oSettings, bApplyClasses )
i, iLen, j, jLen, k, kLen, i, iLen, j, jLen, k, kLen,
sDataType, nTh, sDataType, nTh,
aSort = [], aSort = [],
aiOrig = [], aiOrig = [],
oExtSort = DataTable.ext.oSort, oExtSort = DataTable.ext.oSort,
aoData = oSettings.aoData, aoData = oSettings.aoData,
aoColumns = oSettings.aoColumns, aoColumns = oSettings.aoColumns,
@ -65,7 +65,7 @@ function _fnSort ( oSettings, bApplyClasses )
sDataType = oSettings.aoColumns[ iColumn ].sSortDataType; sDataType = oSettings.aoColumns[ iColumn ].sSortDataType;
if ( DataTable.ext.afnSortData[sDataType] ) if ( DataTable.ext.afnSortData[sDataType] )
{ {
var aData = DataTable.ext.afnSortData[sDataType].call( var aData = DataTable.ext.afnSortData[sDataType].call(
oSettings.oInstance, oSettings, iColumn, iVisColumn oSettings.oInstance, oSettings, iColumn, iVisColumn
); );
if ( aData.length === aoData.length ) if ( aData.length === aoData.length )
@ -113,17 +113,17 @@ function _fnSort ( oSettings, bApplyClasses )
* and sorting function (from oSort) in a certain direction. It's reasonably complex to * and sorting function (from oSort) in a certain direction. It's reasonably complex to
* follow on it's own, but this is what we want (example two column sorting): * follow on it's own, but this is what we want (example two column sorting):
* fnLocalSorting = function(a,b){ * fnLocalSorting = function(a,b){
* var iTest; * var iTest;
* iTest = oSort['string-asc']('data11', 'data12'); * iTest = oSort['string-asc']('data11', 'data12');
* if (iTest !== 0) * if (iTest !== 0)
* return iTest; * return iTest;
* iTest = oSort['numeric-desc']('data21', 'data22'); * iTest = oSort['numeric-desc']('data21', 'data22');
* if (iTest !== 0) * if (iTest !== 0)
* return iTest; * return iTest;
* return oSort['numeric-asc']( aiOrig[a], aiOrig[b] ); * return oSort['numeric-asc']( aiOrig[a], aiOrig[b] );
* } * }
* Basically we have a test for each sorting column, if the data in that column is equal, * Basically we have a test for each sorting column, if the data in that column is equal,
* test the next column. If all columns match, then we use a numeric sort on the row * test the next column. If all columns match, then we use a numeric sort on the row
* positions in the original data array to provide a stable sort. * positions in the original data array to provide a stable sort.
* *
* Note - I know it seems excessive to have two sorting methods, but the first is around * Note - I know it seems excessive to have two sorting methods, but the first is around
@ -210,7 +210,7 @@ function _fnSort ( oSettings, bApplyClasses )
{ {
nTh.setAttribute('aria-sort', aSort[0].dir=="asc" ? "ascending" : "descending" ); nTh.setAttribute('aria-sort', aSort[0].dir=="asc" ? "ascending" : "descending" );
var nextSort = (aoColumns[i].asSorting[ aSort[0].index+1 ]) ? var nextSort = (aoColumns[i].asSorting[ aSort[0].index+1 ]) ?
aoColumns[i].asSorting[ aSort[0].index+1 ] : aoColumns[i].asSorting[0]; aoColumns[i].asSorting[ aSort[0].index+1 ] : aoColumns[i].asSorting[0];
nTh.setAttribute('aria-label', sTitle+ nTh.setAttribute('aria-label', sTitle+
(nextSort=="asc" ? oAria.sSortAscending : oAria.sSortDescending) ); (nextSort=="asc" ? oAria.sSortAscending : oAria.sSortDescending) );
@ -266,14 +266,14 @@ function _fnSortAttachListener ( oSettings, nNode, iDataIndex, fnCallback )
/* /*
* This is a little bit odd I admit... I declare a temporary function inside the scope of * This is a little bit odd I admit... I declare a temporary function inside the scope of
* _fnBuildHead and the click handler in order that the code presented here can be used * _fnBuildHead and the click handler in order that the code presented here can be used
* twice - once for when bProcessing is enabled, and another time for when it is * twice - once for when bProcessing is enabled, and another time for when it is
* disabled, as we need to perform slightly different actions. * disabled, as we need to perform slightly different actions.
* Basically the issue here is that the Javascript engine in modern browsers don't * Basically the issue here is that the Javascript engine in modern browsers don't
* appear to allow the rendering engine to update the display while it is still executing * appear to allow the rendering engine to update the display while it is still executing
* it's thread (well - it does but only after long intervals). This means that the * it's thread (well - it does but only after long intervals). This means that the
* 'processing' display doesn't appear for a table sort. To break the js thread up a bit * 'processing' display doesn't appear for a table sort. To break the js thread up a bit
* I force an execution break by using setTimeout - but this breaks the expected * I force an execution break by using setTimeout - but this breaks the expected
* thread continuation for the end-developer's point of view (their code would execute * thread continuation for the end-developer's point of view (their code would execute
* too early), so we only do it when we absolutely have to. * too early), so we only do it when we absolutely have to.
*/ */
@ -311,7 +311,7 @@ function _fnSortAttachListener ( oSettings, nNode, iDataIndex, fnCallback )
/* No sort yet - add it in */ /* No sort yet - add it in */
if ( bFound === false ) if ( bFound === false )
{ {
oSettings.aaSorting.push( [ iDataIndex, oSettings.aaSorting.push( [ iDataIndex,
oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] ); oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] );
} }
} }
@ -332,7 +332,7 @@ function _fnSortAttachListener ( oSettings, nNode, iDataIndex, fnCallback )
else else
{ {
oSettings.aaSorting.splice( 0, oSettings.aaSorting.length ); oSettings.aaSorting.splice( 0, oSettings.aaSorting.length );
oSettings.aaSorting.push( [ iDataIndex, oSettings.aaSorting.push( [ iDataIndex,
oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] ); oSettings.aoColumns[iDataIndex].asSorting[0], 0 ] );
} }
} }
@ -367,7 +367,7 @@ function _fnSortAttachListener ( oSettings, nNode, iDataIndex, fnCallback )
/** /**
* Set the sorting classes on the header, Note: it is safe to call this function * Set the sorting classes on the header, Note: it is safe to call this function
* when bSort and bSortClasses are false * when bSort and bSortClasses are false
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @memberof DataTable#oApi * @memberof DataTable#oApi
@ -420,13 +420,13 @@ function _fnSortingClasses( oSettings )
{ {
/* jQuery UI uses extra markup */ /* jQuery UI uses extra markup */
var jqSpan = $("span."+oClasses.sSortIcon, oSettings.aoColumns[i].nTh); var jqSpan = $("span."+oClasses.sSortIcon, oSettings.aoColumns[i].nTh);
jqSpan.removeClass(oClasses.sSortJUIAsc +" "+ oClasses.sSortJUIDesc +" "+ jqSpan.removeClass(oClasses.sSortJUIAsc +" "+ oClasses.sSortJUIDesc +" "+
oClasses.sSortJUI +" "+ oClasses.sSortJUIAscAllowed +" "+ oClasses.sSortJUIDescAllowed ); oClasses.sSortJUI +" "+ oClasses.sSortJUIAscAllowed +" "+ oClasses.sSortJUIDescAllowed );
var sSpanClass; var sSpanClass;
if ( iFound == -1 ) if ( iFound == -1 )
{ {
sSpanClass = oSettings.aoColumns[i].sSortingClassJUI; sSpanClass = oSettings.aoColumns[i].sSortingClassJUI;
} }
else if ( aaSort[iFound][1] == "asc" ) else if ( aaSort[iFound][1] == "asc" )
{ {
@ -449,11 +449,11 @@ function _fnSortingClasses( oSettings )
} }
} }
/* /*
* Apply the required classes to the table body * Apply the required classes to the table body
* Note that this is given as a feature switch since it can significantly slow down a sort * Note that this is given as a feature switch since it can significantly slow down a sort
* on large data sets (adding and removing of classes is always slow at the best of times..) * on large data sets (adding and removing of classes is always slow at the best of times..)
* Further to this, note that this code is admittedly fairly ugly. It could be made a lot * Further to this, note that this code is admittedly fairly ugly. It could be made a lot
* simpler using jQuery selectors and add/removeClass, but that is significantly slower * simpler using jQuery selectors and add/removeClass, but that is significantly slower
* (on the order of 5 times slower) - hence the direct DOM manipulation here. * (on the order of 5 times slower) - hence the direct DOM manipulation here.
* Note that for deferred drawing we do use jQuery - the reason being that taking the first * Note that for deferred drawing we do use jQuery - the reason being that taking the first

2
media/src/core/core.support.js
View File

@ -43,7 +43,7 @@ function _fnGetTrNodes ( oSettings )
/** /**
* Return an flat array with all TD nodes for the table, or row * Return an flat array with all TD nodes for the table, or row
* @param {object} oSettings dataTables settings object * @param {object} oSettings dataTables settings object
* @param {int} [iIndividualRow] aoData index to get the nodes for - optional * @param {int} [iIndividualRow] aoData index to get the nodes for - optional
* if not given then the return array will contain all nodes for the table * if not given then the return array will contain all nodes for the table
* @returns {array} TD array * @returns {array} TD array
* @memberof DataTable#oApi * @memberof DataTable#oApi

8
media/src/ext/ext.paging.js
View File

@ -1,6 +1,6 @@
/* /*
* Variable: oPagination * Variable: oPagination
* Purpose: * Purpose:
* Scope: jQuery.fn.dataTableExt * Scope: jQuery.fn.dataTableExt
*/ */
$.extend( DataTable.ext.oPagination, { $.extend( DataTable.ext.oPagination, {
@ -83,7 +83,7 @@ $.extend( DataTable.ext.oPagination, {
/* Previous page */ /* Previous page */
nNode.className = ( oSettings._iDisplayStart === 0 ) ? nNode.className = ( oSettings._iDisplayStart === 0 ) ?
oClasses.sPagePrevDisabled : oClasses.sPagePrevEnabled; oClasses.sPagePrevDisabled : oClasses.sPagePrevEnabled;
/* Next page */ /* Next page */
nNode = nNode.nextSibling; nNode = nNode.nextSibling;
nNode.className = ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) ? nNode.className = ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) ?
@ -241,12 +241,12 @@ $.extend( DataTable.ext.oPagination, {
/* Update the permanent button's classes */ /* Update the permanent button's classes */
anButtons = nNode.getElementsByTagName('a'); anButtons = nNode.getElementsByTagName('a');
anStatic = [ anStatic = [
anButtons[0], anButtons[1], anButtons[0], anButtons[1],
anButtons[anButtons.length-2], anButtons[anButtons.length-1] anButtons[anButtons.length-2], anButtons[anButtons.length-1]
]; ];
$(anStatic).removeClass( oClasses.sPageButton+" "+oClasses.sPageButtonActive+" "+oClasses.sPageButtonStaticDisabled ); $(anStatic).removeClass( oClasses.sPageButton+" "+oClasses.sPageButtonActive+" "+oClasses.sPageButtonStaticDisabled );
$([anStatic[0], anStatic[1]]).addClass( $([anStatic[0], anStatic[1]]).addClass(
(iCurrentPage==1) ? (iCurrentPage==1) ?
oClasses.sPageButtonStaticDisabled : oClasses.sPageButtonStaticDisabled :
oClasses.sPageButton oClasses.sPageButton

2
media/src/ext/ext.sorting.js
View File

@ -15,7 +15,7 @@ $.extend( DataTable.ext.oSort, {
return a.toLowerCase(); return a.toLowerCase();
}, },
// string-asc and -desc are retained only for compatibility with // string-asc and -desc are retained only for compatibility with
"string-asc": function ( x, y ) "string-asc": function ( x, y )
{ {
return ((x < y) ? -1 : ((x > y) ? 1 : 0)); return ((x < y) ? -1 : ((x > y) ? 1 : 0));

22
media/src/model/model.column.js
View File

@ -5,8 +5,8 @@
* Template object for the column information object in DataTables. This object * Template object for the column information object in DataTables. This object
* is held in the settings aoColumns array and contains all the information that * is held in the settings aoColumns array and contains all the information that
* DataTables needs about each individual column. * DataTables needs about each individual column.
* *
* Note that this object is related to {@link DataTable.defaults.column} * Note that this object is related to {@link DataTable.defaults.column}
* but this one is the internal data store for DataTables's cache of columns. * but this one is the internal data store for DataTables's cache of columns.
* It should NOT be manipulated outside of DataTables. Any configuration should * It should NOT be manipulated outside of DataTables. Any configuration should
* be done through the initialisation options. * be done through the initialisation options.
@ -80,12 +80,12 @@ DataTable.models.oColumn = {
* Function to get data from a cell in a column. You should <b>never</b> * Function to get data from a cell in a column. You should <b>never</b>
* access data directly through _aData internally in DataTables - always use * access data directly through _aData internally in DataTables - always use
* the method attached to this property. It allows mData to function as * the method attached to this property. It allows mData to function as
* required. This function is automatically assigned by the column * required. This function is automatically assigned by the column
* initialisation method * initialisation method
* @type function * @type function
* @param {array|object} oData The data array/object for the array * @param {array|object} oData The data array/object for the array
* (i.e. aoData[]._aData) * (i.e. aoData[]._aData)
* @param {string} sSpecific The specific data type you want to get - * @param {string} sSpecific The specific data type you want to get -
* 'display', 'type' 'filter' 'sort' * 'display', 'type' 'filter' 'sort'
* @returns {*} The data for the cell from the given row's data * @returns {*} The data for the cell from the given row's data
* @default null * @default null
@ -93,12 +93,12 @@ DataTable.models.oColumn = {
"fnGetData": null, "fnGetData": null,
/** /**
* Function to set data for a cell in the column. You should <b>never</b> * Function to set data for a cell in the column. You should <b>never</b>
* set the data directly to _aData internally in DataTables - always use * set the data directly to _aData internally in DataTables - always use
* this method. It allows mData to function as required. This function * this method. It allows mData to function as required. This function
* is automatically assigned by the column initialisation method * is automatically assigned by the column initialisation method
* @type function * @type function
* @param {array|object} oData The data array/object for the array * @param {array|object} oData The data array/object for the array
* (i.e. aoData[]._aData) * (i.e. aoData[]._aData)
* @param {*} sValue Value to set * @param {*} sValue Value to set
* @default null * @default null
@ -106,7 +106,7 @@ DataTable.models.oColumn = {
"fnSetData": null, "fnSetData": null,
/** /**
* Property to read the value for the cells in the column from the data * Property to read the value for the cells in the column from the data
* source array / object. If null, then the default content is used, if a * source array / object. If null, then the default content is used, if a
* function is given then the return from the function is used. * function is given then the return from the function is used.
* @type function|int|string|null * @type function|int|string|null
@ -133,8 +133,8 @@ DataTable.models.oColumn = {
"nTh": null, "nTh": null,
/** /**
* Unique footer TH/TD element for this column (if there is one). Not used * Unique footer TH/TD element for this column (if there is one). Not used
* in DataTables as such, but can be used for plug-ins to reference the * in DataTables as such, but can be used for plug-ins to reference the
* footer for each column. * footer for each column.
* @type node * @type node
* @default null * @default null
@ -152,7 +152,7 @@ DataTable.models.oColumn = {
* When DataTables calculates the column widths to assign to each column, * When DataTables calculates the column widths to assign to each column,
* it finds the longest string in each column and then constructs a * it finds the longest string in each column and then constructs a
* temporary table and reads the widths from that. The problem with this * temporary table and reads the widths from that. The problem with this
* is that "mmm" is much wider then "iiii", but the latter is a longer * is that "mmm" is much wider then "iiii", but the latter is a longer
* string - thus the calculation can go wrong (doing it properly and putting * string - thus the calculation can go wrong (doing it properly and putting
* it into an DOM object and measuring that is horribly(!) slow). Thus as * it into an DOM object and measuring that is horribly(!) slow). Thus as
* a "work around" we provide this option. It will append its value to the * a "work around" we provide this option. It will append its value to the

118
media/src/model/model.defaults.columns.js
View File

@ -1,7 +1,7 @@
/* /*
* Developer note - See note in model.defaults.js about the use of Hungarian * Developer note - See note in model.defaults.js about the use of Hungarian
* notation and camel case. * notation and camel case.
*/ */
@ -11,15 +11,15 @@
*/ */
DataTable.defaults.column = { DataTable.defaults.column = {
/** /**
* Allows a column's sorting to take multiple columns into account when * Allows a column's sorting to take multiple columns into account when
* doing a sort. For example first name / last name columns make sense to * doing a sort. For example first name / last name columns make sense to
* do a multi-column sort over the two columns. * do a multi-column sort over the two columns.
* @type array * @type array
* @default null <i>Takes the value of the column index automatically</i> * @default null <i>Takes the value of the column index automatically</i>
* *
* @name DataTable.defaults.column.dataSort * @name DataTable.defaults.column.dataSort
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
@ -31,7 +31,7 @@ DataTable.defaults.column = {
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
@ -58,7 +58,7 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.sorting * @name DataTable.defaults.column.sorting
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
@ -70,7 +70,7 @@ DataTable.defaults.column = {
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
@ -95,21 +95,21 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.searchable * @name DataTable.defaults.column.searchable
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "searchable": false, "targets": [ 0 ] } * { "searchable": false, "targets": [ 0 ] }
* ] } ); * ] } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "searchable": false }, * { "searchable": false },
* null, * null,
* null, * null,
@ -128,21 +128,21 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.sortable * @name DataTable.defaults.column.sortable
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "sortable": false, "targets": [ 0 ] } * { "sortable": false, "targets": [ 0 ] }
* ] } ); * ] } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "sortable": false }, * { "sortable": false },
* null, * null,
* null, * null,
@ -161,21 +161,21 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.visible * @name DataTable.defaults.column.visible
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "visible": false, "targets": [ 0 ] } * { "visible": false, "targets": [ 0 ] }
* ] } ); * ] } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "visible": false }, * { "visible": false },
* null, * null,
* null, * null,
@ -201,7 +201,7 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.createdCell * @name DataTable.defaults.column.createdCell
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -228,22 +228,22 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.dataSort * @name DataTable.defaults.column.dataSort
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "dataSort": 1, "targets": [ 0 ] } * { "dataSort": 1, "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "dataSort": 1 }, * { "dataSort": 1 },
* null, * null,
* null, * null,
@ -445,7 +445,7 @@ DataTable.defaults.column = {
* but this parameter is much easier to use as there is no 'set' option. * but this parameter is much easier to use as there is no 'set' option.
* Like `data` this option can be given in a number of different ways to * Like `data` this option can be given in a number of different ways to
* effect its behaviour: * effect its behaviour:
* *
* * `integer` - treated as an array index for the data source. This is the * * `integer` - treated as an array index for the data source. This is the
* default that DataTables uses (incrementally increased for each column). * default that DataTables uses (incrementally increased for each column).
* * `string` - read an object property from the data source. There are * * `string` - read an object property from the data source. There are
@ -485,7 +485,7 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.render * @name DataTable.defaults.column.render
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Create a comma separated list from an array of objects * // Create a comma separated list from an array of objects
* $(document).ready( function() { * $(document).ready( function() {
@ -501,7 +501,7 @@ DataTable.defaults.column = {
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Execute a function to obtain data * // Execute a function to obtain data
* $(document).ready( function() { * $(document).ready( function() {
@ -513,7 +513,7 @@ DataTable.defaults.column = {
* } ] * } ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Use as a function to create a link from the data source * // Use as a function to create a link from the data source
* $(document).ready( function() { * $(document).ready( function() {
@ -540,7 +540,7 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.cellType * @name DataTable.defaults.column.cellType
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Make the first column use TH cells * // Make the first column use TH cells
* $(document).ready( function() { * $(document).ready( function() {
@ -562,22 +562,22 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.class * @name DataTable.defaults.column.class
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "class": "my_class", "targets": [ 0 ] } * { "class": "my_class", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "class": "my_class" }, * { "class": "my_class" },
* null, * null,
* null, * null,
@ -593,7 +593,7 @@ DataTable.defaults.column = {
* When DataTables calculates the column widths to assign to each column, * When DataTables calculates the column widths to assign to each column,
* it finds the longest string in each column and then constructs a * it finds the longest string in each column and then constructs a
* temporary table and reads the widths from that. The problem with this * temporary table and reads the widths from that. The problem with this
* is that "mmm" is much wider then "iiii", but the latter is a longer * is that "mmm" is much wider then "iiii", but the latter is a longer
* string - thus the calculation can go wrong (doing it properly and putting * string - thus the calculation can go wrong (doing it properly and putting
* it into an DOM object and measuring that is horribly(!) slow). Thus as * it into an DOM object and measuring that is horribly(!) slow). Thus as
* a "work around" we provide this option. It will append its value to the * a "work around" we provide this option. It will append its value to the
@ -604,12 +604,12 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.contentPadding * @name DataTable.defaults.column.contentPadding
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* null, * null,
* null, * null,
* null, * null,
@ -632,12 +632,12 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.defaultContent * @name DataTable.defaults.column.defaultContent
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { * {
* "data": null, * "data": null,
* "defaultContent": "Edit", * "defaultContent": "Edit",
@ -646,12 +646,12 @@ DataTable.defaults.column = {
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* null, * null,
* null, * null,
* null, * null,
@ -678,12 +678,12 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.name * @name DataTable.defaults.column.name
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "name": "engine", "targets": [ 0 ] }, * { "name": "engine", "targets": [ 0 ] },
* { "name": "browser", "targets": [ 1 ] }, * { "name": "browser", "targets": [ 1 ] },
* { "name": "platform", "targets": [ 2 ] }, * { "name": "platform", "targets": [ 2 ] },
@ -692,12 +692,12 @@ DataTable.defaults.column = {
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "name": "engine" }, * { "name": "engine" },
* { "name": "browser" }, * { "name": "browser" },
* { "name": "platform" }, * { "name": "platform" },
@ -720,7 +720,7 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.sortDataType * @name DataTable.defaults.column.sortDataType
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
@ -733,7 +733,7 @@ DataTable.defaults.column = {
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
@ -755,27 +755,27 @@ DataTable.defaults.column = {
/** /**
* The title of this column. * The title of this column.
* @type string * @type string
* @default null <i>Derived from the 'TH' value for this column in the * @default null <i>Derived from the 'TH' value for this column in the
* original HTML table.</i> * original HTML table.</i>
* *
* @name DataTable.defaults.column.title * @name DataTable.defaults.column.title
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "title": "My column title", "targets": [ 0 ] } * { "title": "My column title", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "title": "My column title" }, * { "title": "My column title" },
* null, * null,
* null, * null,
@ -801,22 +801,22 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.type * @name DataTable.defaults.column.type
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "type": "html", "targets": [ 0 ] } * { "type": "html", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "type": "html" }, * { "type": "html" },
* null, * null,
* null, * null,
@ -839,22 +839,22 @@ DataTable.defaults.column = {
* *
* @name DataTable.defaults.column.width * @name DataTable.defaults.column.width
* @dtopt Columns * @dtopt Columns
* *
* @example * @example
* // Using `columnDefs` * // Using `columnDefs`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columnDefs": [ * "columnDefs": [
* { "width": "20%", "targets": [ 0 ] } * { "width": "20%", "targets": [ 0 ] }
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using `columns` * // Using `columns`
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "columns": [ * "columns": [
* { "width": "20%" }, * { "width": "20%" },
* null, * null,
* null, * null,

268
media/src/model/model.defaults.js
View File

@ -16,13 +16,13 @@
*/ */
/** /**
* Initialisation options that can be given to DataTables at initialisation * Initialisation options that can be given to DataTables at initialisation
* time. * time.
* @namespace * @namespace
*/ */
DataTable.defaults = { DataTable.defaults = {
/** /**
* An array of data to use for the table, passed in at initialisation which * An array of data to use for the table, passed in at initialisation which
* will be used in preference to any data which is already in the DOM. This is * will be used in preference to any data which is already in the DOM. This is
* particularly useful for constructing tables purely in Javascript, for * particularly useful for constructing tables purely in Javascript, for
* example with a custom Ajax call. * example with a custom Ajax call.
@ -31,7 +31,7 @@ DataTable.defaults = {
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.data * @name DataTable.defaults.data
* *
* @example * @example
* // Using a 2D array data source * // Using a 2D array data source
* $(document).ready( function () { * $(document).ready( function () {
@ -49,7 +49,7 @@ DataTable.defaults = {
* ] * ]
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Using an array of objects as a data source (`data`) * // Using an array of objects as a data source (`data`)
* $(document).ready( function () { * $(document).ready( function () {
@ -84,17 +84,17 @@ DataTable.defaults = {
/** /**
* If sorting is enabled, then DataTables will perform a first pass sort on * If sorting is enabled, then DataTables will perform a first pass sort on
* initialisation. You can define which column(s) the sort is performed upon, * initialisation. You can define which column(s) the sort is performed upon,
* and the sorting direction, with this variable. The `sorting` array should * and the sorting direction, with this variable. The `sorting` array should
* contain an array for each column to be sorted initially containing the * contain an array for each column to be sorted initially containing the
* column's index and a direction string ('asc' or 'desc'). * column's index and a direction string ('asc' or 'desc').
* @type array * @type array
* @default [[0,'asc']] * @default [[0,'asc']]
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.sorting * @name DataTable.defaults.sorting
* *
* @example * @example
* // Sort by 3rd column first, and then 4th column * // Sort by 3rd column first, and then 4th column
* $(document).ready( function() { * $(document).ready( function() {
@ -102,7 +102,7 @@ DataTable.defaults = {
* "sorting": [[2,'asc'], [3,'desc']] * "sorting": [[2,'asc'], [3,'desc']]
* } ); * } );
* } ); * } );
* *
* // No initial sorting * // No initial sorting
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -114,18 +114,18 @@ DataTable.defaults = {
/** /**
* This parameter is basically identical to the `sorting` parameter, but * This parameter is basically identical to the `sorting` parameter, but
* cannot be overridden by user interaction with the table. What this means * cannot be overridden by user interaction with the table. What this means
* is that you could have a column (visible or hidden) which the sorting will * is that you could have a column (visible or hidden) which the sorting will
* always be forced on first - any sorting after that (from the user) will * always be forced on first - any sorting after that (from the user) will
* then be performed as required. This can be useful for grouping rows * then be performed as required. This can be useful for grouping rows
* together. * together.
* @type array * @type array
* @default null * @default null
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.sortingFixed * @name DataTable.defaults.sortingFixed
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -283,7 +283,7 @@ DataTable.defaults = {
* $('#example').dataTable( { * $('#example').dataTable( {
* "ajax": function (data, callback, settings) { * "ajax": function (data, callback, settings) {
* callback( * callback(
* JSON.parse( localStorage.getItem('dataTablesData') ) * JSON.parse( localStorage.getItem('dataTablesData') )
* ); * );
* } * }
* } ); * } );
@ -293,10 +293,10 @@ DataTable.defaults = {
/** /**
* This parameter allows you to readily specify the entries in the length drop * This parameter allows you to readily specify the entries in the length drop
* down menu that DataTables shows when pagination is enabled. It can be * down menu that DataTables shows when pagination is enabled. It can be
* either a 1D array of options which will be used for both the displayed * either a 1D array of options which will be used for both the displayed
* option and the value, or a 2D array which will use the array in the first * option and the value, or a 2D array which will use the array in the first
* position as the value, and the array in the second position as the * position as the value, and the array in the second position as the
* displayed options (useful for language strings such as 'All'). * displayed options (useful for language strings such as 'All').
* *
* Note that the `displayLength` property will be automatically set to the * Note that the `displayLength` property will be automatically set to the
@ -306,7 +306,7 @@ DataTable.defaults = {
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.lengthMenu * @name DataTable.defaults.lengthMenu
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -320,7 +320,7 @@ DataTable.defaults = {
/** /**
* The `columns` option in the initialisation parameter allows you to define * The `columns` option in the initialisation parameter allows you to define
* details about the way individual columns behave. For a full list of * details about the way individual columns behave. For a full list of
* column options that can be set, please see * column options that can be set, please see
* {@link DataTable.defaults.column}. Note that if you use `columns` to * {@link DataTable.defaults.column}. Note that if you use `columns` to
* define your columns, you must have an entry in the array for every single * define your columns, you must have an entry in the array for every single
* column that you have in your table (these can be null if you don't which * column that you have in your table (these can be null if you don't which
@ -332,11 +332,11 @@ DataTable.defaults = {
"aoColumns": null, "aoColumns": null,
/** /**
* Very similar to `columns`, `columnDefs` allows you to target a specific * Very similar to `columns`, `columnDefs` allows you to target a specific
* column, multiple columns, or all columns, using the `targets` property of * column, multiple columns, or all columns, using the `targets` property of
* each object in the array. This allows great flexibility when creating * each object in the array. This allows great flexibility when creating
* tables, as the `columnDefs` arrays can be of any length, targeting the * tables, as the `columnDefs` arrays can be of any length, targeting the
* columns you specifically want. `columnDefs` may use any of the column * columns you specifically want. `columnDefs` may use any of the column
* options available: {@link DataTable.defaults.column}, but it _must_ * options available: {@link DataTable.defaults.column}, but it _must_
* have `targets` defined in each object in the array. Values in the `targets` * have `targets` defined in each object in the array. Values in the `targets`
* array may be: * array may be:
@ -355,7 +355,7 @@ DataTable.defaults = {
/** /**
* Basically the same as `search`, this parameter defines the individual column * Basically the same as `search`, this parameter defines the individual column
* filtering state at initialisation time. The array must be of the same size * filtering state at initialisation time. The array must be of the same size
* as the number of columns, and each element be an object with the parameters * as the number of columns, and each element be an object with the parameters
* `search` and `escapeRegex` (the latter is optional). 'null' is also * `search` and `escapeRegex` (the latter is optional). 'null' is also
* accepted and the default will be used. * accepted and the default will be used.
@ -364,7 +364,7 @@ DataTable.defaults = {
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.searchCols * @name DataTable.defaults.searchCols
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -381,8 +381,8 @@ DataTable.defaults = {
/** /**
* An array of CSS classes that should be applied to displayed rows. This * An array of CSS classes that should be applied to displayed rows. This
* array may be of any length, and DataTables will apply each class * array may be of any length, and DataTables will apply each class
* sequentially, looping when required. * sequentially, looping when required.
* @type array * @type array
* @default null <i>Will take the values determined by the `oClasses.stripe*` * @default null <i>Will take the values determined by the `oClasses.stripe*`
@ -390,7 +390,7 @@ DataTable.defaults = {
* *
* @dtopt Option * @dtopt Option
* @name DataTable.defaults.stripeClasses * @name DataTable.defaults.stripeClasses
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -410,7 +410,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.autoWidth * @name DataTable.defaults.autoWidth
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -432,7 +432,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.deferRender * @name DataTable.defaults.deferRender
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -445,7 +445,7 @@ DataTable.defaults = {
/** /**
* Replace a DataTable which matches the given selector and replace it with * Replace a DataTable which matches the given selector and replace it with
* one which has the properties of the new initialisation object passed. If no * one which has the properties of the new initialisation object passed. If no
* table matches the selector, then the new DataTable will be constructed as * table matches the selector, then the new DataTable will be constructed as
* per normal. * per normal.
@ -454,14 +454,14 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.destroy * @name DataTable.defaults.destroy
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "srollY": "200px", * "srollY": "200px",
* "paginate": false * "paginate": false
* } ); * } );
* *
* // Some time later.... * // Some time later....
* $('#example').dataTable( { * $('#example').dataTable( {
* "filter": false, * "filter": false,
@ -485,7 +485,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.filter * @name DataTable.defaults.filter
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -497,7 +497,7 @@ DataTable.defaults = {
/** /**
* Enable or disable the table information display. This shows information * Enable or disable the table information display. This shows information
* about the data that is currently visible on the page, including information * about the data that is currently visible on the page, including information
* about filtered data if that action is being performed. * about filtered data if that action is being performed.
* @type boolean * @type boolean
@ -505,7 +505,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.info * @name DataTable.defaults.info
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -525,7 +525,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.jQueryUI * @name DataTable.defaults.jQueryUI
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -544,7 +544,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.lengthChange * @name DataTable.defaults.lengthChange
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -562,7 +562,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.paginate * @name DataTable.defaults.paginate
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -583,7 +583,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.processing * @name DataTable.defaults.processing
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -607,13 +607,13 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.retrieve * @name DataTable.defaults.retrieve
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* initTable(); * initTable();
* tableActions(); * tableActions();
* } ); * } );
* *
* function initTable () * function initTable ()
* { * {
* return $('#example').dataTable( { * return $('#example').dataTable( {
@ -622,11 +622,11 @@ DataTable.defaults = {
* "retrieve": true * "retrieve": true
* } ); * } );
* } * }
* *
* function tableActions () * function tableActions ()
* { * {
* var table = initTable(); * var table = initTable();
* // perform API operations with oTable * // perform API operations with oTable
* } * }
*/ */
"bRetrieve": false, "bRetrieve": false,
@ -641,7 +641,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollAutoCss * @name DataTable.defaults.scrollAutoCss
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -665,7 +665,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollCollapse * @name DataTable.defaults.scrollCollapse
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -689,7 +689,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.scrollInfinite * @name DataTable.defaults.scrollInfinite
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -712,7 +712,7 @@ DataTable.defaults = {
* @dtopt Features * @dtopt Features
* @dtopt Server-side * @dtopt Server-side
* @name DataTable.defaults.serverSide * @name DataTable.defaults.serverSide
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -732,7 +732,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.sort * @name DataTable.defaults.sort
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -752,7 +752,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.sortCellsTop * @name DataTable.defaults.sortCellsTop
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -774,7 +774,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.sortClasses * @name DataTable.defaults.sortClasses
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -786,11 +786,11 @@ DataTable.defaults = {
/** /**
* Enable or disable state saving. When enabled HTML5 `localStorage` will be * Enable or disable state saving. When enabled HTML5 `localStorage` will be
* used to save table display information such as pagination information, * used to save table display information such as pagination information,
* display length, filtering and sorting. As such when the end user reloads * display length, filtering and sorting. As such when the end user reloads
* the page the display display will match what thy had previously set up. * the page the display display will match what thy had previously set up.
* *
* Due to the use of `localStorage` the default state saving is not supported * Due to the use of `localStorage` the default state saving is not supported
* in IE6 or 7. If state saving is required in those browsers, use * in IE6 or 7. If state saving is required in those browsers, use
* `stateSaveCallback` to provide a storage solution such as cookies. * `stateSaveCallback` to provide a storage solution such as cookies.
@ -799,7 +799,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.stateSave * @name DataTable.defaults.stateSave
* *
* @example * @example
* $(document).ready( function () { * $(document).ready( function () {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -821,7 +821,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.createdRow * @name DataTable.defaults.createdRow
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -846,7 +846,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.drawCallback * @name DataTable.defaults.drawCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -865,16 +865,16 @@ DataTable.defaults = {
* @type function * @type function
* @param {node} foot "TR" element for the footer * @param {node} foot "TR" element for the footer
* @param {array} data Full table data (as derived from the original HTML) * @param {array} data Full table data (as derived from the original HTML)
* @param {int} start Index for the current display starting point in the * @param {int} start Index for the current display starting point in the
* display array * display array
* @param {int} end Index for the current display ending point in the * @param {int} end Index for the current display ending point in the
* display array * display array
* @param {array int} display Index array to translate the visual position * @param {array int} display Index array to translate the visual position
* to the full data array * to the full data array
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.footerCallback * @name DataTable.defaults.footerCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -900,7 +900,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.formatNumber * @name DataTable.defaults.formatNumber
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -908,11 +908,11 @@ DataTable.defaults = {
* if ( toFormat &lt; 1000 ) { * if ( toFormat &lt; 1000 ) {
* return toFormat; * return toFormat;
* } else { * } else {
* var * var
* s=(toFormat+""), * s=(toFormat+""),
* a=s.split(""), out="", * a=s.split(""), out="",
* iLen=s.length; * iLen=s.length;
* *
* for ( var i=0 ; i&lt;iLen ; i++ ) { * for ( var i=0 ; i&lt;iLen ; i++ ) {
* if ( i%3 === 0 &amp;&amp; i !== 0 ) { * if ( i%3 === 0 &amp;&amp; i !== 0 ) {
* out = "'"+out; * out = "'"+out;
@ -962,7 +962,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.headerCallback * @name DataTable.defaults.headerCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -994,7 +994,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.infoCallback * @name DataTable.defaults.infoCallback
* *
* @example * @example
* $('#example').dataTable( { * $('#example').dataTable( {
* "infoCallback": function( settings, start, end, nax, total, pre ) { * "infoCallback": function( settings, start, end, nax, total, pre ) {
@ -1017,7 +1017,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.initComplete * @name DataTable.defaults.initComplete
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1041,7 +1041,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.preDrawCallback * @name DataTable.defaults.preDrawCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1069,7 +1069,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.rowCallback * @name DataTable.defaults.rowCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1149,14 +1149,14 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateLoadCallback * @name DataTable.defaults.stateLoadCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
* "stateSave": true, * "stateSave": true,
* "stateLoadCallback": function (settings) { * "stateLoadCallback": function (settings) {
* var o; * var o;
* *
* // Send an Ajax request to the server to get the data. Note that * // Send an Ajax request to the server to get the data. Note that
* // this is a synchronous request. * // this is a synchronous request.
* $.ajax( { * $.ajax( {
@ -1167,7 +1167,7 @@ DataTable.defaults = {
* o = json; * o = json;
* } * }
* } ); * } );
* *
* return o; * return o;
* } * }
* } ); * } );
@ -1175,7 +1175,7 @@ DataTable.defaults = {
*/ */
"fnStateLoadCallback": function ( settings ) { "fnStateLoadCallback": function ( settings ) {
try { try {
return JSON.parse( return JSON.parse(
localStorage.getItem('DataTables_'+settings.sInstance+'_'+window.location.pathname) localStorage.getItem('DataTables_'+settings.sInstance+'_'+window.location.pathname)
); );
} catch (e) {} } catch (e) {}
@ -1185,8 +1185,8 @@ DataTable.defaults = {
/** /**
* Callback which allows modification of the saved state prior to loading that state. * Callback which allows modification of the saved state prior to loading that state.
* This callback is called when the table is loading state from the stored data, but * This callback is called when the table is loading state from the stored data, but
* prior to the settings object being modified by the saved state. Note that for * prior to the settings object being modified by the saved state. Note that for
* plug-in authors, you should use the `stateLoadParams` event to load parameters for * plug-in authors, you should use the `stateLoadParams` event to load parameters for
* a plug-in. * a plug-in.
* @type function * @type function
* @param {object} settings DataTables settings object * @param {object} settings DataTables settings object
@ -1194,7 +1194,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateLoadParams * @name DataTable.defaults.stateLoadParams
* *
* @example * @example
* // Remove a saved filter, so filtering is never loaded * // Remove a saved filter, so filtering is never loaded
* $(document).ready( function() { * $(document).ready( function() {
@ -1205,7 +1205,7 @@ DataTable.defaults = {
* } * }
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Disallow state loading by returning false * // Disallow state loading by returning false
* $(document).ready( function() { * $(document).ready( function() {
@ -1229,7 +1229,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateLoaded * @name DataTable.defaults.stateLoaded
* *
* @example * @example
* // Show an alert with the filtering value that was saved * // Show an alert with the filtering value that was saved
* $(document).ready( function() { * $(document).ready( function() {
@ -1255,7 +1255,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateSaveCallback * @name DataTable.defaults.stateSaveCallback
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1284,10 +1284,10 @@ DataTable.defaults = {
/** /**
* Callback which allows modification of the state to be saved. Called when the table * Callback which allows modification of the state to be saved. Called when the table
* has changed state a new state save is required. This method allows modification of * has changed state a new state save is required. This method allows modification of
* the state saving object prior to actually doing the save, including addition or * the state saving object prior to actually doing the save, including addition or
* other state properties or modification. Note that for plug-in authors, you should * other state properties or modification. Note that for plug-in authors, you should
* use the `stateSaveParams` event to save parameters for a plug-in. * use the `stateSaveParams` event to save parameters for a plug-in.
* @type function * @type function
* @param {object} settings DataTables settings object * @param {object} settings DataTables settings object
@ -1295,7 +1295,7 @@ DataTable.defaults = {
* *
* @dtopt Callbacks * @dtopt Callbacks
* @name DataTable.defaults.stateSaveParams * @name DataTable.defaults.stateSaveParams
* *
* @example * @example
* // Remove a saved filter, so filtering is never saved * // Remove a saved filter, so filtering is never saved
* $(document).ready( function() { * $(document).ready( function() {
@ -1319,7 +1319,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.stateDuration * @name DataTable.defaults.stateDuration
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1347,7 +1347,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.deferLoading * @name DataTable.defaults.deferLoading
* *
* @example * @example
* // 57 records available in the table, no filtering applied * // 57 records available in the table, no filtering applied
* $(document).ready( function() { * $(document).ready( function() {
@ -1357,7 +1357,7 @@ DataTable.defaults = {
* "deferLoading": 57 * "deferLoading": 57
* } ); * } );
* } ); * } );
* *
* @example * @example
* // 57 records after filtering, 100 without filtering (an initial filter applied) * // 57 records after filtering, 100 without filtering (an initial filter applied)
* $(document).ready( function() { * $(document).ready( function() {
@ -1383,7 +1383,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.displayLength * @name DataTable.defaults.displayLength
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1404,7 +1404,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.displayStart * @name DataTable.defaults.displayStart
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1426,7 +1426,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollLoadGap * @name DataTable.defaults.scrollLoadGap
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1452,7 +1452,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.tabIndex * @name DataTable.defaults.tabIndex
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1488,7 +1488,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.aria.sortAscending * @name DataTable.defaults.language.aria.sortAscending
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1511,7 +1511,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.aria.sortDescending * @name DataTable.defaults.language.aria.sortDescending
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1541,7 +1541,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.first * @name DataTable.defaults.language.paginate.first
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1564,7 +1564,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.last * @name DataTable.defaults.language.paginate.last
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1580,14 +1580,14 @@ DataTable.defaults = {
/** /**
* Text to use for the 'next' pagination button (to take the user to the * Text to use for the 'next' pagination button (to take the user to the
* next page). * next page).
* @type string * @type string
* @default Next * @default Next
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.next * @name DataTable.defaults.language.paginate.next
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1603,14 +1603,14 @@ DataTable.defaults = {
/** /**
* Text to use for the 'previous' pagination button (to take the user to * Text to use for the 'previous' pagination button (to take the user to
* the previous page). * the previous page).
* @type string * @type string
* @default Previous * @default Previous
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.paginate.previous * @name DataTable.defaults.language.paginate.previous
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1635,7 +1635,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.emptyTable * @name DataTable.defaults.language.emptyTable
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1649,16 +1649,16 @@ DataTable.defaults = {
/** /**
* This string gives information to the end user about the information that * This string gives information to the end user about the information that
* is current on display on the page. The _START_, _END_ and _TOTAL_ * is current on display on the page. The _START_, _END_ and _TOTAL_
* variables are all dynamically replaced as the table display updates, and * variables are all dynamically replaced as the table display updates, and
* can be freely moved or removed as the language requirements change. * can be freely moved or removed as the language requirements change.
* @type string * @type string
* @default Showing _START_ to _END_ of _TOTAL_ entries * @default Showing _START_ to _END_ of _TOTAL_ entries
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.info * @name DataTable.defaults.language.info
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1672,14 +1672,14 @@ DataTable.defaults = {
/** /**
* Display information string for when the table is empty. Typically the * Display information string for when the table is empty. Typically the
* format of this string should match `info`. * format of this string should match `info`.
* @type string * @type string
* @default Showing 0 to 0 of 0 entries * @default Showing 0 to 0 of 0 entries
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoEmpty * @name DataTable.defaults.language.infoEmpty
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1693,15 +1693,15 @@ DataTable.defaults = {
/** /**
* When a user filters the information in a table, this string is appended * When a user filters the information in a table, this string is appended
* to the information (`info`) to give an idea of how strong the filtering * to the information (`info`) to give an idea of how strong the filtering
* is. The variable _MAX_ is dynamically updated. * is. The variable _MAX_ is dynamically updated.
* @type string * @type string
* @default (filtered from _MAX_ total entries) * @default (filtered from _MAX_ total entries)
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoFiltered * @name DataTable.defaults.language.infoFiltered
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1724,7 +1724,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoPostFix * @name DataTable.defaults.language.infoPostFix
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1747,7 +1747,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.infoThousands * @name DataTable.defaults.language.infoThousands
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1767,10 +1767,10 @@ DataTable.defaults = {
* with a custom select box if required. * with a custom select box if required.
* @type string * @type string
* @default Show _MENU_ entries * @default Show _MENU_ entries
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.lengthMenu * @name DataTable.defaults.language.lengthMenu
* *
* @example * @example
* // Language change only * // Language change only
* $(document).ready( function() { * $(document).ready( function() {
@ -1780,7 +1780,7 @@ DataTable.defaults = {
* } * }
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Language and options change * // Language and options change
* $(document).ready( function() { * $(document).ready( function() {
@ -1812,7 +1812,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.loadingRecords * @name DataTable.defaults.language.loadingRecords
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1833,7 +1833,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.processing * @name DataTable.defaults.language.processing
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1857,7 +1857,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.search * @name DataTable.defaults.language.search
* *
* @example * @example
* // Input text box will be appended at the end automatically * // Input text box will be appended at the end automatically
* $(document).ready( function() { * $(document).ready( function() {
@ -1867,7 +1867,7 @@ DataTable.defaults = {
* } * }
* } ); * } );
* } ); * } );
* *
* @example * @example
* // Specify where the filter should appear * // Specify where the filter should appear
* $(document).ready( function() { * $(document).ready( function() {
@ -1893,7 +1893,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.url * @name DataTable.defaults.language.url
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1915,7 +1915,7 @@ DataTable.defaults = {
* *
* @dtopt Language * @dtopt Language
* @name DataTable.defaults.language.zeroRecords * @name DataTable.defaults.language.zeroRecords
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1942,7 +1942,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.search * @name DataTable.defaults.search
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -1956,7 +1956,7 @@ DataTable.defaults = {
/** /**
* __Deprecated__ The functionality provided by this parameter has now been * __Deprecated__ The functionality provided by this parameter has now been
* superseded by that provided through `ajax`, which should be used instead. * superseded by that provided through `ajax`, which should be used instead.
* *
* By default DataTables will look for the property 'aaData' when obtaining * By default DataTables will look for the property 'aaData' when obtaining
* data from an Ajax source or for server-side processing - this parameter * data from an Ajax source or for server-side processing - this parameter
* allows that property to be changed. You can use Javascript dotted object * allows that property to be changed. You can use Javascript dotted object
@ -2001,7 +2001,7 @@ DataTable.defaults = {
* table). DIV elements (with or without a custom class) can also be added to * table). DIV elements (with or without a custom class) can also be added to
* aid styling. The follow syntax is used: * aid styling. The follow syntax is used:
* <ul> * <ul>
* <li>The following options are allowed: * <li>The following options are allowed:
* <ul> * <ul>
* <li>'l' - Length changing</li * <li>'l' - Length changing</li
* <li>'f' - Filtering input</li> * <li>'f' - Filtering input</li>
@ -2032,12 +2032,12 @@ DataTable.defaults = {
* </li> * </li>
* </ul> * </ul>
* @type string * @type string
* @default lfrtip <i>(when `jQueryUI` is false)</i> <b>or</b> * @default lfrtip <i>(when `jQueryUI` is false)</i> <b>or</b>
* <"H"lfr>t<"F"ip> <i>(when `jQueryUI` is true)</i> * <"H"lfr>t<"F"ip> <i>(when `jQueryUI` is true)</i>
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.dom * @name DataTable.defaults.dom
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -2057,7 +2057,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.paginationType * @name DataTable.defaults.paginationType
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -2079,7 +2079,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.scrollX * @name DataTable.defaults.scrollX
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -2103,7 +2103,7 @@ DataTable.defaults = {
* *
* @dtopt Options * @dtopt Options
* @name DataTable.defaults.scrollXInner * @name DataTable.defaults.scrollXInner
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {
@ -2127,7 +2127,7 @@ DataTable.defaults = {
* *
* @dtopt Features * @dtopt Features
* @name DataTable.defaults.scrollY * @name DataTable.defaults.scrollY
* *
* @example * @example
* $(document).ready( function() { * $(document).ready( function() {
* $('#example').dataTable( { * $('#example').dataTable( {

84
media/src/model/model.ext.js
View File

@ -5,7 +5,7 @@
* for plug-ins that can be used to extend the default DataTables behaviour - indeed many * for plug-ins that can be used to extend the default DataTables behaviour - indeed many
* of the build in methods use this method to provide their own capabilities (sorting methods * of the build in methods use this method to provide their own capabilities (sorting methods
* for example). * for example).
* *
* Note that this namespace is aliased to jQuery.fn.dataTableExt so it can be readily accessed * Note that this namespace is aliased to jQuery.fn.dataTableExt so it can be readily accessed
* and modified by plug-ins. * and modified by plug-ins.
* @namespace * @namespace
@ -40,7 +40,7 @@ DataTable.models.ext = {
* *
* @example * @example
* // The following example shows custom filtering being applied to the fourth column (i.e. * // The following example shows custom filtering being applied to the fourth column (i.e.
* // the aData[3] index) based on two input values from the end-user, matching the data in * // the aData[3] index) based on two input values from the end-user, matching the data in
* // a certain range. * // a certain range.
* $.fn.dataTableExt.afnFiltering.push( * $.fn.dataTableExt.afnFiltering.push(
* function( oSettings, aData, iDataIndex ) { * function( oSettings, aData, iDataIndex ) {
@ -74,7 +74,7 @@ DataTable.models.ext = {
* static string that DataTables knows of. The way these plug-ins work is that you create * static string that DataTables knows of. The way these plug-ins work is that you create
* an array of the values you wish to be sorted for the column in question and then return * an array of the values you wish to be sorted for the column in question and then return
* that array. Which pre-sorting function is run here depends on the sSortDataType parameter * that array. Which pre-sorting function is run here depends on the sSortDataType parameter
* that is used for the column (if any). This is the corollary of <i>ofnSearch</i> for sort * that is used for the column (if any). This is the corollary of <i>ofnSearch</i> for sort
* data. * data.
* <ul> * <ul>
* <li> * <li>
@ -91,10 +91,10 @@ DataTable.models.ext = {
* </ul> * </ul>
* </il> * </il>
* </ul> * </ul>
* *
* Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for * Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for
* the different uses that DataTables can put the data to. Specifically <i>mData</i> when * the different uses that DataTables can put the data to. Specifically <i>mData</i> when
* used as a function will give you a 'type' (sorting, filtering etc) that you can use to * used as a function will give you a 'type' (sorting, filtering etc) that you can use to
* prepare the data as required for the different types. As such, this method is deprecated. * prepare the data as required for the different types. As such, this method is deprecated.
* @type array * @type array
* @default [] * @default []
@ -133,8 +133,8 @@ DataTable.models.ext = {
* Function return: * Function return:
* <ul> * <ul>
* <li>{node|null} The element which contains your feature. Note that the return * <li>{node|null} The element which contains your feature. Note that the return
* may also be void if your plug-in does not require to inject any DOM elements * may also be void if your plug-in does not require to inject any DOM elements
* into DataTables control (sDom) - for example this might be useful when * into DataTables control (sDom) - for example this might be useful when
* developing a plug-in which allows table control via keyboard entry.</li> * developing a plug-in which allows table control via keyboard entry.</li>
* </ul> * </ul>
* </il> * </il>
@ -145,7 +145,7 @@ DataTable.models.ext = {
* </ul> * </ul>
* @type array * @type array
* @default [] * @default []
* *
* @example * @example
* // How TableTools initialises itself. * // How TableTools initialises itself.
* $.fn.dataTableExt.aoFeatures.push( { * $.fn.dataTableExt.aoFeatures.push( {
@ -163,9 +163,9 @@ DataTable.models.ext = {
* Type detection plug-in functions - DataTables utilises types to define how sorting and * Type detection plug-in functions - DataTables utilises types to define how sorting and
* filtering behave, and types can be either be defined by the developer (sType for the * filtering behave, and types can be either be defined by the developer (sType for the
* column) or they can be automatically detected by the methods in this array. The functions * column) or they can be automatically detected by the methods in this array. The functions
* defined in the array are quite simple, taking a single parameter (the data to analyse) * defined in the array are quite simple, taking a single parameter (the data to analyse)
* and returning the type if it is a known type, or null otherwise. * and returning the type if it is a known type, or null otherwise.
* *
* * Function input parameters: * * Function input parameters:
* * {*} Data from the column cell to be analysed * * {*} Data from the column cell to be analysed
* * Function return: * * Function return:
@ -174,7 +174,7 @@ DataTable.models.ext = {
* *
* @type array * @type array
* @default [] * @default []
* *
* @example * @example
* // Currency type detection plug-in: * // Currency type detection plug-in:
* jQuery.fn.dataTableExt.aTypes.push( * jQuery.fn.dataTableExt.aTypes.push(
@ -183,7 +183,7 @@ DataTable.models.ext = {
* if ( ! $.isNumeric( data.substring(1) ) ) { * if ( ! $.isNumeric( data.substring(1) ) ) {
* return null; * return null;
* } * }
* *
* // Check prefixed by currency * // Check prefixed by currency
* if ( data.charAt(0) == '$' || data.charAt(0) == '&pound;' ) { * if ( data.charAt(0) == '$' || data.charAt(0) == '&pound;' ) {
* return 'currency'; * return 'currency';
@ -196,12 +196,12 @@ DataTable.models.ext = {
/** /**
* Provide a common method for plug-ins to check the version of DataTables being used, * Provide a common method for plug-ins to check the version of DataTables being used,
* in order to ensure compatibility. * in order to ensure compatibility.
* @type function * @type function
* @param {string} sVersion Version string to check for, in the format "X.Y.Z". Note * @param {string} sVersion Version string to check for, in the format "X.Y.Z". Note
* that the formats "X" and "X.Y" are also acceptable. * that the formats "X" and "X.Y" are also acceptable.
* @returns {boolean} true if this version of DataTables is greater or equal to the * @returns {boolean} true if this version of DataTables is greater or equal to the
* required version, or false if this version of DataTales is not suitable * required version, or false if this version of DataTales is not suitable
* *
* @example * @example
@ -223,10 +223,10 @@ DataTable.models.ext = {
/** /**
* Pre-processing of filtering data plug-ins - When you assign the sType for a column * Pre-processing of filtering data plug-ins - When you assign the sType for a column
* (or have it automatically detected for you by DataTables or a type detection plug-in), * (or have it automatically detected for you by DataTables or a type detection plug-in),
* you will typically be using this for custom sorting, but it can also be used to provide * you will typically be using this for custom sorting, but it can also be used to provide
* custom filtering by allowing you to pre-processing the data and returning the data in * custom filtering by allowing you to pre-processing the data and returning the data in
* the format that should be filtered upon. This is done by adding functions this object * the format that should be filtered upon. This is done by adding functions this object
* with a parameter name which matches the sType for that target column. This is the * with a parameter name which matches the sType for that target column. This is the
* corollary of <i>afnSortData</i> for filtering data. * corollary of <i>afnSortData</i> for filtering data.
* <ul> * <ul>
@ -243,10 +243,10 @@ DataTable.models.ext = {
* </ul> * </ul>
* </il> * </il>
* </ul> * </ul>
* *
* Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for * Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for
* the different uses that DataTables can put the data to. Specifically <i>mData</i> when * the different uses that DataTables can put the data to. Specifically <i>mData</i> when
* used as a function will give you a 'type' (sorting, filtering etc) that you can use to * used as a function will give you a 'type' (sorting, filtering etc) that you can use to
* prepare the data as required for the different types. As such, this method is deprecated. * prepare the data as required for the different types. As such, this method is deprecated.
* @type object * @type object
* @default {} * @default {}
@ -285,8 +285,8 @@ DataTable.models.ext = {
/** /**
* Pagination plug-in methods - The style and controls of the pagination can significantly * Pagination plug-in methods - The style and controls of the pagination can significantly
* impact on how the end user interacts with the data in your table, and DataTables allows * impact on how the end user interacts with the data in your table, and DataTables allows
* the addition of pagination controls by extending this object, which can then be enabled * the addition of pagination controls by extending this object, which can then be enabled
* through the <i>sPaginationType</i> initialisation parameter. Each pagination type that * through the <i>sPaginationType</i> initialisation parameter. Each pagination type that
* is added is an object (the property name of which is what <i>sPaginationType</i> refers * is added is an object (the property name of which is what <i>sPaginationType</i> refers
@ -294,12 +294,12 @@ DataTable.models.ext = {
* control's state. * control's state.
* <ul> * <ul>
* <li> * <li>
* fnInit - Initialisation of the paging controls. Called only during initialisation * fnInit - Initialisation of the paging controls. Called only during initialisation
* of the table. It is expected that this function will add the required DOM elements * of the table. It is expected that this function will add the required DOM elements
* to the page for the paging controls to work. The element pointer * to the page for the paging controls to work. The element pointer
* 'oSettings.aanFeatures.p' array is provided by DataTables to contain the paging * 'oSettings.aanFeatures.p' array is provided by DataTables to contain the paging
* controls (note that this is a 2D array to allow for multiple instances of each * controls (note that this is a 2D array to allow for multiple instances of each
* DataTables DOM element). It is suggested that you add the controls to this element * DataTables DOM element). It is suggested that you add the controls to this element
* as children * as children
* <ul> * <ul>
* <li> * <li>
@ -321,7 +321,7 @@ DataTable.models.ext = {
* </il> * </il>
* <li> * <li>
* fnInit - This function is called whenever the paging status of the table changes and is * fnInit - This function is called whenever the paging status of the table changes and is
* typically used to update classes and/or text of the paging controls to reflex the new * typically used to update classes and/or text of the paging controls to reflex the new
* status. * status.
* <ul> * <ul>
* <li> * <li>
@ -351,53 +351,53 @@ DataTable.models.ext = {
* nPrevious = document.createElement( 'span' ); * nPrevious = document.createElement( 'span' );
* nNext = document.createElement( 'span' ); * nNext = document.createElement( 'span' );
* nLast = document.createElement( 'span' ); * nLast = document.createElement( 'span' );
* *
* nFirst.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sFirst ) ); * nFirst.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sFirst ) );
* nPrevious.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sPrevious ) ); * nPrevious.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sPrevious ) );
* nNext.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sNext ) ); * nNext.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sNext ) );
* nLast.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sLast ) ); * nLast.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sLast ) );
* *
* nFirst.className = "paginate_button first"; * nFirst.className = "paginate_button first";
* nPrevious.className = "paginate_button previous"; * nPrevious.className = "paginate_button previous";
* nNext.className="paginate_button next"; * nNext.className="paginate_button next";
* nLast.className = "paginate_button last"; * nLast.className = "paginate_button last";
* *
* nPaging.appendChild( nFirst ); * nPaging.appendChild( nFirst );
* nPaging.appendChild( nPrevious ); * nPaging.appendChild( nPrevious );
* nPaging.appendChild( nNext ); * nPaging.appendChild( nNext );
* nPaging.appendChild( nLast ); * nPaging.appendChild( nLast );
* *
* $(nFirst).click( function () { * $(nFirst).click( function () {
* oSettings.oApi._fnPageChange( oSettings, "first" ); * oSettings.oApi._fnPageChange( oSettings, "first" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nPrevious).click( function() { * $(nPrevious).click( function() {
* oSettings.oApi._fnPageChange( oSettings, "previous" ); * oSettings.oApi._fnPageChange( oSettings, "previous" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nNext).click( function() { * $(nNext).click( function() {
* oSettings.oApi._fnPageChange( oSettings, "next" ); * oSettings.oApi._fnPageChange( oSettings, "next" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nLast).click( function() { * $(nLast).click( function() {
* oSettings.oApi._fnPageChange( oSettings, "last" ); * oSettings.oApi._fnPageChange( oSettings, "last" );
* fnCallbackDraw( oSettings ); * fnCallbackDraw( oSettings );
* } ); * } );
* *
* $(nFirst).bind( 'selectstart', function () { return false; } ); * $(nFirst).bind( 'selectstart', function () { return false; } );
* $(nPrevious).bind( 'selectstart', function () { return false; } ); * $(nPrevious).bind( 'selectstart', function () { return false; } );
* $(nNext).bind( 'selectstart', function () { return false; } ); * $(nNext).bind( 'selectstart', function () { return false; } );
* $(nLast).bind( 'selectstart', function () { return false; } ); * $(nLast).bind( 'selectstart', function () { return false; } );
* }, * },
* *
* "fnUpdate": function ( oSettings, fnCallbackDraw ) { * "fnUpdate": function ( oSettings, fnCallbackDraw ) {
* if ( !oSettings.aanFeatures.p ) { * if ( !oSettings.aanFeatures.p ) {
* return; * return;
* } * }
* *
* // Loop over each instance of the pager * // Loop over each instance of the pager
* var an = oSettings.aanFeatures.p; * var an = oSettings.aanFeatures.p;
* for ( var i=0, iLen=an.length ; i<iLen ; i++ ) { * for ( var i=0, iLen=an.length ; i<iLen ; i++ ) {
@ -410,7 +410,7 @@ DataTable.models.ext = {
* buttons[0].className = "paginate_enabled_previous"; * buttons[0].className = "paginate_enabled_previous";
* buttons[1].className = "paginate_enabled_previous"; * buttons[1].className = "paginate_enabled_previous";
* } * }
* *
* if ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) { * if ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) {
* buttons[2].className = "paginate_disabled_next"; * buttons[2].className = "paginate_disabled_next";
* buttons[3].className = "paginate_disabled_next"; * buttons[3].className = "paginate_disabled_next";
@ -428,8 +428,8 @@ DataTable.models.ext = {
/** /**
* Sorting plug-in methods - Sorting in DataTables is based on the detected type of the * Sorting plug-in methods - Sorting in DataTables is based on the detected type of the
* data column (you can add your own type detection functions, or override automatic * data column (you can add your own type detection functions, or override automatic
* detection using sType). With this specific type given to the column, DataTables will * detection using sType). With this specific type given to the column, DataTables will
* apply the required sort from the functions in the object. Each sort type must provide * apply the required sort from the functions in the object. Each sort type must provide
* two mandatory methods, one each for ascending and descending sorting, and can optionally * two mandatory methods, one each for ascending and descending sorting, and can optionally
* provide a pre-formatting method that will help speed up sorting by allowing DataTables * provide a pre-formatting method that will help speed up sorting by allowing DataTables

8
media/src/model/model.row.js
View File

@ -3,7 +3,7 @@
/** /**
* Template object for the way in which DataTables holds information about * Template object for the way in which DataTables holds information about
* each individual row. This is the object format used for the settings * each individual row. This is the object format used for the settings
* aoData array. * aoData array.
* @namespace * @namespace
*/ */
@ -19,7 +19,7 @@ DataTable.models.oRow = {
* Data object from the original data source for the row. This is either * Data object from the original data source for the row. This is either
* an array if using the traditional form of DataTables, or an object if * an array if using the traditional form of DataTables, or an object if
* using mData options. The exact type will depend on the passed in * using mData options. The exact type will depend on the passed in
* data from the data source, or will be an array if using DOM a data * data from the data source, or will be an array if using DOM a data
* source. * source.
* @type array|object * @type array|object
* @default [] * @default []
@ -28,7 +28,7 @@ DataTable.models.oRow = {
/** /**
* Sorting data cache - this array is ostensibly the same length as the * Sorting data cache - this array is ostensibly the same length as the
* number of columns (although each index is generated only as it is * number of columns (although each index is generated only as it is
* needed), and holds the data that is used for sorting each column in the * needed), and holds the data that is used for sorting each column in the
* row. We do this cache generation at the start of the sort in order that * row. We do this cache generation at the start of the sort in order that
* the formatting of the sort data need be done only once for each cell * the formatting of the sort data need be done only once for each cell
@ -43,7 +43,7 @@ DataTable.models.oRow = {
/** /**
* Array of TD elements that are cached for hidden rows, so they can be * Array of TD elements that are cached for hidden rows, so they can be
* reinserted into the table if a column is made visible again (or to act * reinserted into the table if a column is made visible again (or to act
* as a store if a column is made hidden). Only hidden columns have a * as a store if a column is made hidden). Only hidden columns have a
* reference in the array. For non-hidden columns the value is either * reference in the array. For non-hidden columns the value is either
* undefined or null. * undefined or null.
* @type array nodes * @type array nodes

56
media/src/model/model.settings.js
View File

@ -5,11 +5,11 @@
* given table, including configuration, data and current application of the * given table, including configuration, data and current application of the
* table options. DataTables does not have a single instance for each DataTable * table options. DataTables does not have a single instance for each DataTable
* with the settings attached to that instance, but rather instances of the * with the settings attached to that instance, but rather instances of the
* DataTable "class" are created on-the-fly as needed (typically by a * DataTable "class" are created on-the-fly as needed (typically by a
* $().dataTable() call) and the settings object is then applied to that * $().dataTable() call) and the settings object is then applied to that
* instance. * instance.
* *
* Note that this object is related to {@link DataTable.defaults} but this * Note that this object is related to {@link DataTable.defaults} but this
* one is the internal data store for DataTables's cache of columns. It should * one is the internal data store for DataTables's cache of columns. It should
* NOT be manipulated outside of DataTables. Any configuration should be done * NOT be manipulated outside of DataTables. Any configuration should be done
* through the initialisation options. * through the initialisation options.
@ -17,7 +17,7 @@
* @todo Really should attach the settings object to individual instances so we * @todo Really should attach the settings object to individual instances so we
* don't need to create new instances on each $().dataTable() call (if the * don't need to create new instances on each $().dataTable() call (if the
* table already exists). It would also save passing oSettings around and * table already exists). It would also save passing oSettings around and
* into every single function. However, this is a very significant * into every single function. However, this is a very significant
* architecture change for DataTables and will almost certainly break * architecture change for DataTables and will almost certainly break
* backwards compatibility with older installations. This is something that * backwards compatibility with older installations. This is something that
* will be done in 2.0. * will be done in 2.0.
@ -175,7 +175,7 @@ DataTable.models.oSettings = {
"iBarWidth": 0, "iBarWidth": 0,
/** /**
* Space (in pixels) between the bottom of the scrolling container and * Space (in pixels) between the bottom of the scrolling container and
* the bottom of the scrolling viewport before the next page is loaded * the bottom of the scrolling viewport before the next page is loaded
* when using infinite scrolling. * when using infinite scrolling.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
@ -185,7 +185,7 @@ DataTable.models.oSettings = {
"iLoadGap": null, "iLoadGap": null,
/** /**
* Viewport width for horizontal scrolling. Horizontal scrolling is * Viewport width for horizontal scrolling. Horizontal scrolling is
* disabled if an empty string. * disabled if an empty string.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -220,7 +220,7 @@ DataTable.models.oSettings = {
*/ */
"oLanguage": { "oLanguage": {
/** /**
* Information callback function. See * Information callback function. See
* {@link DataTable.defaults.fnInfoCallback} * {@link DataTable.defaults.fnInfoCallback}
* @type function * @type function
* @default null * @default null
@ -256,7 +256,7 @@ DataTable.models.oSettings = {
/** /**
* Array referencing the nodes which are used for the features. The * Array referencing the nodes which are used for the features. The
* parameters of this object match what is allowed by sDom - i.e. * parameters of this object match what is allowed by sDom - i.e.
* <ul> * <ul>
* <li>'l' - Length changing</li> * <li>'l' - Length changing</li>
@ -322,7 +322,7 @@ DataTable.models.oSettings = {
"asDataSearch": [], "asDataSearch": [],
/** /**
* Store the applied global search information in case we want to force a * Store the applied global search information in case we want to force a
* research or compare the old search to a new one. * research or compare the old search to a new one.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -332,7 +332,7 @@ DataTable.models.oSettings = {
"oPreviousSearch": {}, "oPreviousSearch": {},
/** /**
* Store the applied search for each column - see * Store the applied search for each column - see
* {@link DataTable.models.oSearch} for the format that is used for the * {@link DataTable.models.oSearch} for the format that is used for the
* filtering information for each column. * filtering information for each column.
* @type array * @type array
@ -382,7 +382,7 @@ DataTable.models.oSettings = {
"asDestroyStripes": [], "asDestroyStripes": [],
/** /**
* If restoring a table - we should restore its width * If restoring a table - we should restore its width
* @type int * @type int
* @default 0 * @default 0
*/ */
@ -424,7 +424,7 @@ DataTable.models.oSettings = {
"aoRowCreatedCallback": [], "aoRowCreatedCallback": [],
/** /**
* Callback functions for just before the table is redrawn. A return of * Callback functions for just before the table is redrawn. A return of
* false will be used to cancel the draw. * false will be used to cancel the draw.
* @type array * @type array
* @default [] * @default []
@ -506,7 +506,7 @@ DataTable.models.oSettings = {
"nTableWrapper": null, "nTableWrapper": null,
/** /**
* Indicate if when using server-side processing the loading of data * Indicate if when using server-side processing the loading of data
* should be deferred until the second draw. * should be deferred until the second draw.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -544,7 +544,7 @@ DataTable.models.oSettings = {
* Which type of pagination should be used. * Which type of pagination should be used.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
* @type string * @type string
* @default two_button * @default two_button
*/ */
"sPaginationType": "two_button", "sPaginationType": "two_button",
@ -559,12 +559,12 @@ DataTable.models.oSettings = {
"iStateDuration": 0, "iStateDuration": 0,
/** /**
* Array of callback functions for state saving. Each array element is an * Array of callback functions for state saving. Each array element is an
* object with the following parameters: * object with the following parameters:
* <ul> * <ul>
* <li>function:fn - function to call. Takes two parameters, oSettings * <li>function:fn - function to call. Takes two parameters, oSettings
* and the JSON string to save that has been thus far created. Returns * and the JSON string to save that has been thus far created. Returns
* a JSON string to be inserted into a json object * a JSON string to be inserted into a json object
* (i.e. '"param": [ 0, 1, 2]')</li> * (i.e. '"param": [ 0, 1, 2]')</li>
* <li>string:sName - name of callback</li> * <li>string:sName - name of callback</li>
* </ul> * </ul>
@ -574,10 +574,10 @@ DataTable.models.oSettings = {
"aoStateSave": [], "aoStateSave": [],
/** /**
* Array of callback functions for state loading. Each array element is an * Array of callback functions for state loading. Each array element is an
* object with the following parameters: * object with the following parameters:
* <ul> * <ul>
* <li>function:fn - function to call. Takes two parameters, oSettings * <li>function:fn - function to call. Takes two parameters, oSettings
* and the object stored. May return false to cancel state loading</li> * and the object stored. May return false to cancel state loading</li>
* <li>string:sName - name of callback</li> * <li>string:sName - name of callback</li>
* </ul> * </ul>
@ -604,7 +604,7 @@ DataTable.models.oSettings = {
/** /**
* Property from a given object from which to read the table data from. This * Property from a given object from which to read the table data from. This
* can be an empty string (when not server-side processing), in which case * can be an empty string (when not server-side processing), in which case
* it is assumed an an array is given directly. * it is assumed an an array is given directly.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -620,8 +620,8 @@ DataTable.models.oSettings = {
"bAjaxDataGet": true, "bAjaxDataGet": true,
/** /**
* The last jQuery XHR object that was used for server-side data gathering. * The last jQuery XHR object that was used for server-side data gathering.
* This can be used for working with the XHR information in one of the * This can be used for working with the XHR information in one of the
* callbacks * callbacks
* @type object * @type object
* @default null * @default null
@ -637,7 +637,7 @@ DataTable.models.oSettings = {
"fnServerData": null, "fnServerData": null,
/** /**
* Functions which are called prior to sending an Ajax request so extra * Functions which are called prior to sending an Ajax request so extra
* parameters can easily be sent to the server * parameters can easily be sent to the server
* @type array * @type array
* @default [] * @default []
@ -645,7 +645,7 @@ DataTable.models.oSettings = {
"aoServerParams": [], "aoServerParams": [],
/** /**
* Send the XHR HTTP method - GET or POST (could be PUT or DELETE if * Send the XHR HTTP method - GET or POST (could be PUT or DELETE if
* required). * required).
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -753,7 +753,7 @@ DataTable.models.oSettings = {
"oClasses": {}, "oClasses": {},
/** /**
* Flag attached to the settings object so you can check in the draw * Flag attached to the settings object so you can check in the draw
* callback if filtering has been done in the draw. Deprecated in favour of * callback if filtering has been done in the draw. Deprecated in favour of
* events. * events.
* @type boolean * @type boolean
@ -763,7 +763,7 @@ DataTable.models.oSettings = {
"bFiltered": false, "bFiltered": false,
/** /**
* Flag attached to the settings object so you can check in the draw * Flag attached to the settings object so you can check in the draw
* callback if sorting has been done in the draw. Deprecated in favour of * callback if sorting has been done in the draw. Deprecated in favour of
* events. * events.
* @type boolean * @type boolean
@ -773,8 +773,8 @@ DataTable.models.oSettings = {
"bSorted": false, "bSorted": false,
/** /**
* Indicate that if multiple rows are in the header and there is more than * Indicate that if multiple rows are in the header and there is more than
* one unique cell per column, if the top one (true) or bottom one (false) * one unique cell per column, if the top one (true) or bottom one (false)
* should be used for sorting / title by DataTables. * should be used for sorting / title by DataTables.
* Note that this parameter will be set by the initialisation routine. To * Note that this parameter will be set by the initialisation routine. To
* set a default use {@link DataTable.defaults}. * set a default use {@link DataTable.defaults}.
@ -835,7 +835,7 @@ DataTable.models.oSettings = {
if ( this.oFeatures.bPaginate === false || this._iDisplayLength == -1 ) { if ( this.oFeatures.bPaginate === false || this._iDisplayLength == -1 ) {
return this._iDisplayStart+this.aiDisplay.length; return this._iDisplayStart+this.aiDisplay.length;
} else { } else {
return Math.min( this._iDisplayStart+this._iDisplayLength, return Math.min( this._iDisplayStart+this._iDisplayLength,
this._iRecordsDisplay ); this._iRecordsDisplay );
} }
} else { } else {