JavaScript library for exploring large multivariate datasets in the browser. Based on CrossFilter
A full build of heavyai-crossfilter is available in the cloned/forked version of this repo. To build your own code changes, however, you can run
npm install
npm run buildUnlike the original Crossfilter, heavyai-crossfilter makes asynchronous network requests to retrieve data. As part of this process, heavyai-crossfilter forms SQL queries that are used to retrieved data which will then be rendered by heavyai-charting.
New components in HeavyAI Crossfilter should be unit-tested. All tests should be in the test directory.
+-- src
| +-- /modules/binning.js
+-- test
| +-- /binning.unit.spec.js
All tests run on
npm run testTo check only unit tests, run:
npm run test:unit| Command | Description |
|---|---|
npm run test |
Runs unit tests and provides coverage info |
npm run test:unit |
Runs unit tests |
npm run build |
Bundles crossfilter |
A full list of third-party npm packages and their licenses is maintained in third_party_licenses/THIRD_PARTY_LICENSES.md. To regenerate it after dependency changes, run:
npx github:heavyai/js-license-listThis requires node_modules to be installed (npm install). The script is maintained in the heavyai/js-license-list repo.
Every third-party module from npm that gets includes in the final, distributed bundle has its license verified and license text (if provided) or license type shipped in licenses.txt with the bundle. Licenses must be in the pre-approved list of permissive open-source licenses. If it's necessary to override a license for a module because it's missing or improperly tagged in its package.json, add an entry in license-overrides.json.
License descriptions and public license URLs are maintained in licenses.json as well, but they are not verified and might not be up to date.
Variables and function names are used as convention and do not reference any commercial product.
Warning
Do not report security vulnerabilities through public GitHub issues!
NVIDIA takes security seriously. If you discover a vulnerability in heavyai-crossfilter, DO NOT open a public issue. Use one of the private reporting channels described in SECURITY.md.
Join the HeavyAI GitHub Discussions to ask questions, share feedback, and report issues. HeavyAI maintainers review issues, discussions, and pull requests on a best effort basis without guaranteed response timelines.
Apache 2.0. See LICENSE.