jkg-array-column-sum
TypeScript icon, indicating that this package has built-in type declarations

2.0.11 • Public • Published

getColumnSum

getColumnSum is an npm package for calculating the total sum of a column of numbers in an array of arrays, where each inner array represents a row of data. The package exports a single function getColumnSum that takes in four arguments:

  • lists: an array of arrays representing the data
  • index: an array of strings representing the column headers
  • isTypeArray (optional, default: true): a boolean indicating whether the result should be an array of strings or a single integer
  • decimalNumber (optional, default: 2): the number of decimal places to round the result to

Import the "getColumnSum" function into your component or service by adding the following code:

import getColumnSum from 'jkg-array-column-sum';

Live DEMO:

Call the "getColumnSum" function with a array, column names like ['column-name-1','column-name-2',...] & format type: to get total value, like this:

Test Cases for method:

    var data = [
        ['id','date','Amount'], 
        ['1','111','123'], 
        ['2','121','13']
    ];

    var result = getColumnSum(data,[],false) 
    // By default it will consider defined columns 'Amount','Additions','Subtractions'
    // Output > 136
    
    var result = getColumnSum(data,['Amount'],false)
    // Output > 136
    
    var result = getColumnSum(data,['Amount'],true)
    // Output > Array ["", "", "Total: 136.00"]

    var result = getColumnSum(data, ['date', 'Amount'], true);
    // Output > Array ["", "Total: 232.00", "Total: 136.00"]

    var result = getColumnSum(data,['Amounts'],false)
    // Output > 0

    var result = getColumnSum(data,['Amounts'],true)
    // Output > Array []

License

This package is licensed under the MIT License.

Package Sidebar

Install

npm i jkg-array-column-sum

Weekly Downloads

4

Version

2.0.11

License

MIT

Unpacked Size

3.42 kB

Total Files

4

Last publish

Collaborators

  • jksk21