File: state.clear%28%29.xml

package info (click to toggle)
datatables.js 1.11.5%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 22,848 kB
  • sloc: javascript: 65,075; xml: 10,712; php: 4,741; sh: 544; makefile: 18
file content (40 lines) | stat: -rw-r--r-- 1,683 bytes parent folder | download | duplicates (6)
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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="core">
	<name>state.clear()</name>
	<summary>Clear the saved state of the table.</summary>
	<since>1.10.1</since>

	<type type="function">
		<signature>state.clear()</signature>
		<description>Clear the saved state of the table</description>
		<returns type="DataTables.Api">The API instance that was used, available for chaining.</returns>
	</type>

	<description>
		This method provides the ability to destroy a DataTables saved state which can be useful during development, or potentially when logging a user out if you want to clear the saved state before the state expires (`dt-init stateDuration`).

		This method will trigger a DataTables state save but with an empty object (i.e. `{}`), effectively erasing any existing state data.

		Note that if DataTables saves state after this method is called, the state will be stored again (a draw is the most common method of triggering a state save).
	</description>

	<example title="Clear the table state and reload the page"><![CDATA[

table.state.clear();
window.location.reload();

]]></example>

	<related type="api">state()</related>
	<related type="api">state.loaded()</related>
	<related type="api">state.save()</related>
	<related type="option">stateSave</related>
	<related type="option">stateSaveCallback</related>
	<related type="option">stateLoadCallback</related>
	<related type="option">stateLoadParams</related>
	<related type="option">stateSaveParams</related>
	<related type="option">stateLoaded</related>
	<related type="event">stateLoaded</related>
	<related type="event">stateLoadParams</related>
	<related type="event">stateSaveParams</related>
</dt-api>