@eclipsetrading/hypergrid
v4.32.0
Published
Canvas-based high-performance grid
Downloads
63
Readme
@eclipsetrading/hypergrid is an ultra-fast HTML5 grid presentation layer, achieving its speed by rendering (in a canvas tag) only the currently visible portion of your (virtual) grid, thus avoiding the latency and life-cycle issues of building, walking, and maintaining a complex DOM structure. Please be sure to checkout our design overview
Current Release
Forked as eclipsetrading-hypergrid
. With the aim of converting to TypeScript and updating to use ES6 classes over extend-me
.
Distribution
npm module (recommended)
Published as a CommonJS module to npm.
Specify a SEMVER of "fin-hypergrid": "3.3.2"
(or "^3.3.2"
) in your package.json file,
issue the npm install
command, and let your bundler (wepback,
Browserify) create a single file containing both Hypergrid and your application.
Build files
For small and informal examples and proofs-of-concept, load a pre-bundled build file (fin-hypergrid.js
or fin-hypergrid.min.js
) from the GitHub CDN. See the CDN index for links.
Your application can load one of these pre-bundled build files (in a <script>
tag), which creates the global namespace window.fin
(as needed) and populates it with window.fin.Hypergrid
.
As of v3.2.1, the same build files are also available in a umd
folder on npm for distribution via the unpkg CDN which processes SEMVER semantics when provided. For example, <script src="https://unpkg.com/fin-hypergrid@^3.2/umd/fin-hypergrid.min.js"></script>
loads v3.3.2 which is the greatest (most recent) version number matching the SEMVER pattern ^3.2
(aka 3..).
Testing
Please use github issues to report problems
We invite everyone to test the alpha branch for changes going into the next release
Find more information on our testing page
Developer Documentation
Primarily our tutorials will be on the wiki.
We also maintain versioned online API documentation for all public objects and modules. This documentation is necessarily an on-going work-in-progress.
(Cell editor information can be found here.)
(Cell Rendering information can be found here.)
Hypergrid global configurations can be found here.
Contributors
Developers interested in contributing to this project should review our contributing guide before making pull requests.