Documentation for 6.0.0

Complete documentation for the current 6.0.0 API.

Choose a public API for a focused guide, executable examples, terminal output, and a declaration-generated option reference.

Signatures and option descriptions are generated from the installed simple-ascii-chart declarations. Examples execute against the same package during documentation generation.

API guides

plot

Render numeric line, point, vertical-bar, and horizontal-bar charts with a compact settings object.

renderChart

Build structured charts with named series, native string or Date X values, mixed modes, annotations, and a secondary Y-axis.

candlestick

Render validated financial OHLC data with direction-aware bodies, wicks, colors, symbols, axes, and thresholds.

heatmap

Render categorical status matrices or threshold-colored numeric grids with labels and legends.

sparkline

Render one compact Unicode trend glyph per value with gaps, colors, thresholds, and custom levels.

histogram

Bin raw samples or normalize pre-counted buckets into numeric data suitable for plot.

ASCII and Braille backends

Compare both plot-cell backends using identical data and terminal dimensions.

Shared API reference

Inspect shared symbols, callback contexts, constants, defaults, and stable error contracts.