API

API reference

Public API for @chartgpu/chartgpu: create charts, configure series and options, stream data, themes, annotations, interaction, and 3D. Guides keep narrative and playgrounds; these pages are the lookup surface for signatures and options.

Chart API

ChartGPU.create, instance methods, shared device, pipeline cache, connectCharts.

Options & series

Full ChartGPUOptions, every series type, axes, zoom, tooltip, animation.

Streaming

appendData, maxPoints, heatmap/surface stream updates, multi-chart device sharing.

Interaction

Events, zoom/pan, hit-test, crosshair sync.

Annotations

lineX/lineY, bands, markers, authoring API.

Themes

ThemeConfig, dark/light presets, palette overrides.

3D charts

cartesian3d, point clouds, surfaces, camera.

Troubleshooting

WebGPU availability, sizing, cleanup, zoom shimmer notes.

Quick answers

Create a chart? ChartGPU.create · Getting started
appendData shape? Streaming API
Line / heatmap / candle options? Options (sticky TOC)
Share a GPU across charts? Shared GPUDevice
Theme? Themes
3D? 3D API · 3D showcase demo

Series & demos

Step / digital line — LineSeriesConfig · demo
Impulse — ImpulseSeriesConfig · demo
Error bars — ErrorBarSeriesConfig · demo
Band / range — BandSeriesConfig · demo
Stacked mountain — stack · demo

Also available

Scales — createLinearScale, createCategoryScale
Low-level GPU / scheduler docs remain on GitHub (contributor-facing)

API reference for the linked @chartgpu/chartgpu package (v0.4.0). Source on GitHub.