Installation

Package Manager

# npm
npm install velo-plot

# pnpm
pnpm add velo-plot

# yarn
yarn add velo-plot

Imports

ES Modules

// Core API
import { createChart } from 'velo-plot';

// Specialized Plugins 
import { PluginTools, PluginAnalysis, PluginAnnotations } from 'velo-plot';

// React components
import { SciPlot, useSciPlot } from 'velo-plot';

// Built-in Themes
import { MIDNIGHT_THEME, DARK_THEME, LIGHT_THEME } from 'velo-plot';

TypeScript Usage

Sci Plot is written in TypeScript and includes full type definitions.

import { 
  createChart, 
  type Chart, 
  type ChartOptions,
  type SeriesData 
} from 'velo-plot';

const options: ChartOptions = {
  container: document.getElementById('chart')!,
  xAxis: { label: 'Time (s)', auto: true },
  yAxis: { label: 'Voltage (mV)', auto: true },
};

const chart: Chart = createChart(options);

Peer Dependencies

For React usage, ensure you have React 16.8+ installed:

npm install react react-dom

Browser Support

• Chrome 80+
• Firefox 75+
• Safari 14+
• Edge 80+

WebGL 2.0 is required for hardware acceleration. Most modern browsers support this out of the box.

Next Steps

• Quick Start - Create your first interactive chart.
• Plugin System - Learn how to extend the chart with tools.
• Advanced Analysis - Deep dive into scientific features.