Skip to content

API reference

Open the main API (rustdoc) →

Browse public types, method signatures, configuration fields and module-level contracts for main (0.3 in development), egui/eframe 0.37, with all crate features available. Rustdoc has its own symbol search: use it for names such as Chart::add_pane. The guide’s Search finds explanations and tasks.

For the published 0.2.0 crate, which uses egui/eframe 0.33.3, open the separate release API on docs.rs.

Panes share the chart’s time axis and hold series or studies on their own price scales. Overlays start in the price pane; oscillators can create separate panes. Use Chart::add_pane and move_series_to_pane to place a series. Resize or reorder panes with set_pane_height and move_pane; PaneOptions controls separator interaction. Start with a built-in study.

Attach trade signals or events to a bar series with Chart::set_markers. Marker sets the time, position, shape, colour and text; set_marker_options controls autoscaling and drawing order. Markers belong to bar series, rather than study outputs. For missing observations, use whitespace bars.

Attach a renderer with Chart::attach_primitive, or implement DrawingRenderer for a custom drawing tool.

For full applications using the public API, browse the runnable examples.

ModuleUse it for
widgetChart, ChartBuilder, series and interaction
modelBars, instruments, intervals, transforms and strategy results
dataFeeds, replies, sinks, trades, depth, recording and replay
studiesIndicator contracts, built-ins and custom studies
drawingsDrawing models, interaction and persistence
scalesScale models, tick generation and formatters
configChart options and input configuration
themeTheme presets and egui styling
servicesHost storage, search, signals, alerts and trading
uiApplication components and their actions