JavaScript API

The JavaScript API docs are intended for web developers who would like to integrate Vitessce into other web applications.

Vitessce can be integrated into React web applications as a React component.

Installation

Installation requires NodeJS and NPM. Vitessce has been tested with NodeJS 14, and should work with versions 12, 14, and 16.

To install Vitessce from NPM, go to your project folder in the terminal, and run:

npm install --save vitessce

note

NodeJS 14 may require the max_old_space_size option to be increased:

export NODE_OPTIONS=--max_old_space_size=4096