Newsworthy Presidential Mistakes
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

hyperformula

0.1.3 • Public • Published
HyperFormula

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

GitHub Workflow Status FOSSA Status Known Vulnerabilities GitHub contributors

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

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',
};
 
// 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 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

Install

npm i hyperformula

DownloadsWeekly Downloads

95

Version

0.1.3

License

SEE LICENSE IN LICENSE.txt

Unpacked Size

12.2 MB

Total Files

476

Last publish

Collaborators

  • avatar