Get the DataTables cached data for the selected rows.
DataTables caches data for searching and ordering in order for those operations to run as quickly as possible when they are required. Sometimes it can be useful to get the data that DataTables has cached for these operations (usually more usefully as column data using
columns().cache() than on a per-row basis, but this method is included for completeness).
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
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
columns.render for further information. If you don't want the cached data,
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.
Please note that the order of the data in the returned array and which rows the data is obtained from (searched rows, visible rows etc) is controlled by the
selector-modifier option of the
rows() selector used to get the selected rows.
Note that this method is primarily aimed at plug-in developers who require access to the internal data that DataTables has stored.
function rows().cache( [ type ] )
Obtain the data for the columns rows the selector
Name Type Optional 1
Yes - default:order
Specify which cache the data should be read from. Can take one of two values:
order. Defaults to
orderif no value is given.
DataTables API instance with data for each cell in the selected columns in the result set. This is a 2D array with the top level array entries for each row matched by the
columns()selector and the inner arrays representing the cached data for each column (by column data index).
The following options are directly related and may also be useful in your application development.