File: processing.xml

package info (click to toggle)
datatables.js 1.10.21%2Bdfsg-2%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 22,604 kB
  • sloc: javascript: 64,254; xml: 10,441; php: 4,623; sh: 523; makefile: 21
file content (39 lines) | stat: -rw-r--r-- 1,801 bytes parent folder | download | duplicates (4)
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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-event>
	<name>processing</name>
	<summary>Processing event - fired when DataTables is processing data</summary>
	<since>1.10</since>

	<type type="function">
		<signature>function( e, settings, processing )</signature>
		<parameter type="object" name="e">
			jQuery event object
		</parameter>
		<parameter type="DataTables.Settings" name="settings">
			DataTables settings object
		</parameter>
		<parameter type="boolean" name="processing">
			Processing flag: `true` when processing, `false` otherwise.
		</parameter>
		<scope>HTML table element</scope>
	</type>

	<description>
		This event is fired when DataTables is doing some kind of processing - be it, sorting, filtering or any other kind of data processing. It can be used to indicate to the end user that there is something happening, or that something has finished.

		Note that this event is used by DataTables' `dt-init processing` display option, and can be useful if you want to replace the DataTables built-in processing indicator with a custom indicator - one which is used in other parts of your application for example.

		Please note that, as with all DataTables emitted events, this event is triggered with the `dt` namespace. As such, to listen for this event, you must also use the `dt` namespace by simply appending `.dt` to your event name, as shown in the example below.
	</description>

	<example title="Show / hide notification of table processing (where `#example` is the DataTable)"><![CDATA[
$('#example')
	.on( 'processing.dt', function ( e, settings, processing ) {
		$('#processingIndicator').css( 'display', processing ? 'block' : 'none' );
	} )
	.dataTable();
]]></example>

	<related>-init processing</related>
	<related>-init language.processing</related>
</dt-event>