-
-
Notifications
You must be signed in to change notification settings - Fork 440
Expand file tree
/
Copy pathinfo.xml
More file actions
35 lines (30 loc) · 1.47 KB
/
Copy pathinfo.xml
File metadata and controls
35 lines (30 loc) · 1.47 KB
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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-event>
<name>info</name>
<summary>Table info display is updated.</summary>
<since>2.0</since>
<type type="function">
<signature>function( e, settings, el, str )</signature>
<parameter type="object" name="e">
Event object
</parameter>
<parameter type="DataTable.Context" name="settings">
DataTables settings object
</parameter>
<parameter type="node" name="el">
The information object
</parameter>
<parameter type="string" name="str">
The text that DataTables wrote into the element
</parameter>
<scope>HTML table element</scope>
<bubbles>No</bubbles>
</type>
<description>
The `-event info` event is fired every table the table is drawn. It is used to display information about the table, such as the paging state (although other information could also be shown). Use the API to get details about the current paging state, if required for your information display (e.g. `-api page.info()` would be appropriate here).
Note that the `-event search` will be fired _after_ the information element has been written to by the built in display renderer. This means that writing to the info element will cause your own output to be displayed, rather than the DataTables created text.
Please note that, as with all DataTables emitted events, the event object has a DataTables API instance available on it in the `dt` property.
</description>
<related>-init info</related>
<related>-api page.info()</related>
</dt-event>