# ChartGPU

> Open-source TypeScript WebGPU charting library for high-performance interactive charts in the browser. Install via `npm install @chartgpu/chartgpu`. Create charts with `ChartGPU.create(container, options)`.

MIT licensed. Requires WebGPU: Chrome/Edge 113+, Safari 18+; Firefox support depends on platform/flags. Feature-detect with `'gpu' in navigator`. Package: `@chartgpu/chartgpu`. Site: https://chartgpu.io. Source: https://github.com/ChartGPU/ChartGPU.

## Docs

- [Overview](https://chartgpu.io/docs/): Docs hub — interactive WebGPU chart guides
- [Getting started](https://chartgpu.io/docs/getting-started/): Install @chartgpu/chartgpu and create a chart with ChartGPU.create
- [WebGPU charts](https://chartgpu.io/docs/webgpu-charts/): When WebGPU charting helps vs Canvas 2D and SVG
- [Multi-chart dashboards](https://chartgpu.io/docs/streaming-dashboards/): Shared GPUDevice, appendData, maxPoints, live multi-chart boards
- [Charting with ChartGPU](https://chartgpu.io/docs/charting/): Series types, axes, themes, and interaction patterns
- [Annotations](https://chartgpu.io/docs/annotations/): Thresholds, event markers, regime bands, peaks, HUD text
- [Theming](https://chartgpu.io/docs/theming/): Dark/light presets, ThemeConfig, palette overrides
- [Performance](https://chartgpu.io/docs/performance/): Million-point rendering, sampling, streaming FIFO, GPU sharing

## API reference

- [API hub](https://chartgpu.io/docs/api/): Public API index — create, options, streaming, themes, 3D
- [Chart API](https://chartgpu.io/docs/api/chart/): ChartGPU.create, instance methods, shared GPUDevice, pipeline cache, connectCharts
- [Options & series](https://chartgpu.io/docs/api/options/): ChartGPUOptions, series configs (line, area, scatter, heatmap, candlestick, band, errorBar, impulse, …), axes, dataZoom, tooltip
- [Streaming API](https://chartgpu.io/docs/api/streaming/): appendData, maxPoints FIFO, autoScroll, updateHeatmap, updateSurface3D
- [Interaction](https://chartgpu.io/docs/api/interaction/): Events (click, hover, crosshair, zoom, dataAppend), hit-test, zoom/pan
- [Annotations API](https://chartgpu.io/docs/api/annotations/): AnnotationConfig types, createAnnotationAuthoring
- [Themes](https://chartgpu.io/docs/api/themes/): ThemeConfig, dark/light presets, palette precedence
- [3D charts](https://chartgpu.io/docs/api/3d/): cartesian3d, pointCloud3d, surface3d, camera, axes3d
- [Scales](https://chartgpu.io/docs/api/scales/): createLinearScale, createLogScale, createCategoryScale
- [Troubleshooting](https://chartgpu.io/docs/api/troubleshooting/): WebGPU errors, sizing, cleanup

## Series guides

- [Line & area](https://chartgpu.io/docs/series/line/): Line and area series with sampling, multi-series, and fills
- [Scatter & density](https://chartgpu.io/docs/series/scatter/): Scatter plots and GPU-binned density heatmaps
- [Candlestick & OHLC](https://chartgpu.io/docs/series/candlestick/): Candlestick and OHLC for market data
- [Heatmap / spectrogram](https://chartgpu.io/docs/series/heatmap/): Uniform heatmap and spectrogram for matrix and FFT data

## Featured demos

- [Home](https://chartgpu.io/): Product landing page
- [Examples index](https://chartgpu.io/examples/): Catalog of hosted demos
- [Streaming dashboard](https://chartgpu.io/streaming-dashboard/): Multi-chart live streaming dashboard
- [Million points](https://chartgpu.io/million-points/): Large line series performance demo
- [Candlestick streaming](https://chartgpu.io/candlestick-streaming/): Live OHLC / candlestick stream
- [Scatter density 1M](https://chartgpu.io/scatter-density-1m/): One million points with GPU density
- [Ultimate benchmark](https://chartgpu.io/ultimate-benchmark/): Stress-test benchmark suite
- [3D showcase](https://chartgpu.io/3d-showcase/): 3D chart showcase

## Project

- [GitHub](https://github.com/ChartGPU/ChartGPU): Source repository
- [npm](https://www.npmjs.com/package/@chartgpu/chartgpu): Package registry for @chartgpu/chartgpu

## Optional

- [Heatmap spectrogram demo](https://chartgpu.io/heatmap-spectrogram/): Heatmap / spectrogram example
- [Stacked mountain](https://chartgpu.io/stacked-mountain/): Stacked area / mountain series
- [Basic line](https://chartgpu.io/basic-line/): Minimal line chart example
- [Live streaming](https://chartgpu.io/live-streaming/): Single-chart live data stream
- [Step line](https://chartgpu.io/step-line/): Digital / step line series
- [Impulse](https://chartgpu.io/impulse/): Impulse / stem series
- [Error bars](https://chartgpu.io/error-bars/): Error bar series
- [Band range](https://chartgpu.io/band-range/): Band / range series