/hyperformula

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

Primary LanguageTypeScriptOtherNOASSERTION


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

A headless spreadsheet • A parser and evaluator of Excel formulas

GitHub Workflow Status FOSSA Status Language grade: JavaScript Known Vulnerabilities GitHub contributors 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.

Documentation

Installation and usage

Install the library from npm:

npm install hyperformula

Once installed, you can use it like this:

import { HyperFormula } from 'hyperformula';

// define the options
const options = {
  licenseKey: 'gpl-v3',
};

// 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);

Run this code in CodeSandbox

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