This example shows how the ajax
initialisation option can be used to replace the default Ajax call that Editor makes and instead use the browser's localStorage abilities to save the
state of the table locally on the browser. This means that the user effectively has persistent storage, but it is available only to them on their current
browser.
The code in this example shows the ajax option as a function that implements everything that is required by
Editor for data storage and retrieval. The 'create', 'edit' and 'remove' actions are each handled by storing the submitted data in a local variable, which is
then stored in local storage for data persistence.
Note that this example fully supports Editor's multi-row editing capability as it fully implements the client / server data interchange format Editor uses.
Although this particular use case is fairly limited, it does show how Editor's ajax option can be used to intercept and manage the data requests that Editor makes. Expanding on this almost any
data storage system could be used from Firebase to WebSockets.
The Javascript shown below is used to initialise the table shown in this example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | var editor; // use a global for the submit and return data rendering in the examples$(document).ready(function() { // Object that will contain the local state var todo = {}; // Create or update the todo localStorage entry if ( localStorage.getItem('todo') ) { todo = JSON.parse( localStorage.getItem('todo') ); } // Set up the editor editor = new $.fn.dataTable.Editor( { table: "#example", fields: [ { label: "Item:", name: "item" }, { label: "Status:", name: "status", type: "radio", def: "To do", options: [ 'To do', 'Done' ] } ], ajax: function ( method, url, d, successCallback, errorCallback ) { var output = { data: [] }; if ( d.action === 'create' ) { // Create new row(s), using the current time and loop index as // the row id var dateKey = +new Date(); $.each( d.data, function (key, value) { var id = dateKey+''+key; value.DT_RowId = id; todo[ id ] = value; output.data.push( value ); } ); } else if ( d.action === 'edit' ) { // Update each edited item with the data submitted $.each( d.data, function (id, value) { value.DT_RowId = id; $.extend( todo[ id ], value ); output.data.push( todo[ id ] ); } ); } else if ( d.action === 'remove' ) { // Remove items from the object $.each( d.data, function (id) { delete todo[ id ]; } ); } // Store the latest `todo` object for next reload localStorage.setItem( 'todo', JSON.stringify(todo) ); // Show Editor what has changed successCallback( output ); } } ); // Initialise the DataTable $('#example').DataTable( { dom: "Bfrtip", data: $.map( todo, function (value, key) { return value; } ), columns: [ { data: "item" }, { data: "status" } ], select: true, buttons: [ { extend: "create", editor: editor }, { extend: "edit", editor: editor }, { extend: "remove", editor: editor } ] } );} ); |
In addition to the above code, the following Javascript library files are loaded for use in this example:
Editor submits and retrieves information by Ajax requests. The two blocks below show the data that Editor submits and receives, to and from the server. This is updated live as you interact with Editor so you can see what is submitted.
The following shows the data that has been submitted to the server when a request is made to add, edit or delete data from the table.
// No data yet submittedThe following shows the data that has been returned by the server in response to the data submitted on the left and is then acted upon.
// No data yet received