Currency
Sort data numerically when it has a leading currency symbol.
- Author: Allan Jardine
- Deprecated: This plug-in has been deprecated and replaced with other functionality. Please see the detailed description below for more information.
This plug-in will provide numeric sorting for currency columns (either detected automatically with the currency type detection plug-in or set manually) while taking account of the currency symbol ($ or £ by default).
DataTables 1.10+ has currency sorting abilities built-in and will be automatically detected. As such this plug-in is marked as deprecated, but might be useful when working with old versions of DataTables.
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/sorting/currency.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/sorting/currency.js');
Example
$('#example').dataTable( {
columnDefs: [
{ type: 'currency', targets: 0 }
]
} );
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: currency.js
- Full DataTables plug-ins repository: DataTables/Plugins