rooty/DataTables
1
0
Fork 0
mirror of https://github.com/DataTables/DataTables.git synced 2025-02-18 16:54:14 +01:00
Code Issues Releases Activity

Update: mDataProp update to make it more versitile as a function and fix the settings of data with mDataProp. When mDataProp is given as a function, the function is now called with a 'type' of 'set', which the developer using mDataProp must used to store the value that if given (otherwise DOM read values would not be stored!).

Browse Source 
Update: mDataProp documentation - example of using mDataProp as a function and clearer information about the options for mDataProp
This commit is contained in:
Allan Jardine 2012-01-22 10:56:24 +00:00
parent 2aea4da8bc
commit fc81ce726b
4 changed files with 142 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -607,6 +607,11 @@
}
}
}
if ( typeof oCol.mDataProp === 'function' )
{
nCell.innerHTML = _fnGetCellData( oSettings, iRow, iColumn, 'display' );
}
/* Rendering */
if ( bRender )
@ -771,9 +776,9 @@
}
else if ( typeof mSource === 'function' )
{
return function (data, type) {
return mSource( data, type );
};
return function (data, type) {
return mSource( data, type );
};
}
else if ( typeof mSource === 'string' && mSource.indexOf('.') != -1 )
{
@ -831,9 +836,9 @@
}
else if ( typeof mSource === 'function' )
{
return function (data, val) {
return mSource( data, val );
};
return function (data, val) {
mSource( data, 'set', val );
};
}
else if ( typeof mSource === 'string' && mSource.indexOf('.') != -1 )
{
@ -5887,8 +5892,8 @@
else
{
/* Individual cell update */
sDisplay = mData;
_fnSetCellData( oSettings, iRow, iColumn, sDisplay );
_fnSetCellData( oSettings, iRow, iColumn, mData );
sDisplay = _fnGetCellData( oSettings, iRow, iColumn, 'display' );
var oCol = oSettings.aoColumns[iColumn];
if ( oCol.fnRender !== null )
@ -9403,6 +9408,10 @@
* When using fnRender() for a column, you may wish to use the original data
* (before rendering) for sorting and filtering (the default is to used the
* rendered data that the user can see). This may be useful for dates etc.
*
* *NOTE* It is it is advisable now to use mDataProp as a function and make
* use of the 'type' that it gives, allowing (potentially) different data to
* be used for sorting, filtering, display and type detection.
* @type boolean
* @default true
*
@ -9586,17 +9595,35 @@
/**
* This property can be used to read data from any JSON data source property,
* including deeply nested objects / properties. By default DataTables will
* use an array index (incrementally increased for each column) as the data
* source, but a string can be used for this property which will read an
* object property from the data source, a function which will be given the
* data source object to render into a string or null where the cell will be
* treated as empty. For more information see
* http://datatables.net/blog/Extended_data_source_options_with_DataTables
* including deeply nested objects / properties. mDataProp can be given in a
* number of different ways which effect its behaviour:
* <ul>
* <li>integer - treated as an array index for the data source. This is the
* default that DataTables uses (incrementally increased for each column).</li>
* <li>string - read an object property from the data source. Note that you can
* use Javascript dotted notation to read deep properties/arrays from the
* data source.</li>
* <li>null - the sDafaultContent option will use used for the cell (empty
* string by default. This can be useful on generated columns such as
* edit / delete action columns.</li>
* <li>function - the function given will be executed whenever DataTables
* needs to set or get the data for a cell in the column. The function
* takes three parameters:
* <ul>
* <li>{array|object} The data source for the row</li>
* <li>{string} The type call data requested - this will be 'set' when
* setting data or 'filter', 'display', 'type' or 'sort' when gathering
* data.</li>
* </ul>
* The return value from the function is not required when 'set' is the type
* of call, but otherwise the return is what will be used for the data
* requested.</li>
* </ul>
* @type string|int|function|null
* @default null <i>Use automatically calculated column index</i>
*
* @example
* // Read table data from objects
* $(document).ready(function() {
* var oTable = $('#example').dataTable( {
* "sAjaxSource": "sources/deep.txt",
@ -9609,6 +9636,35 @@
* ]
* } );
* } );
*
* @example
* // Using mDataProp as a function to provide different information for
* // sorting, filtering and display. In this case, currency (price)
* $(document).ready(function() {
* var oTable = $('#example').dataTable( {
* "aoColumnDefs": [
* {
* "aTargets": [ 0 ],
* "mDataProp": function ( source, type, val ) {
* if (type === 'set') {
* source.price = val;
* // Store the computed dislay and filter values for efficiency
* source.price_display = val=="" ? "" : "$"+numberFormat(val);
* source.price_filter = val=="" ? "" : "$"+numberFormat(val)+" "+val;
* return;
* }
* else if (type === 'display') {
* return source.price_display;
* }
* else if (type === 'filter') {
* return source.price_filter;
* }
* // 'sort' and 'type' both just use the integer
* return source.price;
* }
* ]
* } );
* } );
*/
"mDataProp": null,

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

@ -1162,8 +1162,8 @@ this.fnUpdate = function( mData, mRow, iColumn, bRedraw, bAction )
else
{
/* Individual cell update */
sDisplay = mData;
_fnSetCellData( oSettings, iRow, iColumn, sDisplay );
_fnSetCellData( oSettings, iRow, iColumn, mData );
sDisplay = _fnGetCellData( oSettings, iRow, iColumn, 'display' );
var oCol = oSettings.aoColumns[iColumn];
if ( oCol.fnRender !== null )

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

@ -182,6 +182,11 @@ function _fnGatherData( oSettings )
}
}
}
if ( typeof oCol.mDataProp === 'function' )
{
nCell.innerHTML = _fnGetCellData( oSettings, iRow, iColumn, 'display' );
}
/* Rendering */
if ( bRender )
@ -346,9 +351,9 @@ function _fnGetObjectDataFn( mSource )
}
else if ( typeof mSource === 'function' )
{
return function (data, type) {
return mSource( data, type );
};
return function (data, type) {
return mSource( data, type );
};
}
else if ( typeof mSource === 'string' && mSource.indexOf('.') != -1 )
{
@ -406,9 +411,9 @@ function _fnSetObjectDataFn( mSource )
}
else if ( typeof mSource === 'function' )
{
return function (data, val) {
return mSource( data, val );
};
return function (data, val) {
mSource( data, 'set', val );
};
}
else if ( typeof mSource === 'string' && mSource.indexOf('.') != -1 )
{

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

@ -141,6 +141,10 @@ DataTable.defaults.columns = {
* When using fnRender() for a column, you may wish to use the original data
* (before rendering) for sorting and filtering (the default is to used the
* rendered data that the user can see). This may be useful for dates etc.
*
* *NOTE* It is it is advisable now to use mDataProp as a function and make
* use of the 'type' that it gives, allowing (potentially) different data to
* be used for sorting, filtering, display and type detection.
* @type boolean
* @default true
*
@ -324,17 +328,35 @@ DataTable.defaults.columns = {
/**
* This property can be used to read data from any JSON data source property,
* including deeply nested objects / properties. By default DataTables will
* use an array index (incrementally increased for each column) as the data
* source, but a string can be used for this property which will read an
* object property from the data source, a function which will be given the
* data source object to render into a string or null where the cell will be
* treated as empty. For more information see
* http://datatables.net/blog/Extended_data_source_options_with_DataTables
* including deeply nested objects / properties. mDataProp can be given in a
* number of different ways which effect its behaviour:
* <ul>
* <li>integer - treated as an array index for the data source. This is the
* default that DataTables uses (incrementally increased for each column).</li>
* <li>string - read an object property from the data source. Note that you can
* use Javascript dotted notation to read deep properties/arrays from the
* data source.</li>
* <li>null - the sDafaultContent option will use used for the cell (empty
* string by default. This can be useful on generated columns such as
* edit / delete action columns.</li>
* <li>function - the function given will be executed whenever DataTables
* needs to set or get the data for a cell in the column. The function
* takes three parameters:
* <ul>
* <li>{array|object} The data source for the row</li>
* <li>{string} The type call data requested - this will be 'set' when
* setting data or 'filter', 'display', 'type' or 'sort' when gathering
* data.</li>
* </ul>
* The return value from the function is not required when 'set' is the type
* of call, but otherwise the return is what will be used for the data
* requested.</li>
* </ul>
* @type string|int|function|null
* @default null <i>Use automatically calculated column index</i>
*
* @example
* // Read table data from objects
* $(document).ready(function() {
* var oTable = $('#example').dataTable( {
* "sAjaxSource": "sources/deep.txt",
@ -347,6 +369,35 @@ DataTable.defaults.columns = {
* ]
* } );
* } );
*
* @example
* // Using mDataProp as a function to provide different information for
* // sorting, filtering and display. In this case, currency (price)
* $(document).ready(function() {
* var oTable = $('#example').dataTable( {
* "aoColumnDefs": [
* {
* "aTargets": [ 0 ],
* "mDataProp": function ( source, type, val ) {
* if (type === 'set') {
* source.price = val;
* // Store the computed dislay and filter values for efficiency
* source.price_display = val=="" ? "" : "$"+numberFormat(val);
* source.price_filter = val=="" ? "" : "$"+numberFormat(val)+" "+val;
* return;
* }
* else if (type === 'display') {
* return source.price_display;
* }
* else if (type === 'filter') {
* return source.price_filter;
* }
* // 'sort' and 'type' both just use the integer
* return source.price;
* }
* ]
* } );
* } );
*/
"mDataProp": null,