numString
Sorting for number value that is included anywhere in a regex.
- Author: Sandy Galloway
This plug in will sort only on the number value that is included anywhere in a Regex. This is useful for sorting data which requires some extra context to be included in the table.
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/numString.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/numString.js');
Examples
// This example shows a mixture of text and number values, with the number at the start of the expression.
// It is using regex and start and end of expression tags.
// It will match "5 examples completed." for example.
DataTable.numString(/^\d+ examples? completed.$/);
var table = $('#example').DataTable();
// This example shows a mixture of text and number values, with the number at the end of the expression.
// It is using regex and start and end of expression tags.
// It will match "Examples left: 67" for example.
DataTable.numString(/^Examples? left: \d+$/);
var table = $('#example').DataTable();
// This example shows a mixture of text and number values, with the number in the middle of the expression.
// It is using regex and no start and end of expression tags.
// It will match "Only 1 left." for example.
DataTable.numString(/Only \d+ left./);
var table = $('example').DataTable();
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: numString.js
- Full DataTables plug-ins repository: DataTables/Plugins