Global animation switch. High-frequency apps should disable transitions.
class AnimationControllerinterface AnnotationConfig| id | string |
| kind | AnnotationKind |
| value? | number | undefined |
| x0? | number | undefined |
| y0? | number | undefined |
| x1? | number | undefined |
| y1? | number | undefined |
| text? | string | undefined |
| color? | ColorInput | undefined |
| draggable? | boolean | undefined |
| labelPlacement? | AnnotationLabelPlacement | undefined |
| snapToSeries? | string | undefined |
interface AnnotationHit| id | string |
| kind | AnnotationKind |
type AnnotationKind = AnnotationKindSerialize/deserialize-friendly annotation set with hit-test drag.
class AnnotationLayertype AnyMarkerConfig = AnyMarkerConfigFilled area plus optional stroke.
class AreaSeriesArea series options.
interface AreaSeriesOptions| fill? | ColorInput | undefined |
| stroke? | ColorInput | undefined |
| baseline? | number | undefined |
| name? | string | undefined |
| color? | ColorInput | undefined |
One axis tick after a tick provider runs.
interface AxisTick| value | number |
| label | string |
| major | boolean |
class BandSeriesFirst-class categorical bar chart: single, grouped, or stacked.
class BarChartinterface BarChartOptions| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
interface BarDatum| category | string |
| value | number |
Vertical bar / column series.
class BarSeriesBar / column series options.
interface BarSeriesOptions| barWidth? | number | undefined |
| name? | string | undefined |
| color? | ColorInput | undefined |
Bin `x`/`y` scatter samples into a 2D-histogram grid — the classic "colormap" density map.
(x: ArrayLike<number>, y: ArrayLike<number>, columns: number, rows: number, xRange?: NumericRange, yRange?: NumericRange) => { readonly values: Float32Array; readonly xRange: NumericRange; readonly yRange: NumericRange; }interface BoxGroup| x | number |
| values | ArrayLike<number> |
Tukey box plot series. Source values are summarized, never mutated.
class BoxPlotSeriesTukey five-number summary.
(values: ArrayLike<number>) => BoxSummaryclass BubbleSeries(categories: readonly string[]) => { value: number; label: string; major: boolean; }[]type CellContent = CellContentNamed starting points for {@link XYChartOptions.components }. Spread one and override individual flags, e.g. `{ ...CHART_PRESETS.legendOnly, cursor: true }`.
{ readonly full: Required<XYChartComponents>; readonly minimal: Required<XYChartComponents>; readonly legendOnly: Required<XYChartComponents>; readonly cursorOnly: Required<XYChartComponents>; readonly dashboard: Required<XYChartComponents>; readonly trading: Required<XYChartComponents>; }(options: BarChartOptions) => BarChartinterface ChartConfig| schemaVersion | string |
| chart | { readonly type: string; } |
| theme | string |
| axes | { readonly x: { readonly min: number; readonly max: number; }; readonly y: { readonly min: number; readonly max: number; }; } |
| series | readonly { readonly id: string; readonly kind: string; readonly name: string; readonly length: number; }[] |
(options: DataGridOptions) => DataGrid(options: DensityCurveChartOptions) => DensityCurveChart(options: DensityScatterChartOptions) => DensityScatterChart(o: PartChartOptions) => DonutChart(options: EyeDiagramOptions) => EyeDiagramChart(o: PartChartOptions) => FunnelChart(o: PartChartOptions) => GaugeChart(options: HeatmapChartOptions) => HeatmapChartOverlay legend. Clicking an item toggles visibility via `onToggle`.
class ChartLegend(options: LinearGaugeOptions) => LinearGauge(options: OscilloscopeOptions) => OscilloscopeChart(options: ParallelChartOptions) => ParallelCoordinateChart(o: PartChartOptions) => PieChartExtension hook for adding fully custom behavior to a chart without modifying `@rekhly/charts-2d` itself: `install` runs once on {@link XYChart.use}, `onRender` after every {@link XYChart.render}, `onDispose` before the chart tears down.
interface ChartPlugin| name | string |
| install? | ((chart: XYChart) => void) | undefined |
| onRender? | ((chart: XYChart) => void) | undefined |
| onDispose? | ((chart: XYChart) => void) | undefined |
(options: PolarChartOptions) => PolarChart(o: PartChartOptions) => PyramidChart(o: PartChartOptions) => RadarChart(o: PartChartOptions) => SankeyChart(options: SmithChartOptions) => SmithChart(options: SpectrogramChartOptions) => SpectrogramChart(o: PartChartOptions) => RadarChartChart-level toolbar: Sweep Once / Sweep Continuously / zoom in / zoom out. Each sweep button is a toggle — click to start, click again to abort. Sits as a floating pill at the bottom-center of the overlay so it never collides with the legend (top-left) or the restore/box-zoom buttons (top-right).
class ChartToolbar(o: PartChartOptions) => TreemapChartCreate an XY chart. Initialization runs in the background; await {@link XYChart.ready} before the first GPU frame is guaranteed.
(options: XYChartOptions) => XYChart(t: number, low: Rgba, high: Rgba) => RgbaValue → color lookup used by heatmaps, parallel coordinates, and gauges. Original Rekhly helper — not a wrapper of any third-party LUT type.
class ColorLutConstruction options for {@link ColorLut}.
interface ColorLutOptions| steps | readonly LutStep[] |
| interpolate? | boolean | undefined |
(items: readonly NamedValue[]) => PrimitiveNode[]Gauge needle + arc background from a 0–1 value.
(value: number, color: ColorInput) => PrimitiveNode[]Compile the heatmap as a single textured quad. When `full` is false and dirty regions exist, the texture includes a dirty rectangle for a partial GPU upload.
(matrix: HeatmapMatrix, coords: RekhlyCoordinates, low: ColorInput, high: ColorInput, options?: { readonly full?: boolean; }) => PrimitiveNode[]Pie / donut wedges in clip space. Negative values are rejected.
(slices: readonly Slice[], options?: { donut?: boolean; innerRadius?: number; }) => PrimitiveNode[](items: readonly NamedValue[]) => PrimitiveNode[]Radar / spider polygon from 0–1 normalized values.
(values: readonly number[], color: ColorInput) => PrimitiveNode[](nodes: readonly string[], links: readonly SankeyLink[]) => PrimitiveNode[](items: readonly NamedValue[]) => PrimitiveNode[]Compute the plot rectangle from CSS host size and theme padding.
(css: ViewportSize, theme: Theme, padding?: Theme["plot"]["padding"]) => PlotRectInfinite shaded band along X or Y.
class ConstantBandSeriesInfinite reference line along X or Y.
class ConstantLineSeriestype ContentAlignment = ContentAlignmentMarching-squares contour polylines on a regular grid.
(columns: number, rows: number, values: ArrayLike<number>, levels: readonly number[]) => { level: number; lines: Float64Array; }[]Data ↔ screen transforms (PRD §40).
interface CoordinateSpace| plot | PlotRect |
| toScreen | (x: number, y: number) => ScreenPoint |
| toData | (px: number, py: number) => DataPoint |
Convenience constructor.
(steps: readonly LutStep[], interpolate?: boolean) => ColorLut(options?: SyncGroupOptions) => SyncGroupCreate and wait for the first initialized frame.
(options: XYChartOptions) => Promise<XYChart>(main: XYChart, options: ZoomOverviewOptions) => ZoomOverviewChart 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 = CursorModeinterface DashboardCell| id | string |
| column | number |
| row | number |
| columnSpan? | number | undefined |
| rowSpan? | number | undefined |
CSS-grid dashboard host. Charts are attached to cells by the caller.
class DashboardLayoutTabular grid with text, numbers, and inline spark charts. Text lives in the overlay (accessible). Sparks are inline SVG — no extra WebGL context per cell.
class DataGridinterface DataGridOptions| container | string | HTMLElement |
| theme? | Theme | BuiltinThemeName | undefined |
| width? | number | undefined |
| height? | number | undefined |
Decode a binary frame. Throws if magic/version is unknown.
(buffer: ArrayBuffer) => StreamFrameRequired<UserInteractions>A delta marker connects two positions and reports the change between them — the common "price move" / "value change" annotation.
interface DeltaMarkerConfig| id | string |
| kind | "delta" |
| from | MarkerPosition |
| to | MarkerPosition |
| color? | ColorInput | undefined |
| positiveColor? | ColorInput | undefined |
| negativeColor? | ColorInput | undefined |
| label? | string | undefined |
| formatDelta? | ((delta: number, percent: number) => string) | undefined |
Persistence / "phosphor" density map: repeatedly traced curves accumulate brightness and fade, like an analog oscilloscope display. Rendering reuses {@link HeatmapChart}; this adds the trace-accumulation buffer on top.
class DensityCurveChartinterface DensityCurveChartOptions| columns? | number | undefined |
| rows? | number | undefined |
| xRange | NumericRange |
| yRange | NumericRange |
| decay? | number | undefined |
| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
| low? | ColorInput | undefined |
| high? | ColorInput | undefined |
2D-histogram scatter density rendered as a heatmap: bins `x`/`y` points into a grid via {@link binScatterDensity} and uploads the counts.
class DensityScatterChartinterface DensityScatterChartOptions| columns? | number | undefined |
| rows? | number | undefined |
| xRange? | NumericRange | undefined |
| yRange? | NumericRange | undefined |
| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
| low? | ColorInput | undefined |
| high? | ColorInput | undefined |
(config: ChartConfig) => ChartConfiginterface DetectionBarConfig| id | string |
| x0 | number |
| x1 | number |
| color? | ColorInput | undefined |
| label? | string | undefined |
| severity? | DetectionSeverity | undefined |
Translucent vertical bands over x-ranges where a condition was detected (anomalies, threshold breaches, event windows). Independent of series data — callers derive ranges themselves or via {@link detectRanges}.
class DetectionBarLayertype DetectionSeverity = DetectionSeverityScan `x`/`y` for contiguous runs where `predicate(y[i])` holds and turn each run into a {@link DetectionBarConfig} spanning its x-range.
(x: ArrayLike<number>, y: ArrayLike<number>, predicate: (value: number, index: number) => boolean, options?: { readonly idPrefix?: string; readonly severity?: DetectionSeverity; readonly color?: ColorInput; }) => DetectionBarConfig[]Discrete Fourier transform magnitude (real input). For visualization, not a replacement for FFTW. Source is not mutated.
(samples: ArrayLike<number>) => { freq: Float64Array; mag: Float64Array; }interface DonutChart| ready | Promise<void> |
| engine | Engine |
| setSlices | (slices: readonly Slice[]) => DonutChart |
| dispose | () => void |
interface EllipseDatum| x | number |
| y | number |
| rx | number |
| ry | number |
Axis-aligned ellipses / bubbles with independent radii.
class EllipseSeriesEncode a batch without JSON.
(frame: StreamFrame, options?: EncodeFrameOptions) => ArrayBufferclass ErrorBarSeriesInclusive data-space extents, or `undefined` when empty.
(x: Float64Array, y: Float64Array) => { xMin: number; xMax: number; yMin: number; yMax: number; } | undefinedEye diagram: slices a waveform into repeated unit-interval windows and overlays them on one {@link XYChart}, the standard telecom/signal-integrity view. Each slice is a plain low-alpha `LineSeries` — density comes from additive overlap, not a bespoke renderer.
class EyeDiagramChartinterface EyeDiagramOptions| maxTraces? | number | undefined |
| traceOpacity? | number | undefined |
| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| autoResize? | boolean | undefined |
| pixelRatio? | number | undefined |
| width? | number | undefined |
| height? | number | undefined |
| components? | boolean | XYChartComponents | undefined |
| captureDistance? | number | undefined |
| locale? | Locale | undefined |
| translations? | Partial<MessageTable> | undefined |
| titlePosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
| titleOffset? | number | undefined |
| toolbarPosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | "outside-bottom" | undefined |
| controlsPosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
(value: number, style?: NumberFormatStyle, digits?: number) => stringFormat a value using the tick step to pick precision.
(value: number, step: number) => string(ms: number, step: number, timeZone?: "utc" | "local") => string(value: number, unit: string, style?: NumberFormatStyle) => stringBounded frame queue. Pause + burst ingest cannot grow without limit.
class FrameQueueEvery component on. This is the implicit default for a bare `chartXY()`.
Required<XYChartComponents>class FunnelChartinterface GaugeBand| from | number |
| to | number |
| color | ColorInput |
class GaugeChartinterface GroupedBarDatum| category | string |
| values | Record<string, number> |
Heatmap chart on the WebGL core (GPU or software). Partial `updateRegion` compiles a dirty rectangle so the renderer can `texSubImage2D` instead of re-uploading the whole matrix.
class HeatmapChartinterface HeatmapChartOptions| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
| low? | ColorInput | undefined |
| high? | ColorInput | undefined |
type HeatmapInterpolation = HeatmapInterpolationLarge-matrix heatmap stored as a flat typed array. `updateRegion` writes only the dirty slice — source cells outside the rectangle are not rewritten. Compile produces one textured quad so the renderer can `texSubImage2D` dirty rectangles.
class HeatmapMatrixinterface HeatmapRegion| column | number |
| row | number |
| width | number |
| height | number |
| values | ArrayLike<number> |
type HeatmapUploadKind = HeatmapUploadKindHistogram bins. Source values are not mutated.
(values: ArrayLike<number>, binCount?: number) => { edges: Float64Array; counts: Float64Array; }class HorizontalBarSeriesConvert a normalized or absolute complex impedance to a reflection coefficient: `Γ = (z - 1) / (z + 1)` with `z = Z / Z0`.
(resistance: number, reactance: number, z0?: number) => ReflectionPointinterface LegendItem| id | string |
| name | string |
| color | Rgba |
| visible | boolean |
| detail? | string | undefined |
interface LegendOptions| showDetails? | boolean | undefined |
| position? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
Any of the 9 chart-chrome anchors — see {@link OverlayPosition}.
type LegendPosition = "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center"Which side of `value` counts as a breach.
type LimitDirection = LimitDirectioninterface LimitLineConfig| id | string |
| orientation | LimitLineOrientation |
| value | number |
| label? | string | undefined |
| color? | ColorInput | undefined |
| dashed? | boolean | undefined |
| direction? | LimitDirection | undefined |
| breachColor? | ColorInput | undefined |
Fixed threshold lines (upper/lower limits) with optional breach detection: {@link LimitLineLayer.breached} reports which lines a given value currently crosses so callers can style series/markers accordingly.
class LimitLineLayertype LimitLineOrientation = LimitLineOrientationinterface 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 |
Options for {@link RekhlyLinearAxis}.
interface LinearAxisOptions| id | string |
| orientation | "x" | "y" |
| fitPadding? | number | undefined |
| onChange? | (() => void) | undefined |
Horizontal or vertical bar gauge with optional color bands / LUT.
class LinearGaugeinterface LinearGaugeOptions| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
1-2-5 linear ticks for a visible range.
(context: TickProviderContext) => AxisTick[]Connected polyline series.
class LineSeriesLine series options.
interface LineSeriesOptions| strokeWidth? | number | undefined |
| lineStyle? | LineStyle | undefined |
| name? | string | undefined |
| color? | ColorInput | undefined |
Line style — maps to the legacy `eCD_LineStyle` enum. `"solid"` — LS_SOLID_LINE `"dashed"` — LS_DASH_LINE `"dotted"` — LS_DOT_LINE `"dash-dot"` — LS_DASH_DOT_LINE
type LineStyle = LineStyleFired when a series changes LOD level after zoom/pan/resize.
interface LodChangeEvent| seriesId | string |
| previous | LodLevel |
| level | LodLevel |
| sourceCount | number |
| renderCount | number |
One stop on a color lookup table.
interface LutStep| value | number |
| color | ColorInput |
Value / symbol marker — the FacMarker `FMT_SYMBOLMARKER` / `FMT_CURSOR` / `FMT_DISPLAYLINE` family. Defaults match the original DynamicCharts / FacadeMulti markers: triangle-down on the trace, vertical hairline, label above, follow-Y when {@link MarkerConfig.snapToSeries} is set.
interface MarkerConfig| id | string |
| kind | "symbol" | "normal" | "cursor" | "display-line" |
| position | MarkerPosition |
| shape? | MarkerShape | undefined |
| size? | number | undefined |
| color? | ColorInput | undefined |
| label? | string | undefined |
| labelPlacement? | MarkerLabelPlacement | undefined |
| formatLabel? | ((x: number, y: number) => string) | undefined |
| token? | string | undefined |
| line? | MarkerLine | undefined |
| lineVisible? | boolean | undefined |
| symbolVisible? | boolean | undefined |
| draggable? | boolean | undefined |
| snapToSeries? | string | undefined |
| followX? | boolean | undefined |
Label placement relative to the symbol. Maps to original `FTHA_*` / `FTVA_*` FacMarker text alignments.
type MarkerLabelPlacement = MarkerLabelPlacementFacMarker-parity value / delta / range markers.
class MarkerLayerHairline drawn through the plot at the marker. Maps to original `eCD_FacLineOrientation` (`FLO_VLINE` / `FLO_HLINE` / `FLO_CROSS`).
type MarkerLine = MarkerLineinterface MarkerPosition| mode | MarkerPositionMode |
| x | number |
| y | number |
`"absolute"` positions are data-space values and pan/zoom with the chart. `"relative"` positions are `[0, 1]` fractions of the current visible axis range, so the marker stays anchored to the viewport (e.g. "top-right of whatever is on screen") as the user pans or zooms.
type MarkerPositionMode = MarkerPositionModeSymbol shapes. Maps to original `eCD_SymbolType` / `HotSpotSymbolType` (triangle-down ≈ `ST_TRIANGLE_DOWN` / `FSYT_TOKEN_DOWN`).
type MarkerShape = MarkerShapeLookup nearest sample on a series by id — used for follow-X/Y.
type MarkerSnapLookup = MarkerSnapLookupResolve a `components` option (boolean shorthand, partial override, or `undefined`) against the full-on default.
(next: boolean | XYChartComponents | undefined, current?: Required<XYChartComponents>) => Required<XYChartComponents>(current: Required<UserInteractions>, next: boolean | UserInteractions) => Required<UserInteractions>Every component off — a bare plot with just axes and series.
Required<XYChartComponents>Minor ticks between consecutive major ticks (4 subdivisions).
(major: readonly AxisTick[], min: number, max: number) => AxisTick[]Mount a sweep status bar into `options.container`.
(options: SweepStatusBarOptions) => SweepStatusBarNearest sample in screen space, or `undefined` when the series is empty.
(x: Float64Array, y: Float64Array, coords: RekhlyCoordinates, pointerX: number, pointerY: number) => { index: number; x: number; y: number; distance: number; } | undefined(input: number | Partial<ThemePadding>, fallback: ThemePadding) => ThemePaddingCopy public XY input into owned Float64 arrays. Object-form points are converted once. Typed-array inputs are copied so later caller mutations cannot alias internal storage.
(data: XYData) => { x: Float64Array; y: Float64Array; }Axis / tooltip formatters (scientific, engineering, time, category).
type NumberFormatStyle = NumberFormatStyleInclusive numeric interval in data space.
interface NumericRange| min | number |
| max | number |
Real-time scrolling/triggered waveform display. Reuses `chartXY`'s sweep axis and ring-buffered series for the scrolling (`"free-run"`) case — defaulting to a single `"sweep-once"` pass, matching a real scope's single-shot mode (use `chart.setSweepMode("sweep-multi")` for a repeating sweep, or `"continuous"` for the old trailing-window scroll); `"triggered"` mode additionally searches each incoming batch for a level/edge crossing and locks the visible window to it, like a normal-mode oscilloscope sweep.
class OscilloscopeCharttype OscilloscopeMode = OscilloscopeModeinterface OscilloscopeOptions| windowWidth | number |
| mode? | OscilloscopeMode | undefined |
| triggerLevel? | number | undefined |
| triggerEdge? | TriggerEdge | undefined |
| pretrigger? | number | undefined |
| capacity? | number | undefined |
| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| autoResize? | boolean | undefined |
| pixelRatio? | number | undefined |
| width? | number | undefined |
| height? | number | undefined |
| components? | boolean | XYChartComponents | undefined |
| captureDistance? | number | undefined |
| locale? | Locale | undefined |
| translations? | Partial<MessageTable> | undefined |
| titlePosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
| titleOffset? | number | undefined |
| toolbarPosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | "outside-bottom" | undefined |
| controlsPosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
readonly ("top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center")[]type OverlayAlign = OverlayAlignOverlay cursor + tooltip: a crosshair (vertical/horizontal/both lines) plus a positioned tooltip, drawn into a chart's DOM overlay. Shared by `chartXY` and `FinancialChart` — any chart with a pixel-space hit test can drive one.
class OverlayCursorCorner/edge/center anchor for chart overlay chrome (title, legend, toolbar, restore/box-zoom buttons) — a 3x3 grid: `{top,middle,bottom}` x `{left,center,right}`.
type OverlayPosition = "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center"type OverlayRow = OverlayRowPixel rect of the viewport brush inside the overview host.
interface OverviewBrushRect| left | number |
| top | number |
| width | number |
| height | number |
| visible | boolean |
One vertical measurement axis in a parallel-coordinate chart.
class ParallelAxisinterface ParallelChartOptions| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
Parallel-coordinate chart: one polyline per sample across N axes, optional LUT coloring, and AND-combined range selectors.
class ParallelCoordinateChartclass ParallelRangeHandleinterface ParallelRangeSelector| axis | string |
| min | number |
| max | number |
class ParallelSeriesRolling performance monitor. HUD is **off** unless explicitly enabled.
class PerformanceMonitorPhosphor/persistence intensity buffer: repeatedly traced curves accumulate brightness and decay over time, the classic analog oscilloscope "density" trace.
class PersistenceBufferclass PieChartPlot rectangle in CSS pixels relative to the host.
interface PlotRect| left | number |
| top | number |
| width | number |
| height | number |
class PolarAmplitudeAxisFirst-class polar chart: line, area, point, sector, and polar heatmap.
class PolarChartinterface PolarChartOptions| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
class PolarHeatmapSeriesclass PolarLineSeriesRadial axis: angle 0 location, wind direction, and spoke count. Default matches common polar convention: angle 0 at east, increasing counter-clockwise. `setNorth(0)` places angle 0 at the top.
class PolarRadialAxisinterface PolarSample| angle | number |
| amplitude | number |
class PolarSectorSeriesinterface PolarSeriesOptions| name? | string | undefined |
| color? | ColorInput | undefined |
interface PolygonDatum| points | readonly { readonly x: number; readonly y: number; }[] |
Filled polygons in data space.
class PolygonSeriesRekhly binary stream frame (little-endian). ``` 0 magic u32 "FLXB" (0x464C5842) 4 version u16 6 pad u16 8 streamId u32 12 seriesId u32 16 timestamp f64 (unix ms) 24 count u32 28 dtype u8 0 = f32, 1 = f64 29 pad u8[3] 32 x[count] f32|f64 y[count] f32|f64 ``` Header is 32 bytes so f64 payloads stay 8-byte aligned. JSON / MessagePack are non-hot optional paths.
1interface PyramidChart| ready | Promise<void> |
| setItems | (items: readonly NamedValue[]) => PyramidChart |
| dispose | () => void |
class RadarChartRange band marker — FacMarker `FMT_RANGEMARKER`.
interface RangeMarkerConfig| id | string |
| kind | "range" |
| x0 | number |
| x1 | number |
| y0? | number | undefined |
| y1? | number | undefined |
| color? | ColorInput | undefined |
| label? | string | undefined |
| labelPlacement? | MarkerLabelPlacement | undefined |
| draggable? | boolean | undefined |
interface RectangleDatum| x1 | number |
| y1 | number |
| x2 | number |
| y2 | number |
Axis-aligned rectangles — histograms, range highlights, occupancy cells.
class RectangleSeriesA point on (or inside) the unit circle: the reflection coefficient Γ.
interface ReflectionPoint| re | number |
| im | number |
Mutable coordinate space bound to live axes and layout.
class RekhlyCoordinatesLinear axis with a customizable tick provider.
class RekhlyLinearAxisResolve a value marker to data-space coordinates, applying FollowY (and optional FollowX) when {@link MarkerConfig.snapToSeries} is set.
(item: MarkerConfig, xAxis: LinearAxis, yAxis: LinearAxis, lookup?: MarkerSnapLookup) => { x: number; y: number; }Small overlay button shown once the view has been zoomed/panned away from the fitted domain. Clicking it restores the original view.
class RestoreViewButtonFixed-capacity XY ring. Oldest samples are overwritten. `readInto` copies into caller-owned arrays so a streaming series can reuse pooled storage instead of allocating every append.
class RingBufferclass SankeyChartDiscrete point series.
class ScatterSeriesScatter series options.
interface ScatterSeriesOptions| pointSize? | number | undefined |
| name? | string | undefined |
| color? | ColorInput | undefined |
CSS pixel → clip space.
(x: number, y: number, css: ViewportSize) => ScreenPointinterface SegmentDatum| x1 | number |
| y1 | number |
| x2 | number |
| y2 | number |
Discrete line segments (error ticks, connectors, range bars).
class SegmentSeriestype SeriesKind = SeriesKindShared series options.
interface SeriesOptions| name? | string | undefined |
| color? | ColorInput | undefined |
interface SeriesSelectEvent| selected | readonly ParallelSeries[] |
interface Slice| label | string |
| value | number |
RF/impedance Smith chart: constant-resistance and constant-reactance grid over the unit disk, plus reflection-coefficient (Γ) series.
class SmithChartinterface SmithChartOptions| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
| z0? | number | undefined |
class SmithSeriesinterface SmithSeriesOptions| name? | string | undefined |
| color? | ColorInput | undefined |
interface SparkChart| type | SparkKind |
| data | readonly number[] | readonly { readonly x: number; readonly y: number; }[] |
| color? | string | undefined |
type SparkKind = SparkKindScrolling time × frequency spectrogram. A thin convenience over {@link HeatmapChart}: `pushFrame` runs a DFT on a raw time-domain frame and appends the resulting magnitude column.
class SpectrogramChartinterface SpectrogramChartOptions| columns? | number | undefined |
| bins? | number | undefined |
| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| width? | number | undefined |
| height? | number | undefined |
| low? | ColorInput | undefined |
| high? | ColorInput | undefined |
Build a scrolling spectrogram heatmap (time × frequency).
(frames: readonly ArrayLike<number>[], bins: number) => HeatmapMatrixclass SplineSeriesStacked area bands on a shared X.
class StackedAreaSeriesSeveral bar series stacked on a shared X.
class StackedBarSeriesclass StepSeriesWebSocket client. Binary frames are preferred; JSON is the slow path. Control ops (subscribe / pause / frequency) are small JSON messages and are not on the sample hot path.
class StreamClientPause/resume + backpressure in front of one or more sinks. Bind `seriesId` → {@link SampleSink}. Incoming frames are queued and flushed on {@link StreamSession.flush} (typically once per animation frame).
class StreamSessionState of a toolbar-driven sweep (see {@link XYChart.setSweepSource}): `"idle"` before the first run or after Sweep Once finishes on its own, `"running"` while a sweep is active, `"aborted"` after a running sweep was stopped early via {@link XYChart.stopSweep} (or a second click on its toolbar button).
type SweepStatus = SweepStatusA small label + activity-track widget reflecting one or more charts' {@link SweepStatus} (Idle / Running / Aborted) — the built-in toolbar's Sweep Once / Sweep Continuously state.
interface SweepStatusBar| attach | (chart: XYChart) => () => void |
| setLocale | (locale: Locale) => void |
| addTranslations | (table: PartialMessages) => void |
| applyTheme | (theme: Theme) => void |
| dispose | () => void |
Options for {@link mountSweepStatusBar}.
interface SweepStatusBarOptions| container | HTMLElement |
| segments? | number | undefined |
| locale? | Locale | undefined |
| translations? | Partial<MessageTable> | undefined |
| translator? | Translator | undefined |
Which axes {@link SyncGroup} mirrors across charts. Maps to original `CDSupplier.ZoomMultipleDiagrams` (shared zoom groups).
type SyncAxes = SyncAxesShared visible-range + cursor group. Adding a chart wires zoom/pan and cursor automatically. Use `axes: "xy"` to mirror both axes (multi-pane facade zoom groups).
class SyncGroupinterface SyncGroupOptions| axes? | SyncAxes | undefined |
Custom tick generator hook.
type TickProvider = TickProvider(min: number, max: number, countHint: number, timeZone?: "utc" | "local") => { value: number; label: string; major: boolean; }[]type ToolbarAction = ToolbarActionclass TreemapCharttype TriggerEdge = TriggerEdgeBuilt-in pointer / wheel gestures a chart can toggle independently.
interface UserInteractions| zoom? | boolean | undefined |
| pan? | boolean | undefined |
| rectangleZoom? | boolean | undefined |
| restore? | boolean | undefined |
One vector: an arrow anchored at `(x, y)` with data-space components `(dx, dy)`.
interface VectorDatum| x | number |
| y | number |
| dx | number |
| dy | number |
Vector field / quiver plot: an arrow per grid point, shaft length and direction from data-space `(dx, dy)`, arrowhead sized in fixed CSS pixels.
class VectorFieldSeriesinterface ViewChangeEvent| x | NumericRange |
| y | NumericRange |
class ViolinSeriesclass WaterfallSeriesTyped-array XY dataset. `x` and `y` must have the same length.
interface XYBuffer| x | Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike> |
| y | Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike> |
Interactive Cartesian chart.
interface XYChart| ready | Promise<void> |
| engine | Engine |
| scene | Scene |
| disposed | boolean |
| xAxis | LinearAxis |
| yAxis | LinearAxis |
| cursor | CursorController |
| coordinates | CoordinateSpace |
| overlay | HTMLElement |
| theme | Theme |
| hud | PerformanceMonitor |
| legend | ChartLegend |
| annotations | AnnotationLayer |
| animations | AnimationController |
| markers | MarkerLayer |
| limitLines | LimitLineLayer |
| detectionBars | DetectionBarLayer |
| setLegendOptions | (options: LegendOptions) => XYChart |
| getComponents | () => Required<XYChartComponents> |
| setComponents | (next: boolean | XYChartComponents) => XYChart |
| use | (plugin: ChartPlugin) => XYChart |
| enableHud | () => XYChart |
| disableHud | () => XYChart |
| onLodChange | (handler: (event: LodChangeEvent) => void) => () => void |
| addLineSeries | (options?: LineSeriesOptions) => LineSeries |
| addScatterSeries | (options?: ScatterSeriesOptions) => ScatterSeries |
| addBarSeries | (options?: BarSeriesOptions) => BarSeries |
| addAreaSeries | (options?: AreaSeriesOptions) => AreaSeries |
| addStepSeries | (options?: LineSeriesOptions) => StepSeries |
| addSplineSeries | (options?: LineSeriesOptions) => SplineSeries |
| addBandSeries | (options?: LineSeriesOptions) => BandSeries |
| addHorizontalBarSeries | (options?: BarSeriesOptions) => HorizontalBarSeries |
| addBubbleSeries | (options?: ScatterSeriesOptions) => BubbleSeries |
| addErrorBarSeries | (options?: LineSeriesOptions) => ErrorBarSeries |
| addWaterfallSeries | (options?: BarSeriesOptions) => WaterfallSeries |
| addViolinSeries | (options?: LineSeriesOptions) => ViolinSeries |
| addPointSeries | (options?: ScatterSeriesOptions) => ScatterSeries |
| addHistogramSeries | (values: ArrayLike<number>, bins?: number) => BarSeries |
| addColumnSeries | (options?: BarSeriesOptions) => BarSeries |
| addStackedBarSeries | (options?: BarSeriesOptions) => StackedBarSeries |
| addStackedAreaSeries | (options?: AreaSeriesOptions) => StackedAreaSeries |
| addBoxPlotSeries | (options?: SeriesOptions) => BoxPlotSeries |
| addRectangleSeries | (options?: SeriesOptions) => RectangleSeries |
| addEllipseSeries | (options?: SeriesOptions) => EllipseSeries |
| addPolygonSeries | (options?: SeriesOptions) => PolygonSeries |
| addSegmentSeries | (options?: SeriesOptions) => SegmentSeries |
| addConstantLine | (options?: SeriesOptions) => ConstantLineSeries |
| addConstantBand | (options?: SeriesOptions) => ConstantBandSeries |
| addVectorSeries | (options?: SeriesOptions) => VectorFieldSeries |
| addYAxis | (options?: { readonly id?: string; }) => LinearAxis |
| setTitle | (title: string) => XYChart |
| setPadding | (padding: number | Partial<ThemePadding>) => XYChart |
| setUserInteractions | (next: boolean | UserInteractions) => XYChart |
| setZoomMode | (active: boolean) => XYChart |
| getZoomMode | () => boolean |
| setZoomConstraint | (axis: "x" | "y" | "both") => XYChart |
| getZoomConstraint | () => "x" | "y" | "both" |
| setCaptureDistance | (px: number) => XYChart |
| getCaptureDistance | () => number |
| pauseStreaming | () => XYChart |
| resumeStreaming | () => XYChart |
| flushIngest | () => XYChart |
| setSweepMode | (mode: "continuous" | "sweep-once" | "sweep-multi" | "none") => XYChart |
| getSweepMode | () => "continuous" | "sweep-once" | "sweep-multi" | "none" |
| setSweepSource | { (source: undefined): XYChart; (source: (frame: number) => void, options: { readonly totalFrames: number; readonly intervalMs?: number; }): XYChart; } |
| runSweepOnce | () => XYChart |
| runSweepRepeat | () => XYChart |
| stopSweep | () => XYChart |
| getSweepStatus | () => SweepStatus |
| getActiveSweepAction | () => "sweep-once" | "sweep-multi" | undefined |
| onSweepStatus | (handler: (status: SweepStatus) => void) => () => void |
| zoomIn | () => XYChart |
| zoomOut | () => XYChart |
| setTitlePosition | (position: OverlayPosition, dy?: number) => XYChart |
| setToolbarPosition | (position: OverlayPosition | "outside-bottom") => XYChart |
| setControlsPosition | (position: OverlayPosition) => XYChart |
| onViewChange | (handler: (event: { x: NumericRange; y: NumericRange; }) => void) => () => void |
| onCursorSync | (handler: (payload: { x: number; y: number; values: readonly TooltipSeriesValue[]; }) => void) => () => void |
| syncCursorFrom | (x: number, y: number, values: readonly TooltipSeriesValue[]) => void |
| zoom | (factor: number, anchor?: { x: number; y: number; }) => XYChart |
| pan | (dxPx: number, dyPx: number) => XYChart |
| restorePreviousView | () => XYChart |
| resetView | () => XYChart |
| setTheme | (theme: "light" | "dark" | Theme) => XYChart |
| setLocale | (locale: Locale) => XYChart |
| getLocale | () => Locale |
| addTranslations | (table: PartialMessages) => XYChart |
| fitView | () => XYChart |
| resize | (width?: number, height?: number) => void |
| render | () => void |
| serialize | () => ChartConfig |
| dispose | () => void |
| getSeries | () => readonly XYSeries[] |
Built-in optional visual systems on {@link XYChart}. Every flag defaults to `true` — a fresh `chartXY()` looks and behaves exactly like it always has. Turn individual pieces off (or start from {@link CHART_PRESETS}) to build a leaner chart without touching any rendering code. Disabling a component only stops it from rendering — the underlying object (`chart.legend`, `chart.markers`, …) is still there, so code that calls `chart.markers.add(...)` never throws, it just has no visible effect until the component is turned back on.
interface XYChartComponents| legend? | boolean | undefined |
| cursor? | boolean | undefined |
| markers? | boolean | undefined |
| limitLines? | boolean | undefined |
| detectionBars? | boolean | undefined |
| annotations? | boolean | undefined |
| restoreButton? | boolean | undefined |
| toolbar? | boolean | undefined |
| overview? | boolean | { position?: OverlayPosition; width?: number; height?: number; relativeWidth?: number; relativeHeight?: number; brushFill?: string; brushBorder?: string; background?: string; clickMovesViewport?: boolean; showTraces?: boolean; showMarkers?: boolean; } | undefined |
Construction options for {@link chartXY}.
interface XYChartOptions| container | string | HTMLElement |
| canvas? | HTMLCanvasElement | undefined |
| theme? | Theme | BuiltinThemeName | undefined |
| renderer? | RendererPrefs | undefined |
| autoResize? | boolean | undefined |
| pixelRatio? | number | undefined |
| width? | number | undefined |
| height? | number | undefined |
| components? | boolean | XYChartComponents | undefined |
| captureDistance? | number | undefined |
| locale? | Locale | undefined |
| translations? | Partial<MessageTable> | undefined |
| titlePosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
| titleOffset? | number | undefined |
| toolbarPosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | "outside-bottom" | undefined |
| controlsPosition? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
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 |
Base typed-array XY series.
class XYSeriesSmall toolbar button that toggles box-zoom mode: click it once, then drag a rectangle on the chart to zoom into it. Auto-untoggles after one drag. Sits next to {@link RestoreViewButton }.
class ZoomModeButtonMiniature navigator under a main XY chart (original `CZoomOverview`). The cyan brush is the **main viewport** mapped into the overview's plot rectangle (not the full host — so axis padding cannot skew the brush). After every zoom/pan the brush updates via {@link XYChart.onViewChange} (one-shot `requestFrame` does not emit engine `"frame"` events).
class ZoomOverviewOptions for {@link ZoomOverview} — maps to original `CZoomOverview` / `CDSupplier` zoom-overview settings (`ShowTraces`, `RelativeWidth`, `ClickZoomOverviewMovesViewport`, brush chrome).
interface ZoomOverviewOptions| container | HTMLElement |
| width? | number | undefined |
| height? | number | undefined |
| relativeWidth? | number | undefined |
| relativeHeight? | number | undefined |
| position? | "top-right" | "top-left" | "top-center" | "bottom-right" | "bottom-left" | "bottom-center" | "middle-right" | "middle-left" | "middle-center" | undefined |
| brushFill? | string | undefined |
| brushBorder? | string | undefined |
| background? | string | undefined |
| clickMovesViewport? | boolean | undefined |
| showTraces? | boolean | undefined |
| showMarkers? | boolean | undefined |
Got any questions? I'm happy to help with products, licensing, and examples.