Files
plot/README.md
T
waozi b685655bb9 Share high-precision candle projection and viewport utilities
Resolve the frozen Ziran and Kryon revisions from their Gitea package sources.
2026-11-19 15:11:58 -03:00

5.1 KiB

Plot

plot is a Ziran package that depends on the separate Kryon package. It owns PlotWidget, a retained Kryon widget that draws lines, bars, markers, and axes over caller-owned values, and its candle chart draws OHLC bodies and wicks, volume, SMA 20, SMA 50, and EMA 20 over that surface. ChartMarker and CandleMarkers add dated, clickable markers while leaving each marker's meaning to the caller. It also has a simple line chart. Both accept caller-owned values and colors; market data, networking, price formatting, and time labels stay in the application.

The shared plot surface, text, border and marks follow Kryon's current surface, text, border and accent style tokens on each draw. Installed style rules still override those defaults. Changing appearance updates an existing chart without recreating it; callers retain their series colors.

Install the Ziran launcher once with make install-user in Ziran, then run ziran fetch and make build here. make run opens a small demo on the Cairo backend; make check checks the source and runs the nonvisual indicator test. The checked-in ziran.lock pins both Ziran and Kryon to exact commits. Plot exports src/Plot/module.zi for other packages, so plot/Plot resolves by its file both in projects and in builds that name --module-path plot=DIR. That module re-exports Plot's charts and Kryon's public UI surface; app code can use using Charts :: #import "Plot";.

To add Plot to another Ziran project, run:

ziran add https://git.waozi.xyz/kryonlabs/plot.git

Then import its public module, or only the chart surface:

using Charts :: #import "plot/Plot";
using Surface :: #import "plot/PlotWidget";

The package exports PriceBar, CandleChartProps, CandleChart, CandleRangeFor, ChartMarker, CandleMarkers, ChartPriceLevel, CandlePriceLevels, SMAAt, EMAAt, and the line chart API. Ziran locks Plot and Kryon to exact commits. No source links or copied chart files are needed in a consuming package. Run ziran update to refresh every dependency in a project, or ziran update kryon in this package to refresh only Kryon.

ATR consumes Plot through its package manifest and canonical local overrides during integration. Other packages can use the dependency directly. Public module names use UpperCamelCase (Kryon, PlotWidget, Plot). Lowercase names such as plot_widget are implementation modules; the lowercase plot export remains available for existing consumers.

High-precision candlesticks

For OHLCV data stored as float64, pass the visible []PriceBar64 and a caller-owned []PriceBar of the same length or longer to CandleProject. The function offsets and scales prices in float64 before storing them in the [1, 2] domain used by the renderer. It also normalizes volume. Pass the projected bars and projection.range to CandleChart. Input must have finite, ordered OHLC values and finite, nonnegative volumes. A zero span indicates empty input, insufficient output space, or an unrepresentable domain. Flat input receives a small centered display span.

Use CandleProjectedPrice(projection, tick) to recover a float64 price for an axis label. For example, CandleProjectedPrice(projection, 1.5) gives the midpoint price and CandleY(1.5, price_bounds, projection.range) gives its position. Use the original bars for detailed captions.

CandleViewportFor(bars, right_edge, selected, visible) resolves ascending timestamps into the half-open window [first, end). A zero right_edge follows the latest bar. selected is a timestamp on input and an absolute bar index on output. The window retains the selected bar when visible and otherwise selects the rightmost visible bar. An empty window has selection -1. Use CandlePanEnd to move the window and CandleCenterX and CandleIndexAtX to map between visible slots and plot coordinates.

Band charts in portable bundles

BandChart(session, props, points, bands) draws values over a row of slots against the range that counts as good. A portable bundle built with KRYON_HOSTED_UI sends the chart to its host as BandChartHostedHost. The host answers it with BandChartHostCall(session, module, function, arguments, count, result) from band_chart_host, beside Kryon's WidgetHostCall, and allows it where BandChartHostSupports(module, function) says so. The records are in band_chart_props, and scripts/generate-codec.py generates their codec on top of Kryon's widget codec. A chart takes at most 366 points and 366 bands.

CandleRangeFor(bars, visible_count, logarithmic = false) supports a positive logarithmic price domain while keeping linear callers compatible. Range fields remain actual prices. CandlePadRange recomputes padding after caller-owned level expansion. CandleY and CandlePriceAtY are matching forward/inverse transforms for candle bodies, wicks, averages, levels, price ticks and tooltips. Invalid/nonpositive prices are not painted on a logarithmic chart. CandleWindowEnd(bars, timestamp) resolves a stable retained right edge (zero follows latest); CandlePanStepsFor and CandlePanEnd support caller-owned drag windows. Chart libraries do not fetch markets or change application selection.