order.neutral()
Change ordering of the table to its data load order
- Author: Allan Jardine
- Requires: DataTables 1.10+
This function will restore the order in which data was read into a DataTable
(for example from an HTML source). Although you can set order()
to
be an empty array ([]
) in order to prevent sorting during initialisation,
it can sometimes be useful to restore the original order after sorting has
already occurred - which is exactly what this function does.
Please note that this plug-in can only be used for client-side processing
tables (i.e. without serverSide: true
).
Use
This plug-in can be obtained and used in multiple different ways.
Browser
This plug-in is available on the DataTables CDN:
The plug-in will then automatically register itself against a global DataTables instance. This file can also be used if you are using an AMD loader such as Require.js.
Note that if you are using multiple plug-ins, it can be beneficial in terms of performance to combine the plug-ins into a single file and host it on your own server, rather than making multiple requests to the DataTables CDN.
NPM
The plug-ins are all available on NPM (which can also be used with Yarn or any other Javascript package manager) as part of the datatables.net-plugins
package. To use this plug-in, first install the plug-ins package:
npm install datatables.net-plugins
ES modules
Then, if you are using ES modules, import datatables.net
, any other DataTables extensions you need, and the plug-in:
import DataTable from 'datatables.net';
import 'datatables.net-plugins/api/order.neutral().mjs';
CommonJS
If you are using a CommonJS loader for Node (e.g. with older versions of Webpack, or non-module Node code) use the following method to require
the plug-in:
var $ = require('jquery');
var DataTable = require('datatables.net');
require('datatables.net-plugins/api/order.neutral().js');
Example
// Return table to the loaded data order
table.order.neutral().draw();
Version control
If you have any ideas for how this plug-in can be improved, or spot anything that is in error, it is available on GitHub and pull requests are very welcome!
- This plug-in: order.neutral().js
- Full DataTables plug-ins repository: DataTables/Plugins