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
|
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="rows">
<name>row().cache()</name>
<summary>Get the DataTables cached data for the selected row.</summary>
<since>1.10</since>
<type type="function">
<signature>row().cache( [ type ] )</signature>
<description>Obtain the data for the row from the selector</description>
<parameter type="string" name="type" default="order">
Specify which cache the data should be read from. Can take one of two values: `dt-string search` or `dt-string order`. Defaults to `order` if no value is given.
</parameter>
<returns type="DataTables.Api">DataTables API instance with data for each cell in the selected row in the result set. This is a 1D array with each entry being the data for the cells from the selected row.</returns>
</type>
<description>
DataTables caches data for searching and ordering in order for those operations to run as quickly as possible when they are required.
Cached data is not guaranteed to be available at any particular moment. If DataTables hasn't requested the data, it won't have been cached. This is particularly obvious when using the `-string order` option and a sort hasn't been performed on a column. Invalidation of data will also cause the cache to be removed.
It should be noted that this method is required as DataTables has the ability to use different data for its different operations (searching, ordering, display etc) - see `dt-init columns.data` and `dt-init columns.render` for further information. If you don't want the cached data, `dt-api rows().data()` provides access to the original data array / object given to, or created by DataTables. If you aren't using orthogonal data for the different operations of DataTables, then this method is of limited used.
Note that this method is primarily aimed at plug-in developers who require access to the internal data that DataTables has stored.
</description>
<related type="api">rows().cache()</related>
</dt-api>
|
