@tiledb-inc/bioimage-viewer
v0.1.7
Published
A bioimage viewer for TileDB groups
Downloads
487
Readme
@tiledb-inc/bioimage-viewer
A bioimage viewer for TileDB groups
Installing
npm install --save @tiledb-inc/bioimage-viewer
Quick Start
import createViewer from "@tiledb-inc/bioimage-viewer";
createViewer({
rootElement: "bioimage-container", // The id of the element the BioImage-Viewer will render
apiKey: `<API_KEY>`,
groupID: `<GROUP_ID>`,
namespace: '<NAMESPACE>'
});
Theming
Bioimage viewer supports dark/light theme. Just add data-theme="{VALUE}"
(possible values: dark & light) attribute in the rootElement that the viewer is going to be rendered.
Development
nvm use
to select correct version of node.
npm install
to install dependencies
npm run build
to build the library
npm run test
to run all tests
npm run lint
to check for any linting errors
npm run lint:fix
to automatically fix linting errors