Public-surface stability markers (PRD §73).
type ApiStability = ApiStabilityAnnotate a public contract with its stability guarantee.
interface ApiSurface| stability | ApiStability |
Linear Cartesian axis.
type AxisScale = AxisScale`"continuous"` slides a trailing window as new data arrives. `"sweep-once"` paints one pass across a fixed window anchored at the first sample, then holds there. `"sweep-multi"` repeats that pass, jumping back to the anchor each time the window fills (classic oscilloscope-style repeating sweep).
type AxisScrollMode = AxisScrollModeOne axis tick after a tick provider runs.
interface AxisTick| value | number |
| label | string |
| major | boolean |
Built-in theme names shipped in Phase 2.
type BuiltinThemeName = BuiltinThemeNameAn operation was attempted on a chart, engine, or renderer that has already been disposed.
class ChartDisposedErrorAccepted color inputs at public APIs. - {@link Rgba} object - `[r, g, b]` or `[r, g, b, a]` in 0–1 - CSS hex (`#rgb`, `#rgba`, `#rrggbb`, `#rrggbbaa`) - `rgb()` / `rgba()` functions - a small set of named colors
type ColorInput = ColorInputData ↔ screen transforms (PRD §40).
interface CoordinateSpace| plot | PlotRect |
| toScreen | (x: number, y: number) => ScreenPoint |
| toData | (px: number, py: number) => DataPoint |
Chart cursor + tooltip tracking.
interface CursorController| enabled | boolean |
| mode | CursorMode |
| snap | boolean |
| enable | (options?: CursorEnableOptions) => CursorController |
| disable | () => CursorController |
Options for {@link CursorController.enable}.
interface CursorEnableOptions| mode? | CursorMode | undefined |
| snap? | boolean | undefined |
Cursor drawing mode (PRD §28).
type CursorMode = CursorModePoint in data space.
interface DataPoint| x | number |
| y | number |
Owns the scene, renderer, frame loop, and resource lifetime. Frame-loop ownership lives here — not on individual charts. Charts request frames via {@link Engine.requestFrame}; they do not call `requestAnimationFrame` themselves.
interface Engine| scene | Scene |
| renderer | Renderer | undefined |
| resources | ResourceManager |
| disposed | boolean |
| initialized | boolean |
| viewport | ViewportSize |
| cssSize | ViewportSize |
| pixelRatio | number |
| initialize | () => Promise<void> |
| resize | (width: number, height: number) => void |
| requestFrame | () => void |
| renderNow | () => void |
| start | () => void |
| stop | () => void |
| dispose | () => void |
| on | <K extends keyof EngineEventMap>(event: K, handler: (payload: EngineEventMap[K]) => void) => () => void |
Events emitted by {@link Engine}.
interface EngineEventMap| resize | { readonly css: ViewportSize; readonly viewport: ViewportSize; } |
| dispose | undefined |
| frame | { readonly timestamp: number; } |
interface EngineOptions| canvas | RenderTarget |
| renderer? | RendererPrefs | undefined |
| autoResize? | boolean | undefined |
| pixelRatio? | number | undefined |
An export operation failed.
class ExportErrorNested scene group. Children are flattened when the render graph compiles.
interface GroupNode| kind | "group" |
| children | readonly SceneNode[] |
| id | string |
| visible | boolean |
| zIndex | number |
RGBA8 heatmap texture. Partial updates carry a dirty rectangle so the renderer can `texSubImage2D` instead of re-uploading the whole matrix.
interface HeatmapTexture| width | number |
| height | number |
| pixels | Uint8Array<ArrayBufferLike> |
| interpolation | "nearest" | "bilinear" |
| dirty? | { readonly x: number; readonly y: number; readonly width: number; readonly height: number; readonly pixels: Uint8Array; } | undefined |
Input data failed validation (wrong arity, NaN, empty required buffer).
class InvalidDataErrorLicense validation failed. Secrets must never be hardcoded; see env `REKHLY_LICENSE`.
class LicenseErrorinterface LinearAxis| id | string |
| orientation | "x" | "y" |
| inverted | boolean |
| title | string |
| autoFit | boolean |
| scale | AxisScale |
| getDomain | () => NumericRange |
| getVisibleRange | () => NumericRange |
| setVisibleRange | (range: NumericRange | { readonly width: number; }) => LinearAxis |
| setWindowWidth | (width: number | undefined) => LinearAxis |
| getWindowWidth | () => number | undefined |
| setDomain | (range: NumericRange) => LinearAxis |
| setTitle | (title: string) => LinearAxis |
| setInverted | (inverted: boolean) => LinearAxis |
| setFitPadding | (padding: number) => LinearAxis |
| getFitPadding | () => number |
| setTickProvider | (provider: TickProvider | undefined) => LinearAxis |
| ticks | (countHint: number) => readonly AxisTick[] |
| format | (value: number) => string |
| fit | () => LinearAxis |
| setScale | (scale: AxisScale) => LinearAxis |
| setScrollMode | (mode: AxisScrollMode) => LinearAxis |
| getScrollMode | () => AxisScrollMode |
| setCategories | (labels: readonly string[]) => LinearAxis |
| setTimeZone | (zone: "utc" | "local") => LinearAxis |
| setFormatStyle | (style: "plain" | "scientific" | "engineering") => LinearAxis |
| setUnitLabel | (label: string) => LinearAxis |
World-space mesh drawn with an MVP matrix. The renderer enables depth testing and optional Lambert lighting. Software backends project on CPU.
interface Mesh3DData| positions | Float32Array<ArrayBufferLike> |
| normals? | Float32Array<ArrayBufferLike> | undefined |
| colors? | Float32Array<ArrayBufferLike> | undefined |
| mvp | Float32Array<ArrayBufferLike> |
| mode | "triangles" | "lines" | "line-strip" | "points" |
| pointSize? | number | undefined |
| clipPlane? | readonly [number, number, number, number] | undefined |
| lit? | boolean | undefined |
Stable identifier for a scene node.
type NodeId = stringInclusive numeric interval in data space.
interface NumericRange| min | number |
| max | number |
Plot rectangle in CSS pixels relative to the host.
interface PlotRect| left | number |
| top | number |
| width | number |
| height | number |
Built-in drawable kinds for Phase 1 smoke rendering. Chart series attach as additional node kinds in later phases; they still compile down to the same render-graph passes.
type PrimitiveKind = PrimitiveKindinterface PrimitiveNode| kind | "primitive" |
| primitive | PrimitiveKind |
| color | Rgba |
| vertices | Float32Array<ArrayBufferLike> |
| texture? | HeatmapTexture | undefined |
| mesh? | Mesh3DData | undefined |
| clipRect? | readonly [number, number, number, number] | undefined |
| id | string |
| visible | boolean |
| zIndex | number |
Base typed error. All public Rekhly failures extend this class so callers can branch on {@link RekhlyError.code} without string-matching `name`.
class RekhlyErrorStable error codes for typed Rekhly failures (PRD §74).
type RekhlyErrorCode = RekhlyErrorCodeOptions accepted by every Rekhly error constructor.
interface RekhlyErrorOptions| cause? | unknown |
| details? | Readonly<Record<string, unknown>> | undefined |
Backend-agnostic renderer contract (PRD §3). Chart and series code must never call WebGL/WebGPU APIs directly. Custom drawing goes through scene primitives or a later plugin API.
interface Renderer| kind | RendererKind |
| device | RendererDevice |
| disposed | boolean |
| viewport | ViewportSize |
| lastFrameStats? | RendererFrameStats | undefined |
| initialize | () => Promise<void> |
| resize | (width: number, height: number) => void |
| render | (scene: Scene) => void |
| dispose | () => void |
Where the WebGL core actually executes. - `gpu` — hardware `webgl2` context - `software` — CPU WebGL2 implementation (no GPU / headless)
type RendererDevice = RendererDeviceMeasured per-frame renderer counters. Values are recorded, never invented.
interface RendererFrameStats| drawCalls | number |
| uploadBytes | number |
| bufferBytes | number |
| vertexCount | number |
Renderer construction or `initialize()` failed for a reason other than a specific backend being unavailable.
class RendererInitializationErrorSupported rendering backends (PRD §3). Preference order when a backend is ready: WebGPU → WebGL2 → Canvas. WebGPU is not production-ready in Phase 1 and is skipped unless forced.
type RendererKind = RendererKindRenderer selection preferences.
interface RendererPrefs| prefer? | readonly RendererKind[] | undefined |
| force? | RendererKind | undefined |
| strict? | boolean | undefined |
| powerPreference? | "default" | "high-performance" | "low-power" | undefined |
| failIfMajorPerformanceCaveat? | boolean | undefined |
| allowSoftware? | boolean | undefined |
Immutable snapshot of work for one frame.
interface RenderGraph| passes | readonly RenderPass[] |
| nodeCount | number |
| primitiveCount | number |
A compiled, backend-agnostic draw unit.
type RenderPass = RenderPassSurface the engine can draw into. OffscreenCanvas is accepted so a later worker/OffscreenCanvas path can reuse the same engine without an API break.
type RenderTarget = RenderTargetA GPU/CPU resource could not be created, compiled, or disposed cleanly.
class ResourceErrorHandle to a cached engine resource. `backendRef` is opaque and must not be used by chart-level code.
interface ResourceHandle| id | string |
| kind | ResourceKind |
| byteSize | number |
| backendRef | unknown |
Resource kinds tracked by the resource manager (PRD §58, §75).
type ResourceKind = ResourceKindPer-kind resource accounting snapshot.
interface ResourceKindStats| count | number |
| byteSize | number |
Create/cache/dispose manager for shaders, buffers, textures, and other long-lived objects. Callers must {@link ResourceManager.disposeAll} when the owning renderer or engine is disposed.
interface ResourceManager| register | (handle: ResourceHandle, disposeFn: () => void) => ResourceHandle |
| get | (id: string) => ResourceHandle | undefined |
| dispose | (id: string) => boolean |
| disposeAll | () => void |
| stats | () => ResourceStats |
Aggregate resource accounting. Values are measured, not estimated marketing figures.
interface ResourceStats| count | number |
| byteSize | number |
| byKind | Readonly<Record<ResourceKind, ResourceKindStats>> |
Normalized device-independent color in linear-ish 0–1 RGBA. Values are stored in the 0–1 range. Conversion from CSS hex/rgb happens at the public-API boundary so the render path never parses strings.
interface Rgba| r | number |
| g | number |
| b | number |
| a | number |
CPU-side scene. The public chart API mutates the scene; renderers only consume {@link Scene.compile}.
interface Scene| background | Rgba |
| nodes | readonly SceneNode[] |
| dirty | boolean |
| add | (node: SceneNode) => SceneNode |
| remove | (id: NodeId) => boolean |
| get | (id: NodeId) => SceneNode | undefined |
| clear | () => void |
| markDirty | () => void |
| compile | () => RenderGraph |
Discriminated scene node union. New chart node kinds are added here without changing the renderer contract.
type SceneNode = SceneNodeShared fields on every scene node.
interface SceneNodeBase| id | string |
| kind | string |
| visible | boolean |
| zIndex | number |
Point in CSS pixels relative to the chart host.
interface ScreenPoint| x | number |
| y | number |
A streaming transport failed to connect or dropped unexpectedly.
class StreamConnectionErrorResolved, immutable visual theme (PRD §34–35).
interface Theme| name | string |
| background | Rgba |
| plot | { readonly fill: Rgba; readonly padding: ThemePadding; } |
| axis | { readonly line: Rgba; readonly tick: Rgba; readonly label: Rgba; readonly title: Rgba; readonly fontFamily: string; readonly fontSize: number; readonly titleSize: number; } |
| grid | { readonly major: Rgba; readonly minor: Rgba; } |
| cursor | { readonly line: Rgba; } |
| tooltip | { readonly background: Rgba; readonly border: Rgba; readonly text: Rgba; readonly fontFamily: string; readonly fontSize: number; } |
| series | readonly Rgba[] |
| typography | { readonly fontFamily: string; readonly fontSize: number; } |
Partial input for {@link createTheme }. Color fields accept {@link ColorInput}.
interface ThemeInput| name? | string | undefined |
| background? | ColorInput | undefined |
| plot? | { readonly fill?: ColorInput; readonly padding?: Partial<ThemePadding>; } | undefined |
| axis? | Partial<{ line: ColorInput; tick: ColorInput; label: ColorInput; title: ColorInput; fontFamily: string; fontSize: number; titleSize: number; }> | undefined |
| grid? | Partial<{ major: ColorInput; minor: ColorInput; }> | undefined |
| cursor? | Partial<{ line: ColorInput; }> | undefined |
| tooltip? | Partial<{ background: ColorInput; border: ColorInput; text: ColorInput; fontFamily: string; fontSize: number; }> | undefined |
| series? | readonly ColorInput[] | undefined |
| typography? | Partial<{ fontFamily: string; fontSize: number; }> | undefined |
Plot-area insets in CSS pixels.
interface ThemePadding| top | number |
| right | number |
| bottom | number |
| left | number |
Custom tick generator hook.
type TickProvider = TickProviderContext passed to a custom tick provider.
interface TickProviderContext| min | number |
| max | number |
| countHint | number |
One series value shown in the tooltip.
interface TooltipSeriesValue| seriesId | string |
| seriesName | string |
| x | number |
| y | number |
| index | number |
Backing-store size in physical pixels.
interface ViewportSize| width | number |
| height | number |
WebGL2 was requested (or required as fallback) but the environment could not produce a `webgl2` context.
class WebGLUnavailableErrorWebGPU was requested but is unavailable, or is not production-ready in this Rekhly release.
class WebGPUUnavailableErrorTyped-array XY dataset. `x` and `y` must have the same length.
interface XYBuffer| x | Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike> |
| y | Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike> |
Accepted XY inputs at the public series API.
type XYData = XYDataOne Cartesian sample as a public object form (PRD §6). Prefer {@link XYBuffer} on the hot path. Object arrays are converted once into typed storage internally.
interface XYPoint| x | number |
| y | number |
Got any questions? I'm happy to help with products, licensing, and examples.