HyperFormula

An advanced headless evaluator and parser of the Excel formulas. Built on t...

README


HyperFormula - A headless spreadsheet, a parser and evaluator of Excel formulas

A headless spreadsheet • A parser and evaluator of Excel formulas

npm total downloads npm monthly downloads GitHub contributors Known Vulnerabilities
FOSSA Status Language grade: JavaScript GitHub Workflow Status codecov



HyperFormula is a headless spreadsheet built on top of TypeScript. It is a parser and evaluator of Excel formulas for web applications. You can use it in a browser or as a service, with Node.js as your back-end technology.
- High-speed Excel formula parsing and evaluating
- A library of nearly 400 built-in functions
- Support for internationalization with 17 built-in languages
- Support for custom functions
- Function syntax compatible with Microsoft Excel and Google Sheets
- Support for undo/redo
- Support for CRUD operations
- Support for clipboard
- Support for named expressions
- Support for data sorting
- Support for React, Angular, and Vue.js
- Open-source license
- Actively maintained by the team that stands behind Handsontable - JavaScript Data Grid

Documentation



Installation and usage


Install the library from npm:

  1. ``` sh
  2. npm install hyperformula
  3. ```

Once installed, you can use it like this:

  1. ``` js
  2. import { HyperFormula } from 'hyperformula';

  3. // define the options
  4. const options = {
  5.   licenseKey: 'gpl-v3',
  6. };

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

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

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

  13. // print the result in the browser's console
  14. console.log(mySum);
  15. ```


What can it be used for?


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

- Spreadsheets
- Business logic builders
- Forms and form builders
- Computation notebooks
- Smart documents
- Educational apps
- Online calculators

Contributing


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

License


HyperFormula is available under the open source license (GPLv3).

To buy a commercial license, please write to us at sales@handsontable.com

Copyrights

© 2022 Handsoncode