stateRestore.ajax

Ajax configuration for StateRestore.
Please note - this property requires the StateRestore extension for DataTables.

Description

StateRestore has the ability to use remote storage to save states, allowing a user to define a state on one computer, and then use it on another, when logged in with their account. State information is requested from and sent via Ajax to a specific path, given by this parameter.

The end point defined by this parameter will be used for loading, creating, editing and deletion actions. The specifics of the action that each request requires the server to perform is defined by the action data parameter. Please see the Ajax section of the StateRestore manual for full details of the data that is sent to the server.

Additionally, the server-side libraries for DataTables have full support for StateRestore's Ajax capabilities - please see the documentation for each at:

• Node.js
• .NET
• PHP
• Python

In the most simple case, this property should be set a string to define the Ajax end point. If you would like more control over the Ajax request, use it as an object with a url property set, and any of the other properties available through DataTable.AjaxOptions that you need.

Types

string

DataTable.AjaxOptions

Examples

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['stateCreate', 'statesList', 'pageLength']
		}
	},
	stateRestore: {
		ajax: '/states/myTable'
	}
});

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['stateCreate', 'statesList', 'pageLength']
		}
	},
	stateRestore: {
		ajax: {
			url: '/states/myTable',
			headers: {
				'x-csrftoken': TOKEN
			}
		}
	}
});