@h5web/lib
Advanced tools
Readme
H5Web is a collection of React components to visualize and explore data. It consists of two main packages:
@h5web/lib: visualization
components built with
react-three-fiber (this
library).@h5web/app: a stand-alone,
web-based viewer to explore HDF5 files.While used in @h5web/app with HDF5 files, @h5web/lib visualization
components are not tied to HDF5 and can be used to visualize data from any
source.
For more information, visit the Storybook documentation site.
The react and react-dom dependencies must be installed in your project. Note
that as of version 10, @h5web/lib requires React 18.
This package supports TypeScript out of the box without the need to install a
separate @types/ package.
npm install @h5web/lib three @react-three/fiber ndarray
import '@h5web/lib/dist/styles.css';
import React from 'react';
import ndarray from 'ndarray';
import { HeatmapVis, getDomain } from '@h5web/lib';
// Initialise source 2D array
const values = [
[0, 1, 2],
[3, 4, 5],
];
// Flatten source array
const flatValues: number[] = values.flat(Infinity);
// Convert to ndarray and get domain
const dataArray = ndarray(flatValues, [2, 3]);
const domain = getDomain(dataArray);
function MyApp() {
return (
<div style={{ display: 'flex', height: '30rem' }}>
<HeatmapVis dataArray={dataArray} domain={domain} />
</div>
);
}
export default MyApp;
If your bundler supports it (e.g. webpack 5), you may be able to shorten the stylesheet import path as follows:
import '@h5web/lib/styles.css';
The following code sandboxes demonstrate how to set up and use @h5web/lib with
various front-end development stacks:
H5Web works out of the box on Firefox 78 ESR.
Support for Firefox 68 ESR is possible by polyfilling the ResizeObserver API.
One easy way to do this is with polyfill.io:
<head>
<!-- title, meta, link, etc. -->
<script src="https://polyfill.io/v3/polyfill.min.js?features=default%2CResizeObserver"></script>
</head>
Older versions of Firefox are not supported.
FAQs
Data visualization toolkit
The npm package @h5web/lib receives a total of 1,575 weekly downloads. As such, @h5web/lib popularity was classified as popular.
We found that @h5web/lib demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.