Getting started
Introduction
What Aeris Charts is, how it is built, and what it can draw.
What is Aeris Charts?
Aeris Charts is the chart engine that draws every chart in the Aeris desktop terminal. We wrote it from scratch in Rust. The browser SDK, @aeristerminal/aeris-charts, compiles that engine to WebAssembly and gives you a typed TypeScript API over it.
One deterministic chart model owns the data, scales, interactions, drawings, and indicators. It produces one ordered frame, and a backend executes it: WebGPU when the browser supports it, Canvas2D everywhere else. The same model also drives the native GPUI renderer in the desktop app, so a chart looks the same in every host.
What you can build
| Area | What is included |
|---|---|
| Financial series | Candlestick, OHLC bar, line, area, histogram, baseline, and footprint, plus heatmap, HLC area, stacked and grouped bars, and box-and-whisker series. |
| General charts | Columns, bars, line and area on category or linear axes, ranges, error bars, scatter, bubble, box plots, heatmap grids, pie, radar, polar area, and radial bars. |
| Studies | 71 built-in indicators computed incrementally in Rust, from moving averages to market structure, plus your own custom studies. |
| Order flow | Footprint bars built from a trade stream, cumulative volume delta, delta histograms, big trades, and auction markers. |
| Drawings | More than 80 tools: lines, channels, Fibonacci, pitchforks, patterns, Elliott waves, measuring tools, and long and short position tools. |
| Trading objects | Positions, working orders, and brackets drawn on the chart, with drag-to-modify that sends typed intents instead of rewriting broker state. |
| Extensibility | Custom series types, pane and series primitives, and feature helpers such as tooltips, watermarks, and session highlighting. |
| React | An optional adapter at /react that creates the chart once and reconciles data and options onto it. |
Package entry points
| Import | Contents |
|---|---|
@aeristerminal/aeris-charts | The chart API, series, studies, drawings, helpers, and types. |
@aeristerminal/aeris-charts/react | The React adapter. Loads only when you import it. |
@aeristerminal/aeris-charts/design.css | The portable design system and light and dark theme variables. |
@aeristerminal/aeris-charts/wasm | The compiled engine binary, for bundlers that need an explicit asset URL. |
Stability and versions
The current release is 0.14.1. Before 1.0, patch releases contain compatible fixes and minor releases add stable API or reviewed experimental changes. Removing or changing stable API waits for a major release.
Stable: chart creation, the chart, series, time-scale, pane, price-scale, price-line, and drawing handles, built-in series, indicators, drawings, trading, alerts, accessibility, errors, and saved state.
Experimental: custom series, primitives, feature helpers, built-in plugin helpers, worker charts, split grids, and shortcuts. Their types may change in a minor release.