buttons.buttons.async

Indicate that a button's action processing should be performed asynchronously.
Please note - this property requires the Buttons extension for DataTables.

Description

For actions that take a noticeable amount of time, you might want to show a processing indicator for the button that triggered the action. Buttons can do that using the button().processing() method, but it requires a break in the Javascript execution in order to be able to display the processing indicator on the page.

This option provides exactly that option, specifying a number of milliseconds after the processing indicator is shown that the action should be executed.

When specified, you must call the callback function passed to the buttons.buttons.action function as the fifth parameter in order to indicate that the processing has completed (i.e. when your async action has finished). This removes the processing indicator from the button.

Type

Default

• Value: No default value (i.e. undefined)

Example

new DataTable('#myTable', {
	layout: {
		topEnd: {
			buttons: [
				{
					text: 'Make Ajax call',
					async: 100,
					action: function (e, dt, node, config, cb) {
						// Do custom async processing - e.g. an Ajax call
						new Promise(resolve => {
							// ...

							resolve();
							cb();
						});
					}
				}
			]
		}
	}
});