hyperformula

HyperFormula is an open source, spreadsheet-like calculation engine ⚡

Description

HyperFormula allows you to perform spreadsheet-like calculations in your web applications. It is written in TypeScript and supports all major JavaScript frameworks. You can use it in a browser or as a service with Node.js as your back-end technology.

The engine comes with a built-in, localized library of functions grouped into different categories, and covers most user-triggered actions such as CRUD operations, undo/redo, and clipboard operations. It also supports the use of cross-sheet references, named expressions, different data types, and custom functions.

Documentation

• Explainer video / Blog post
• Demos
  • JavaScript
  • React
  • Vue.js
  • Angular (coming soon)
• Installation
• Basic usage
• API Reference
• Configuration options
• List of built-in functions
• Key concepts
• Contact

Getting started

Install the library from npm:

npm install hyperformula

Once properly installed, you can use it like this:

import { HyperFormula } from 'hyperformula';

// define the options
const options = {
  licenseKey: 'agpl-v3',
  precisionRounding: 10
};

// define the data
const data = [['10', '20', '30' '=SUM(A1:C1)']];

// build an instance with defined options and data 
const hfInstance = HyperFormula.buildFromArray(data, options);

// call getCellValue to get the calculation results
const mySum = hfInstance.getCellValue({ col: 3, row: 0, sheet: 0 });

// print the result in the browser's console
console.log(mySum);

View this code online

What can it be used for?

HyperFormula doesn't assume any existing user interface, which makes it a great general-purpose library that can be used in various business applications. Here are some examples:

• Smart documents
• Educational apps
• Computation notebooks
• Data grid components
• Business logic builders
• Forms and form builders
• Spreadsheets
• Online calculators
• Low connectivity apps

Contributing

Help us to build the fastest and most flexible calculation engine for business web apps. Please read the Contributing Guide before making a pull request.

Your help is much appreciated in any of the following topics:

• Making pull requests
  • Adding new functions
  • Adding new features
  • Improving the quality of the existing code
  • Improving performance
  • Improving documentation and public API
• Reporting bugs
• Suggesting improvements
• Suggesting new features

License

HyperFormula is a triple-licensed software. You can use it under the open source AGPLv3 license, or a free license in all your non-commercial projects. There is also a commercial license, and support services available.

Authors

Created by Handsontable, NavAlgo, and Contributors.

© 2020 Handsoncode

Changelog

[0.1.0] - 2020-06-25

Added

• Core functionality of the engine;
• Support for data types: String, Error, Number, Date, Time, DateTime, Duration, Distinct Logical;
• Support for logical operators: =, <>, >, <, >=, <=;
• Support for arithmetic operators: +, -, *, /, %;
• Support for text operator: &;
• CRUD operations:
  • modifying the value of a single cell,
  • adding/deleting row/column,
  • reading the value or formula from the selected cell,
  • moving a cell or a block of cells,
  • deleting a subset of rows or columns,
  • recalculating and refreshing of a worksheet,
  • batching CRUD operations,
  • support for wildcards and regex inside criterion functions like SUMIF, COUNTIF,
  • named expressions support,
  • support for cut, copy, paste,
  • undo/redo support;
• Following functions: ABS(), ACOS(), AND(), ASIN(), ATAN(), ATAN2(), AVERAGE(), AVERAGEA(), AVERAGEIF(), BASE(), BIN2DEC(), BIN2HEX()BIN2OCT(), BITAND(), BITLSHIFT(), BITOR(), BITRSHIFT(), BITXOR(), CEILING(), CHAR(), CHOOSE(), CODE(), COLUMNS(), CONCATENATE(), CORREL(), COS(), COT(), COUNT(), COUNTA(), COUNTBLANK(), COUNTIF(), COUNTIFS(), COUNTUNIQUE(), DATE(), DAY(), DAYS(), DEC2BIN(), DEC2HEX(), DEC2OCT(), DECIMAL(), DEGREES(), DELTA(), E(), EOMONTH(), ERF(), ERFC(), EVEN(), EXP(), FALSE(), IF(), IFERROR(), IFNA(), INDEX(), INT(), ISBLANK(), ISERROR(), ISEVEN(), ISLOGICAL(), ISNONTEXT(), ISNUMBER(), ISODD(), ISTEXT(), LN(), LOG(), LOG10(), MATCH(), MAX(), MAXA(), MAXPOOL(), MEDIAN(), MEDIANPOOL(), MIN(), MINA(), MMULT(), MOD(), MONTH(), NOT(), ODD(), OFFSET(), OR(), PI(), POWER(), RADIANS() , RAND(), ROUND(), ROUNDDOWN(), ROUNDUP(), ROWS(), SIN(), SPLIT(), SQRT(), SUM(), SUMIF(), SUMIFS(), SUMPRODUCT(), SUMSQ(), SWITCH(), TAN(), TEXT(), TRANSPOSE(), TRUE(), TRUNC(), VLOOKUP(), XOR(), YEAR();
• Support for volatile functions;
• Cultures supports - can be configured according to the application need;
• Custom functions support;
• Set http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2-part2.html as a standard to follow;
• Error handling:
  • Division by zero: #DIV/0!,
  • Unknown function name: #NAME?,
  • Wrong type of argument in a function or wrong type of operator: #VALUE!,
  • Invalid numeric values: #NUM!,
  • No value available: #N/A,
  • Cyclic dependency: #CYCLE!,
  • Wrong address reference: #REF;
• Built-in function translation support for 16 languages: English, Czech, Danish, Dutch, Finnish, French, German, Hungarian, Italian, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Turkish.