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([colorBrightCyan])
)

Chart modules

• `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.

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.