sum()

Sum the values in a data set.

• Author: Allan Jardine
• Requires: DataTables 1.10+

Fairly simply, this plug-in will take the data from an API result set and sum it, returning the summed value. The data can come from any data source, including column data, cells or rows.

Note that it will attempt to 'deformat' any string based data that is passed into it - i.e. it will strip any non-numeric characters in order to make a best effort attempt to sum all data types. This can be useful when working with formatting numbers such as currency. However the trade-off is that no error is thrown if non-numeric data is passed in. You should be aware of this in case unexpected values are returned - likely the input data is not what is expected.

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/sum().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/sum().js');

Examples

// Simply get the sum of a column
  var table = $('#example').DataTable();
  table.column( 3 ).data().sum();

// Insert the sum of a column into the columns footer, for the visible
  // data on each draw
  $('#example').DataTable( {
    drawCallback: function () {
      var api = this.api();
      $( api.table().footer() ).html(
        api.column( 4, {page:'current'} ).data().sum()
      );
    }
  } );

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: sum().js
• Full DataTables plug-ins repository: DataTables/Plugins