Usage from JavaScript

Vanilla JavaScript

npm install @pluot/core

Not yet published to NPM

For now, the package is only available from GitHub; we have only reserved the package names on NPM.

React component

The @pluot/react NPM package provides the <Pluot /> React component.

npm install @pluot/react

Props

• width
• height
• plotId
• plotType
• storeName
• plotParams
• mode = "2d"
• marginBottom = 0.0
• marginLeft = 0.0
• marginTop = 0.0
• marginRight = 0.0
• aspectRatioMode = "contain" // "ignore", "contain", "cover"
• format = "vector" // "vector", "raster"

Example

import React from 'react';
import { Pluot } from '@pluot/react';
import { FetchStore } from 'zarrita';

const store = new FetchStore('https://example.com/my_dataset.zarr');

export function MyPlot(props) {
    return (
        <Pluot
            width={500}
            height={500}
            plotId={"docs-example-scatterplot"}
            plotType={"LayeredPlot"}
            store={store}
            plotParams={{
                x_key: "/n_1000000/x_coords",
                y_key: "/n_1000000/y_coords",
                color_key: "/n_1000000/class_labels",
                point_radius: 5.0,
            }}
            mode={"2d"}
        />
    );
}