docs/api-index

TerminalGraph API documentation

TerminalGraph is a pure-Nim library for rendering charts as Unicode and ANSI styled strings. Most applications only need the terminal_graph façade; the focused modules are available when a smaller import surface is preferable.

• Main `terminal_graph` façade
• Search all exported symbols
• Package README
• Examples

Install

nimble install terminal_style
nimble install terminal_graph

Quick start

import terminal_graph

echo plot(
  [3, 4, 9, 6, 2, 4, 5, 8],
  graphWidth(40),
  graphHeight(8),
  graphCaption("Request latency"),
  graphSeriesColors(ModernGraphSeriesColors)
)

Chart modules

• `palettes` — a modern dark-terminal TerminalStyle palette, categorical series colors, value gradient, and reusable heading styles.
• `line_graphs` — connected single- and multi-series charts, axes, labels, legends, gradients, and thresholds.
• `bar_graphs` — horizontal single-series, grouped, and stacked positive or negative bars.
• `candle_graphs` — static OHLC candle rendering with automatic or fixed price ranges.
• `xy_graphs` — connected XY and scatter plots with explicit coordinates, viewports, clipping, markers, and legends.
• `sparkline_graphs` — compact inline trends with shared ranges, custom ticks, gaps, and palettes.
• `surface_graphs` — matrix and flat-data surfaces, filled contours, resampling, palettes, and fixed ranges.

Stateful rendering and composition

• `static_graphs` — bounded series data, statistics, deterministic frames, markers, and filled columns.
• `live_graphs` — streaming line and candle graphs plus resize-safe full-screen dashboard lifecycle management.
• `multiplot_graphs` — ANSI- and Unicode-aware grids with responsive width-aware renderers.

Dimensions and live output

API	What its dimensions measure
plot, plotMany, AsciiGraphConfig	Interpolated samples across the canvas and vertical intervals. Axis labels, X-axis ticks, captions, and legends add to the complete output. Automatic height is capped at 20 intervals (21 plot rows); explicit positive heights can request more.
plotCandles, CandlePlotOptions	Price-canvas columns and rows. The axis, caption, baseline, and period labels are outside that canvas.
StaticGraph.render, LiveGraph.renderFrame	The complete frame, including its title, statistics, axes, and footer. Explicit dimensions start at 24 columns by eight rows; zero detects terminal size. Over-wide lines are truncated with … using ANSI- and Unicode-aware widths.
LiveLineGraph.draw, LiveCandleGraph.draw	The optional width is the output terminal's column count for redraw cursor movement. Zero detects the output width; a positive value supplies a known width. Chart dimensions remain in config or options.

Use statistics(seriesIdx) to access complete retained-sample statistics when a static or LiveGraph statistics line is truncated. Set showStats = false to give the canvas an extra row.

Line and candle redraws count wrapped rows at the current output width. renderFrame() produces the chart string for embedding or composition. For responsive full-screen layouts, combine LiveDashboard with multiplotResponsive and render callbacks that honor their assigned widths.

Generate locally

nimble docs
python3 -m http.server 8000 --directory htmldocs

Then open http://localhost:8000. Serving the files over HTTP allows the generated documentation search to load its index.