kScript (legacy) construct map

Every kScript (legacy) construct beside the Indicator form that replaces it, grouped by lifetime: a value on every bar, a snapshot of the finished run, or an object that keeps its identity while you move it. From kScript covers the numeric core of a port; this page carries the rest: plots and style words, text and tables, profiles and panels, drawing objects and their mutation, pane anchors, frame snapshots, sources, and the constructs with no home yet.

The same AssemblyScript module compiles once and runs on your machine and in the chart tab; source: "series" inputs require the daemon.

In code-first packages, declarations in src/indicator.ts produce the sheet at wrun/metadata.json. Import declarations from ./sdk/declare, read named in_* accessors in state(), and write out_* values followed by emitRow() in finalize(). Numeric outputs remain metrics, including data-only outputs.

The current line declaration is output("close", line, overlay). There is no out.line declaration in this SDK; out.inset is available. A table cell marked sheet only has no equivalent code-first declaration today.

Time series, shapes and backgrounds

Declare the presentation once, then write one numeric value per ready bar.

render.shape supports circle, cross, triangle_up, triangle_down, diamond, arrow_up, arrow_down, flag and square. kScript's character marks use text instead. For above/below-bar marks, compute the y output; for fixed pane placement, use anchored handles.

Style words

Palette and width indexes are floored; a finite out-of-range index selects entry zero. A non-finite width index keeps the static width. A non-finite background color index selects no tint. Names of palette and gate outputs must differ from the output they control.

Text, labels and tables

String slots carry text per bar; the renderer decides which rows remain visible.

A text renderer's size is 6..64 integer pixels. At most 64 string slots share the sheet, each with max_bytes of 1..4096. Write through generated str_<slot>() or the reusable sb_* builder and str_<slot>_sb(). Omitting a string write is different from writing an empty string.

Profiles, panels and compact widgets

Frames carry the whole snapshot, including category or numeric axes independent of bar time.

Every panel binds a declared frame and uses place: "below" or "side". At most eight panels and four level profiles share a sheet. Bars, line and table require 1..8 series entries; the other panel kinds forbid series. Histogram and heatmap require x: "category".

Panel table cells accept a number, a string of at most 64 characters, or { text?, color?, bar?, spark? }. A cell bar is a fraction in 0..1. Cards, feeds and meters default to anchor: "top_right", offset: [0, 0] and z: 0; offsets are integers in -200..200. Ladder placement uses side.

Drawing objects and mutation

Declare each handle kind once, create objects with distinct ids, and reuse those ids to move or delete them.

The two draw imports have different jobs: ./sdk/declare declares a run-level drawing, while ./gen/draw operates on handles. Alias one when using both. Allocate each generated handle object once at module scope or in init(), and call its geometry/style methods in finalize().

All four kinds share one nonnegative id space. Caps are 500 live handles per kind, 1500 total, and 4096 draw calls per row. Delete expired objects explicitly. A cap breach refuses the run; the host never silently drops drawings. Declarative caps are 16 boxes, 16 segments, 32 renderers and 64 drawings, including cards, ladders, feeds and meters.

Pane anchors

handles.line|box|label|polyline({ anchor: "top_left" }) sets the default for new handles. After creation, .anchor(ANCHOR_TOP_LEFT) changes it; import the constant from ./gen/draw. .anchor(ANCHOR_CHART) restores chart coordinates even when a default anchor is declared. A label adds align (left, center, right): the text edge that sits on x, with (x, y) staying the point; handles.label({ align: "left" }) is the default, .align(ALIGN_RIGHT) changes a live label, and .align(ALIGN_DEFAULT) restores centred text.

Left/top offsets point right/down; right/bottom offsets point left/up. Centre offsets are signed, and negative offsets are legal. Coordinates start at the pane's content rectangle and clip to that pane. A pane anchor keeps a HUD in place while the chart pans; it is not a timestamp offset.

Frame snapshots

Declare frame(name) once and call generated writeFrame(slot, json) in finalize() to replace that run's snapshot.

Frames and per-row strings share a 2 MiB wrun-4 transport budget. Expanded render selections have a separate 2 MiB cap, including panels, handles and sparks. Frames are snapshots, so writing on every bar does not create a history of frames. Accumulate what the snapshot needs in bounded guest memory, then write it, commonly under bar.isLast().

Example: a docked profile and side bars

These declarations share a close output but bind two independent frames. The fixed payloads show the exact accepted shapes; computed aggregates use the same shapes.

