ajax599,Ajax
Ajax
Data for a DataTable can essentially come from three different locations:
The HTML - ideal for when your table already exists and has been populated with data.
A Javascript array - used when your data exists in a Javascript array
An Ajax data source
This section of the manual looks at how to use the last option here as it is can be particularly convenient to load your data Ajax - for example via a data HTTP API feed or simply to separate your table data logic from your HTML.
Add added advantage of using Ajax loaded data is that you can enable DataTables' deferRender option to give a performance boost - this option, when enabled, will result in DOM elements being created only when they need to be drawn on the page, reducing the initial CPU load when the data is first inserted into the table.
Loading data
Ajax data is loaded by DataTables simply by using the ajax option to set the URL for where the Ajax request should be made. For example, the following shows a minimal configuration with Ajax sourced data:
$('#myTable').DataTable( {
ajax: '/api/myData'
} );
JSON data source
When considering Ajax loaded data for DataTables we almost always are referring to a JSON payload - i.e. the data that is returned from the server is in a JSON data structure. This is because the JSON is derived from Javascript and it therefore naturally plays well with Javascript libraries such as DataTables. It is also a compact and easily understood data format which has proven to be very popular in the Javascript world.
It is possible to use other data formats such as XML and YAML with DataTables, although these formats need to be converted to Javascript object notation (i.e. JSON) before they are using - this is typically done in using ajax.dataSrc. The remainder of this document will consider only JSON.
With our JSON data source we need two key pieces of information:
Where the array of data that represents the rows of data in the table is in the object
Where the data point for each column is in the row object / array.
Data array location
DataTables requires an array of items to represent the table's data, where each item in the array is a row. The item is typically an object or an array (discussed in more detail below) - so the first thing we need to do is tell DataTables where that array is in the data source.
Consider, for example, the following three JSON data objects shown on the left below, as you will be able to see each of the three structures contain the same data for the array of data to be displayed in the table, but the location of that array if different in each. Each is perfectly valid and can be used in different circumstances - there is no single "correct way"!
The ajax.dataSrc (i.e. data source) option is used to tell DataTables where the data array is in the JSON structure. ajax.dataSrc is typically given as a string indicating that location in Javascript object notation - i.e. simply set it to be the name of the property where the array is! An empty string is a special case which tells DataTables to expect an array (as in the first example above).
The three data structures are each shown with their corresponding DataTables initialisations.
1) Simple array of data:
[
{
"name": "Tiger Nixon",
"position": "System Architect",
"salary": "$320,800",
"start_date": "2011/04/25",
"office": "Edinburgh",
"extn": "5421"
},
...
}
$('#myTable').DataTable( {
ajax: {
url: '/api/myData',
dataSrc: ''
},
columns: [ ... ]
} );
2) Object with data property - note that the data parameter format shown here can be used with a simplified DataTables initialisation as data is the default property that DataTables looks for in the source data object.
{
"data": [
{
"name": "Tiger Nixon",
"position": "System Architect",
"salary": "$320,800",
"start_date": "2011/04/25",
"office": "Edinburgh",
"extn": "5421"
},
...
]
}
$('#myTable').DataTable( {
ajax: '/api/myData',
columns: [ ... ]
} );
// or!
$('#myTable').DataTable( {
ajax: {
url: '/api/myData',
dataSrc: 'data'
},
columns: [ ... ]
} );
3) Object with staff property:
{
"staff": [
{
"name": "Tiger Nixon",
"position": "System Architect",
"salary": "$320,800",
"start_date": "2011/04/25",
"office": "Edinburgh",
"extn": "5421"
},
...
]
}
$('#myTable').DataTable( {
ajax: {
url: '/api/myData',
dataSrc: 'staff'
},
columns: [ ... ]
} );
Column data points
Now that DataTables knows where to get the data for the rows, we need to also tell it where to get the data for each cell in that row - this is done through the columns.data option.
Let's consider again three different data formats, again shown on the left below - only a single row of data is shown in each case (i.e. it is not wrapped in a structure as discussed above for brevity).
As you will be able to see, in each of the three cases, the same data is available for the row, but the structure of the JSON data is different. We use the columns.data property to tell DataTables where to get the data for each column.
Like the ajax.dataSrc option discussed above, columns.data is typically given as a string that represents the location of the data required in Javascript dotted object notation. It can also be given in other forms such as an index for accessing an array.
The corresponding initialisation of DataTables for the three data structures is shown on the right.
1) Array of data - note that the array option does not require the columns.data option to be set. This is because the default value for columns.data is the column index (i.e. 0, 1, 2...):
[
"Tiger Nixon",
"System Architect",
"$320,800",
"2011/04/25",
"Edinburgh",
"5421"
]
$('#myTable').DataTable( {
ajax: ...
} );
// or!
$('#myTable').DataTable( {
ajax: ...,
columns: [
{ data: 0 },
{ data: 1 },
{ data: 2 },
{ data: 3 },
{ data: 4 },
{ data: 5 }
]
} );
2) Object of data:
{
"name": "Tiger Nixon",
"position": "System Architect",
"salary": "$320,800",
"start_date": "2011/04/25",
"office": "Edinburgh",
"extn": "5421"
}
$('#myTable').DataTable( {
ajax: ...,
columns: [
{ data: 'name' },
{ data: 'position' },
{ data: 'salary' },
{ data: 'state_date' },
{ data: 'office' },
{ data: 'extn' }
]
} );
3) Nested objects - in this case note that in the nested objects we use dotted object notation such as hr.position to access nested data. With this ability almost any JSON data structure can be used with DataTables:
{
"name": "Tiger Nixon",
"hr": {
"position": "System Architect",
"salary": "$320,800",
"start_date": "2011/04/25"
},
"contact": {
"office": "Edinburgh",
"extn": "5421"
}
}
$('#myTable').DataTable( {
ajax: ...,
columns: [
{ data: 'name' },
{ data: 'hr.position' },
{ data: 'hr.salary' },
{ data: 'hr.state_date' },
{ data: 'contact.office' },
{ data: 'contact.extn' }
]
} );
Optional parameters
In addition to the row's data, DataTables can use the following optional parameters on each individual row's data source object to perform automatic actions for you:
Parameter name
Type
Description
DT_RowId
Set the ID property of the tr node to this value
DT_RowClass
Add this class to the tr node
DT_RowData
Add the data contained in the object to the row using the jQuery data() method to set the data, which can also then be used for later retrieval (for example on a click event).
DT_RowAttr
Add the data contained in the object to the row tr node as attributes. The object keys are used as the attribute keys and the values as the corresponding attribute values. This is performed using using the jQuery param() method. Please note that this option requires DataTables 1.10.5 or newer.
Live examples
Ajax configuration
For completeness of our Ajax loading discussion, it is worth stating that at this time DataTables unfortunately does not support configuration via Ajax. This is something that will be reviewed in the future, however, JSON does not provide an option to represent Javascript functions which can be exceptionally useful in a DataTables configuration, therefore Ajax loaded configuration could not use all of the options DataTables makes available.