mirror of
https://github.com/DataTables/DataTables.git
synced 2025-01-18 11:52:11 +01:00
Update - docs: Add examples for the xhr
event and clarify when it fires
- `xhr` event fires before DataTables processes the returned data, so you can listen for `xhr` and use it to manipulate the returned data.
This commit is contained in:
parent
f35801b111
commit
d740f0484d
27
media/js/jquery.dataTables.js
vendored
27
media/js/jquery.dataTables.js
vendored
@ -11930,15 +11930,34 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Ajax (XHR) event, fired whenever an Ajax request is completed from a request to
|
* Ajax (XHR) event, fired whenever an Ajax request is completed from a
|
||||||
* made to the server for new data (note that this trigger is called in fnServerData,
|
* request to made to the server for new data. This event is called before
|
||||||
* if you override fnServerData and which to use this event, you need to trigger it in
|
* DataTables processed the returned data, so it can also be used to pre-
|
||||||
* you success function).
|
* process the data returned from the server, if needed.
|
||||||
|
*
|
||||||
|
* Note that this trigger is called in `fnServerData`, if you override
|
||||||
|
* `fnServerData` and which to use this event, you need to trigger it in you
|
||||||
|
* success function.
|
||||||
* @name DataTable#xhr
|
* @name DataTable#xhr
|
||||||
* @event
|
* @event
|
||||||
* @param {event} e jQuery event object
|
* @param {event} e jQuery event object
|
||||||
* @param {object} o DataTables settings object {@link DataTable.models.oSettings}
|
* @param {object} o DataTables settings object {@link DataTable.models.oSettings}
|
||||||
* @param {object} json JSON returned from the server
|
* @param {object} json JSON returned from the server
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Use a custom property returned from the server in another DOM element
|
||||||
|
* $('#table').dataTable().on('xhr', function (settings, json) {
|
||||||
|
* $('#status').html( json.status );
|
||||||
|
* } );
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Pre-process the data returned from the server
|
||||||
|
* $('#table').dataTable().on('xhr', function (settings, json) {
|
||||||
|
* for ( var i=0, ien=json.aaData.length ; i<ien ; i++ ) {
|
||||||
|
* json.aaData[i].sum = json.aaData[i].one + json.aaData[i].two;
|
||||||
|
* }
|
||||||
|
* // Note no return - manipulate the data directly in the JSON object.
|
||||||
|
* } );
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -262,15 +262,34 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Ajax (XHR) event, fired whenever an Ajax request is completed from a request to
|
* Ajax (XHR) event, fired whenever an Ajax request is completed from a
|
||||||
* made to the server for new data (note that this trigger is called in fnServerData,
|
* request to made to the server for new data. This event is called before
|
||||||
* if you override fnServerData and which to use this event, you need to trigger it in
|
* DataTables processed the returned data, so it can also be used to pre-
|
||||||
* you success function).
|
* process the data returned from the server, if needed.
|
||||||
|
*
|
||||||
|
* Note that this trigger is called in `fnServerData`, if you override
|
||||||
|
* `fnServerData` and which to use this event, you need to trigger it in you
|
||||||
|
* success function.
|
||||||
* @name DataTable#xhr
|
* @name DataTable#xhr
|
||||||
* @event
|
* @event
|
||||||
* @param {event} e jQuery event object
|
* @param {event} e jQuery event object
|
||||||
* @param {object} o DataTables settings object {@link DataTable.models.oSettings}
|
* @param {object} o DataTables settings object {@link DataTable.models.oSettings}
|
||||||
* @param {object} json JSON returned from the server
|
* @param {object} json JSON returned from the server
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Use a custom property returned from the server in another DOM element
|
||||||
|
* $('#table').dataTable().on('xhr', function (settings, json) {
|
||||||
|
* $('#status').html( json.status );
|
||||||
|
* } );
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Pre-process the data returned from the server
|
||||||
|
* $('#table').dataTable().on('xhr', function (settings, json) {
|
||||||
|
* for ( var i=0, ien=json.aaData.length ; i<ien ; i++ ) {
|
||||||
|
* json.aaData[i].sum = json.aaData[i].one + json.aaData[i].two;
|
||||||
|
* }
|
||||||
|
* // Note no return - manipulate the data directly in the JSON object.
|
||||||
|
* } );
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
Loading…
x
Reference in New Issue
Block a user