mirror of
https://github.com/DataTables/DataTables.git
synced 2025-01-18 11:52:11 +01:00
New: HTML5 data attribute support. data-* attributes can now be used to
source orthogonal data for filtering, sorting and type detection data. - In HTML5 the data-* attributes can be used to add semantic data to an HTML page, which a user will not see, but the scripts on the page can interact with. DataTables now has the ability to use these attributes (actually any attribute can be used) as a data source. Previously DOM sourced tables always used just the content of the cells for all data interaction, but this can provide advanced controls in just the same way that Javascript / Ajax sourced data can do orthogonal data in DataTables. - A typical use case is to provide numeric sorting information for complex formatted dates that the browser doesn't understand with Date.prase().
This commit is contained in:
Allan Jardine
parent
b353431cbe
commit
0f2cc15217
222
examples/basic_init/html5.html
Normal file
222
examples/basic_init/html5.html
Normal file
@ -0,0 +1,222 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rel="shortcut icon" type="image/ico" href="http://www.datatables.net/favicon.ico" />
|
||||
|
||||
<title>DataTables example</title>
|
||||
<style type="text/css" title="currentStyle">
|
||||
@import "../../media/css/demo_page.css";
|
||||
@import "../../media/css/jquery.dataTables.css";
|
||||
</style>
|
||||
<script type="text/javascript" language="javascript" src="../../media/js/jquery.js"></script>
|
||||
<script type="text/javascript" language="javascript" src="../../media/js/jquery.dataTables.js"></script>
|
||||
<script type="text/javascript" charset="utf-8">
|
||||
$(document).ready(function() {
|
||||
api = $('#example').DataTable( {
|
||||
columnDefs: [ {
|
||||
data: {
|
||||
_: '3.display',
|
||||
sort: '3.@data-sort', // is also type detection (when auto detected)
|
||||
type: '3.@data-sort',
|
||||
filter: '3.@data-filter'
|
||||
},
|
||||
targets: [ 3 ]
|
||||
} ]
|
||||
} );
|
||||
t = $('#example').dataTable();
|
||||
} );
|
||||
</script>
|
||||
</head>
|
||||
<body id="dt_example">
|
||||
<div id="container">
|
||||
<div class="full_width big">
|
||||
DataTables zero configuration example
|
||||
</div>
|
||||
|
||||
<h1>Preamble</h1>
|
||||
<p>DataTables has most features enabled by default, so all you need to do to use it with one of your own tables is to call the construction function (as shown below).</p>
|
||||
|
||||
<h1>Live example</h1>
|
||||
<div id="demo">
|
||||
<table cellpadding="0" cellspacing="0" border="0" class="display" id="example" width="100%">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Rendering engine</th>
|
||||
<th>Browser</th>
|
||||
<th>Platform(s)</th>
|
||||
<th>Engine version</th>
|
||||
<th>CSS grade</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="odd gradeX">
|
||||
<td>Trident</td>
|
||||
<td>Internet Explorer 4.0</td>
|
||||
<td>Win 95+</td>
|
||||
<td data-sort="4" data-filter="allan">4</td>
|
||||
<td>X</td>
|
||||
</tr>
|
||||
<tr class="even gradeC">
|
||||
<td>Trident</td>
|
||||
<td>Internet Explorer 5.0</td>
|
||||
<td>Win 95+</td>
|
||||
<td data-sort="5" data-filter="lottie">5</td>
|
||||
<td>C</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Rendering engine</th>
|
||||
<th>Browser</th>
|
||||
<th>Platform(s)</th>
|
||||
<th>Engine version</th>
|
||||
<th>CSS grade</th>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div>
|
||||
<div class="spacer"></div>
|
||||
|
||||
|
||||
<h1>Initialisation code</h1>
|
||||
<pre class="brush: js;">$(document).ready(function() {
|
||||
$('#example').dataTable();
|
||||
} );</pre>
|
||||
<style type="text/css">
|
||||
@import "../examples_support/syntax/css/shCore.css";
|
||||
</style>
|
||||
<script type="text/javascript" language="javascript" src="../examples_support/syntax/js/shCore.js"></script>
|
||||
|
||||
|
||||
<h1>Other examples</h1>
|
||||
<div class="demo_links">
|
||||
<h2>Basic initialisation</h2>
|
||||
<ul>
|
||||
<li><a href="../basic_init/zero_config.html">Zero configuration</a></li>
|
||||
<li><a href="../basic_init/filter_only.html">Feature enablement</a></li>
|
||||
<li><a href="../basic_init/table_sorting.html">Sorting data</a></li>
|
||||
<li><a href="../basic_init/multi_col_sort.html">Multi-column sorting</a></li>
|
||||
<li><a href="../basic_init/multiple_tables.html">Multiple tables</a></li>
|
||||
<li><a href="../basic_init/hidden_columns.html">Hidden columns</a></li>
|
||||
<li><a href="../basic_init/complex_header.html">Complex headers - grouping with colspan</a></li>
|
||||
<li><a href="../basic_init/dom.html">DOM positioning</a></li>
|
||||
<li><a href="../basic_init/flexible_width.html">Flexible table width</a></li>
|
||||
<li><a href="../basic_init/state_save.html">State saving</a></li>
|
||||
<li><a href="../basic_init/alt_pagination.html">Alternative pagination styles</a></li>
|
||||
<li>Scrolling: <br>
|
||||
<a href="../basic_init/scroll_x.html">Horizontal</a> /
|
||||
<a href="../basic_init/scroll_y.html">Vertical</a> /
|
||||
<a href="../basic_init/scroll_xy.html">Both</a> /
|
||||
<a href="../basic_init/scroll_y_theme.html">Themed</a> /
|
||||
<a href="../basic_init/scroll_y_infinite.html">Infinite</a>
|
||||
</li>
|
||||
<li><a href="../basic_init/language.html">Change language information (internationalisation)</a></li>
|
||||
<li><a href="../basic_init/themes.html">ThemeRoller themes (Smoothness)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Advanced initialisation</h2>
|
||||
<ul>
|
||||
<li>Events: <br>
|
||||
<a href="../advanced_init/events_live.html">Live events</a> /
|
||||
<a href="../advanced_init/events_pre_init.html">Pre-init</a> /
|
||||
<a href="../advanced_init/events_post_init.html">Post-init</a>
|
||||
</li>
|
||||
<li><a href="../advanced_init/column_render.html">Column rendering</a></li>
|
||||
<li><a href="../advanced_init/html_sort.html">Sorting without HTML tags</a></li>
|
||||
<li><a href="../advanced_init/dom_multiple_elements.html">Multiple table controls (sDom)</a></li>
|
||||
<li><a href="../advanced_init/length_menu.html">Defining length menu options</a></li>
|
||||
<li><a href="../advanced_init/complex_header.html">Complex headers and hidden columns</a></li>
|
||||
<li><a href="../advanced_init/dom_toolbar.html">Custom toolbar (element) around table</a></li>
|
||||
<li><a href="../advanced_init/highlight.html">Row highlighting with CSS</a></li>
|
||||
<li><a href="../advanced_init/row_grouping.html">Row grouping</a></li>
|
||||
<li><a href="../advanced_init/row_callback.html">Row callback</a></li>
|
||||
<li><a href="../advanced_init/footer_callback.html">Footer callback</a></li>
|
||||
<li><a href="../advanced_init/sorting_control.html">Control sorting direction of columns</a></li>
|
||||
<li><a href="../advanced_init/language_file.html">Change language information from a file (internationalisation)</a></li>
|
||||
<li><a href="../advanced_init/defaults.html">Setting defaults</a></li>
|
||||
<li><a href="../advanced_init/localstorage.html">State saving with localStorage</a></li>
|
||||
<li><a href="../advanced_init/dt_events.html">Custom events</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>API</h2>
|
||||
<ul>
|
||||
<li><a href="../api/add_row.html">Dynamically add a new row</a></li>
|
||||
<li><a href="../api/multi_filter.html">Individual column filtering (using "input" elements)</a></li>
|
||||
<li><a href="../api/multi_filter_select.html">Individual column filtering (using "select" elements)</a></li>
|
||||
<li><a href="../api/highlight.html">Highlight rows and columns</a></li>
|
||||
<li><a href="../api/row_details.html">Show and hide details about a particular record</a></li>
|
||||
<li><a href="../api/select_row.html">User selectable rows (multiple rows)</a></li>
|
||||
<li><a href="../api/select_single_row.html">User selectable rows (single row) and delete rows</a></li>
|
||||
<li><a href="../api/editable.html">Editable rows (with jEditable)</a></li>
|
||||
<li><a href="../api/form.html">Submit form with elements in table</a></li>
|
||||
<li><a href="../api/counter_column.html">Index column (static number column)</a></li>
|
||||
<li><a href="../api/show_hide.html">Show and hide columns dynamically</a></li>
|
||||
<li><a href="../api/api_in_init.html">API function use in initialisation object (callback)</a></li>
|
||||
<li><a href="../api/tabs_and_scrolling.html">DataTables scrolling and tabs</a></li>
|
||||
<li><a href="../api/regex.html">Regular expression filtering</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="demo_links">
|
||||
<h2>Data sources</h2>
|
||||
<ul>
|
||||
<li><a href="../data_sources/dom.html">DOM</a></li>
|
||||
<li><a href="../data_sources/js_array.html">Javascript array</a></li>
|
||||
<li><a href="../data_sources/ajax.html">Ajax source</a></li>
|
||||
<li><a href="../data_sources/server_side.html">Server side processing</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Server-side processing</h2>
|
||||
<ul>
|
||||
<li><a href="../server_side/server_side.html">Obtain server-side data</a></li>
|
||||
<li><a href="../server_side/custom_vars.html">Add extra HTTP variables</a></li>
|
||||
<li><a href="../server_side/post.html">Use HTTP POST</a></li>
|
||||
<li><a href="../server_side/ids.html">Automatic addition of IDs and classes to rows</a></li>
|
||||
<li><a href="../server_side/object_data.html">Reading table data from objects</a></li>
|
||||
<li><a href="../server_side/row_details.html">Show and hide details about a particular record</a></li>
|
||||
<li><a href="../server_side/select_rows.html">User selectable rows (multiple rows)</a></li>
|
||||
<li><a href="../server_side/jsonp.html">JSONP for a cross domain data source</a></li>
|
||||
<li><a href="../server_side/editable.html">jEditable integration with DataTables</a></li>
|
||||
<li><a href="../server_side/defer_loading.html">Deferred loading of Ajax data</a></li>
|
||||
<li><a href="../server_side/pipeline.html">Pipelining data (reduce Ajax calls for paging)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Ajax data source</h2>
|
||||
<ul>
|
||||
<li><a href="../ajax/ajax.html">Ajax sourced data (array of arrays)</a></li>
|
||||
<li><a href="../ajax/objects.html">Ajax sourced data (array of objects)</a></li>
|
||||
<li><a href="../ajax/defer_render.html">Deferred DOM creation for extra speed</a></li>
|
||||
<li><a href="../ajax/null_data_source.html">Empty data source columns</a></li>
|
||||
<li><a href="../ajax/custom_data_property.html">Use a data source other than aaData (the default)</a></li>
|
||||
<li><a href="../ajax/objects_subarrays.html">Read column data from sub-arrays</a></li>
|
||||
<li><a href="../ajax/deep.html">Read column data from deeply nested properties</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Plug-ins</h2>
|
||||
<ul>
|
||||
<li><a href="../plug-ins/plugin_api.html">Add custom API functions</a></li>
|
||||
<li><a href="../plug-ins/sorting_plugin.html">Sorting and automatic type detection</a></li>
|
||||
<li><a href="../plug-ins/sorting_sType.html">Sorting without automatic type detection</a></li>
|
||||
<li><a href="../plug-ins/paging_plugin.html">Custom pagination controls</a></li>
|
||||
<li><a href="../plug-ins/range_filtering.html">Range filtering / custom filtering</a></li>
|
||||
<li><a href="../plug-ins/dom_sort.html">Live DOM sorting</a></li>
|
||||
<li><a href="../plug-ins/html_sort.html">Automatic HTML type detection</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="footer" class="clear" style="text-align:center;">
|
||||
<p>
|
||||
Please refer to the <a href="http://www.datatables.net/usage">DataTables documentation</a> for full information about its API properties and methods.<br>
|
||||
Additionally, there are a wide range of <a href="http://www.datatables.net/extras">extras</a> and <a href="http://www.datatables.net/plug-ins">plug-ins</a> which extend the capabilities of DataTables.
|
||||
</p>
|
||||
|
||||
<span style="font-size:10px;">
|
||||
DataTables designed and created by <a href="http://www.sprymedia.co.uk">Allan Jardine</a> © 2007-2011<br>
|
||||
DataTables is dual licensed under the <a href="http://www.datatables.net/license_gpl2">GPL v2 license</a> or a <a href="http://www.datatables.net/license_bsd">BSD (3-point) license</a>.
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -100,8 +100,16 @@ function _fnColumnOptions( oSettings, iCol, oOptions )
|
||||
}
|
||||
|
||||
/* Cache the data get and set functions for speed */
|
||||
var mDataSrc = oCol.mData;
|
||||
var mData = _fnGetObjectDataFn( mDataSrc );
|
||||
var mRender = oCol.mRender ? _fnGetObjectDataFn( oCol.mRender ) : null;
|
||||
var mData = _fnGetObjectDataFn( oCol.mData );
|
||||
|
||||
var attrTest = function( src ) {
|
||||
return typeof src === 'string' && src.indexOf('@') !== -1;
|
||||
};
|
||||
oCol._bAttrSrc = $.isPlainObject( mDataSrc ) && (
|
||||
attrTest(mDataSrc.sort) || attrTest(mDataSrc.type) || attrTest(mDataSrc.filter)
|
||||
);
|
||||
|
||||
oCol.fnGetData = function (oData, sSpecific) {
|
||||
var innerData = mData( oData, sSpecific );
|
||||
@ -112,7 +120,7 @@ function _fnColumnOptions( oSettings, iCol, oOptions )
|
||||
}
|
||||
return innerData;
|
||||
};
|
||||
oCol.fnSetData = _fnSetObjectDataFn( oCol.mData );
|
||||
oCol.fnSetData = _fnSetObjectDataFn( mDataSrc );
|
||||
|
||||
/* Feature sorting overrides column specific when off */
|
||||
if ( !oSettings.oFeatures.bSort )
|
||||
|
||||
@ -71,12 +71,12 @@ function _fnAddData ( oSettings, aDataIn, nTr, anTds )
|
||||
* use this for reading data from a DOM sourced table, but it could be
|
||||
* used for an TR element. Note that if a TR is given, it is used (i.e.
|
||||
* it is not cloned).
|
||||
* @param {object} oSettings dataTables settings object
|
||||
* @param {object} settings dataTables settings object
|
||||
* @param {array|node|jQuery} trs The TR element(s) to add to the table
|
||||
* @returns {array} Array of indexes for the added rows
|
||||
* @memberof DataTable#oApi
|
||||
*/
|
||||
function _fnAddTr( oSettings, trs )
|
||||
function _fnAddTr( settings, trs )
|
||||
{
|
||||
var row;
|
||||
|
||||
@ -86,8 +86,8 @@ function _fnAddTr( oSettings, trs )
|
||||
}
|
||||
|
||||
return trs.map( function (i, el) {
|
||||
row = _fnGetRowElements( el );
|
||||
return _fnAddData( oSettings, row.data, el, row.cells );
|
||||
row = _fnGetRowElements( settings, el );
|
||||
return _fnAddData( settings, row.data, el, row.cells );
|
||||
} );
|
||||
}
|
||||
|
||||
@ -520,7 +520,7 @@ function _fnInvalidateRow( settings, rowIdx, src )
|
||||
// Are we reading last data from DOM or the data object?
|
||||
if ( src === 'dom' || (! src && row.src === 'dom') ) {
|
||||
// Read the data from the DOM
|
||||
row._aData = _fnGetRowData( row.nTr ).data;
|
||||
row._aData = _fnGetRowElements( settings, row.nTr ).data;
|
||||
}
|
||||
else {
|
||||
// Reading from data object, update the DOM
|
||||
@ -540,6 +540,7 @@ function _fnInvalidateRow( settings, rowIdx, src )
|
||||
* Build a data source object from an HTML row, reading the contents of the
|
||||
* cells that are in the row.
|
||||
*
|
||||
* @param {object} settings DataTables settings object
|
||||
* @param {node} TR element from which to read data
|
||||
* @returns {object} Object with two parameters: `data` the data read, in
|
||||
* document order, and `cells` and array of nodes (they can be useful to the
|
||||
@ -547,20 +548,47 @@ function _fnInvalidateRow( settings, rowIdx, src )
|
||||
* them from here).
|
||||
* @memberof DataTable#oApi
|
||||
*/
|
||||
function _fnGetRowElements( row )
|
||||
function _fnGetRowElements( settings, row )
|
||||
{
|
||||
var
|
||||
d = [],
|
||||
tds = [],
|
||||
td = row.firstChild,
|
||||
name;
|
||||
name, col, o, i=0, contents,
|
||||
columns = settings.aoColumns;
|
||||
|
||||
var attr = function ( str, data, td ) {
|
||||
var idx = str.indexOf('@');
|
||||
if ( typeof str === 'string' && idx !== -1 ) {
|
||||
var src = str.substring( idx+1 );
|
||||
o[ '@'+src ] = td.getAttribute( src );
|
||||
}
|
||||
};
|
||||
|
||||
while ( td ) {
|
||||
name = td.nodeName.toUpperCase();
|
||||
|
||||
if ( name == "TD" || name == "TH" ) {
|
||||
d.push( $.trim(td.innerHTML) );
|
||||
col = columns[i];
|
||||
contents = $.trim(td.innerHTML);
|
||||
|
||||
if ( col._bAttrSrc ) {
|
||||
o = {
|
||||
display: contents
|
||||
};
|
||||
|
||||
attr( col.mData.sort, o, td );
|
||||
attr( col.mData.type, o, td );
|
||||
attr( col.mData.filter, o, td );
|
||||
|
||||
d.push( o );
|
||||
}
|
||||
else {
|
||||
d.push( contents );
|
||||
}
|
||||
|
||||
tds.push( td );
|
||||
i++;
|
||||
}
|
||||
|
||||
td = td.nextSibling;
|
||||
|
||||
@ -62,6 +62,15 @@ DataTable.models.oColumn = {
|
||||
*/
|
||||
"_bAutoType": true,
|
||||
|
||||
/**
|
||||
* Flag to indicate if HTML5 data attributes should be used as the data
|
||||
* source for filtering or sorting. True is either are.
|
||||
* @type boolean
|
||||
* @default false
|
||||
* @private
|
||||
*/
|
||||
"_bAttrSrc": false,
|
||||
|
||||
/**
|
||||
* Developer definable function that is called whenever a cell is created (Ajax source,
|
||||
* etc) or processed for input (DOM source). This can be used as a compliment to mRender
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user