import { frame, input, line, ohlcv, output, overlay, panel, plot } from "./sdk/declare";
import { in_close } from "./gen/inputs";
import { emitRow, out_close } from "./gen/outputs";
import { FRAME_PROFILE, FRAME_SIDES, writeFrame } from "./gen/frames";
import { bar } from "./gen/draw";

input("close", ohlcv.close);
output("close", line, overlay);
const profile = frame("profile");
const sides = frame("sides");
plot.levels({ name: "volume_levels", frame: profile, dock: "right", poc: true });
panel.bars({
  name: "side_totals", title: "Volume by side", x: "category", place: "side",
  series: [{ name: "Volume", color: "#38bdf8" }], frame: sides,
});

let closeValue: f64 = NaN;
export function init(): void {}
export function state(): i32 { closeValue = in_close(); return 1; }
export function finalize(): void {
  out_close(closeValue);
  if (bar.isLast()) {
    writeFrame(FRAME_PROFILE, '{"prices":[100,101,102],"values":[8,21,13]}');
    writeFrame(FRAME_SIDES, '{"rows":[["Buy",26],["Sell",16]]}');
  }
  emitRow();
}
export function reset(): void { closeValue = NaN; }

The extractor selects wrun-4, resolves frame handles to names in the sheet, and generates FRAME_* indexes. Frame declaration names, output names, string-slot names and visual names must not collide.

Example: a box and label HUD

Both handles use pane pixels and retain their ids while the last close changes.

import { handles, input, none, ohlcv, output, overlay, string } from "./sdk/declare";
import { in_close } from "./gen/inputs";
import { emitRow, out_last_close } from "./gen/outputs";
import { sb_clear, sb_f64, sb_text, str_caption_sb } from "./gen/strings";
import { ALIGN_LEFT, ANCHOR_TOP_LEFT, bar, draw } from "./gen/draw";

input("close", ohlcv.close);
output("last_close", none, overlay);
string("caption", { max_bytes: 48 });
handles.box({ color: "#111827", borderColor: "#38bdf8", opacity: 1 });
handles.label({ text: "caption", color: "#ffffff", size: 12 });
const background = draw.box(0);
const caption = draw.label(1);
let closeValue: f64 = NaN;

export function init(): void {}
export function state(): i32 { closeValue = in_close(); return 1; }
export function finalize(): void {
  out_last_close(closeValue);
  if (bar.isLast()) {
    background.set(12, 12, 200, 46).anchor(ANCHOR_TOP_LEFT);
    sb_clear(); sb_text("Close "); sb_f64(closeValue, 2);
    caption.set(20, 22).text(str_caption_sb).anchor(ANCHOR_TOP_LEFT).align(ALIGN_LEFT);
  }
  emitRow();
}
export function reset(): void { closeValue = NaN; }

This sheet needs wrun-3, not a frame. Anchors are also available under wrun-4. The label's .text(...) creates it before .anchor(...) and .align(...) mutate it; ALIGN_LEFT starts the caption at x = 20 instead of centring it there.

Sources and the bar grid

Keep a market input at index zero; all other inputs align to its grid.

For source: "series", ref is watch/<slug>/<key> or an installed @scope/name. missing is carry (default) or nan, never zero. Readings bucket to the primary interval; the last reading in each bucket wins. Carry uses the latest bucket at or before the bar; nan requires a reading in that bar's own bucket. A series input has no field, selector, params or interval pin and cannot densify the grid.

Example: a watch series sheet

Use a metadata-first workspace for this sheet. The generated in_watch_flow() reads the watch value in state(); out_flow(value) writes the plotted value in finalize() before emitRow().

{
  "id": "watch-flow",
  "name": "Watch flow",
  "inputSources": {
    "close": { "source": "ohlcv", "field": "close" },
    "watch_flow": { "source": "series", "ref": "watch/flow/imbalance", "missing": "carry" }
  },
  "inputs": [{ "index": 0, "name": "close" }, { "index": 1, "name": "watch_flow" }],
  "outputs": [{ "index": 0, "name": "flow", "plot": "line", "panel": "lower" }]
}

Series inputs are ABI-neutral; the sheet above uses the wrun-1 default. Add abi_version: "wrun-4" when the same module also declares frames.

No home yet

These legacy behaviors need a deliberate substitute; an accepted sheet field alone does not provide every legacy visual.

The contracts behind this map live on their published pages: Plotting for outputs, renderers and declared drawings, Drawing objects for handles and their setters, Drawing primitives for pane anchors, frames, panels and the compact widgets, Data sources for the source classes, and the Limits reference for every cap. The ABI contracts a sheet names are on Script definition.