@photonviz/core 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -196,6 +196,51 @@ declare class BoxLayer implements Layer {
     dispose(): void;
 }
 
+interface CandlestickOptions {
+    /** Candle positions (data space — e.g. epoch ms on a time axis). */
+    x: ArrayLike<number>;
+    open: ArrayLike<number>;
+    high: ArrayLike<number>;
+    low: ArrayLike<number>;
+    close: ArrayLike<number>;
+    /** Body width in data units. Defaults to 70% of the median spacing. */
+    width?: number;
+    /** Close ≥ open color. Default green. */
+    upColor?: string | Color;
+    /** Close < open color. Default red. */
+    downColor?: string | Color;
+    /** Wick thickness in CSS px. Default 1.5. */
+    wickWidth?: number;
+    name?: string;
+    yAxis?: string;
+}
+declare class CandlestickLayer implements Layer {
+    readonly id: string;
+    readonly name: string;
+    readonly colorCss: string;
+    readonly yAxis: string;
+    private gl;
+    private progs;
+    private bodyVao;
+    private wickVao;
+    private buffers;
+    private uBody;
+    private uWick;
+    private wickWidth;
+    private count;
+    private xRef;
+    private yRef;
+    private xBounds;
+    private yBounds;
+    constructor(gl: WebGL2RenderingContext, opts: CandlestickOptions);
+    bounds(): {
+        x: Range;
+        y: Range;
+    } | null;
+    draw(state: DrawState): void;
+    dispose(): void;
+}
+
 type RGB = [number, number, number];
 type ColormapName = "viridis" | "plasma" | "coolwarm" | "grayscale";
 /** Returns a `(t in 0..1) => RGB` sampler for the named colormap. */
@@ -238,6 +283,68 @@ declare class ContourLayer implements Layer {
     dispose(): void;
 }
 
+/** A per-point error, given as one value for all points or an array. */
+type ErrInput = ArrayLike<number> | number;
+interface ErrorBarOptions {
+    x: ArrayLike<number>;
+    y: ArrayLike<number>;
+    /** Symmetric y error (half-height). Scalar or per-point. */
+    yerr?: ErrInput;
+    /** Asymmetric y error below/above `y` (overrides `yerr`). */
+    yerrLow?: ErrInput;
+    yerrHigh?: ErrInput;
+    /** Symmetric x error (half-width). Scalar or per-point. */
+    xerr?: ErrInput;
+    color?: string | Color;
+    /** Whisker/cap thickness in CSS px. Default 1.5. */
+    width?: number;
+    /** Cap length in CSS px (0 hides caps). Default 6. */
+    capSize?: number;
+    /** Draw I-beam whiskers. Default true. */
+    whiskers?: boolean;
+    /** Fill a shaded band between the low/high y bounds. Default false. */
+    band?: boolean;
+    /** Band fill opacity. Default 0.2. */
+    bandOpacity?: number;
+    name?: string;
+    yAxis?: string;
+}
+declare class ErrorBarLayer implements Layer {
+    readonly id: string;
+    readonly name: string;
+    readonly colorCss: string;
+    readonly yAxis: string;
+    private gl;
+    private progs;
+    private segVao;
+    private capVao;
+    private bandVao;
+    private buffers;
+    private uSeg;
+    private uCap;
+    private uBand;
+    private color;
+    private width;
+    private capSize;
+    private bandOpacity;
+    private showWhiskers;
+    private showBand;
+    private segCount;
+    private capCount;
+    private bandVerts;
+    private xRef;
+    private yRef;
+    private xBounds;
+    private yBounds;
+    constructor(gl: WebGL2RenderingContext, opts: ErrorBarOptions);
+    bounds(): {
+        x: Range;
+        y: Range;
+    } | null;
+    draw(state: DrawState): void;
+    dispose(): void;
+}
+
 interface HeatmapOptions {
     /** Row-major grid values, length `cols * rows` (row 0 at the bottom). */
     values: ArrayLike<number>;
@@ -309,6 +416,8 @@ declare class HexbinLayer implements Layer {
     dispose(): void;
 }
 
+/** How adjacent segments meet at a vertex. */
+type LineJoin = "round" | "miter" | "bevel" | "butt";
 interface LineOptions {
     x: ArrayLike<number>;
     y: ArrayLike<number>;
@@ -318,8 +427,20 @@ interface LineOptions {
     name?: string;
     yAxis?: string;
     step?: "before" | "after" | "center";
-    /** Round joins/caps (default) or square/butt ends. */
-    join?: "round" | "butt";
+    /**
+     * How segments meet at each vertex:
+     *  - `round` (default) — round caps and joins via an SDF; no seams.
+     *  - `miter` — sharp mitered corners, clamped to {@link LineOptions.miterLimit}.
+     *  - `bevel` — corners cut flat.
+     *  - `butt` — flat ends with no join fill (segments may gap at sharp angles).
+     */
+    join?: LineJoin;
+    /**
+     * For `join: "miter"`, the max ratio of miter length to half line-width before
+     * a corner falls back to a bevel (prevents spikes at very sharp angles).
+     * Default 4.
+     */
+    miterLimit?: number;
     /**
      * Min/max decimate very large series to ~2 points per pixel column when
      * zoomed out (preserves peaks). Requires monotonic x; auto-detected. Default true.
@@ -333,18 +454,25 @@ declare class LineLayer implements Layer {
     readonly yAxis: string;
     private gl;
     private program;
+    private joinProgram;
     private fullVao;
     private decVao;
+    private joinFullVao;
+    private joinDecVao;
     private cornerBuf;
     private posBuf;
     private decBuf;
     private uniforms;
+    private joinUniforms;
     private count;
     private color;
     private width;
     private round;
+    private joinStyle;
+    private miterLimit;
     private decimateOn;
     private monotonic;
+    private gpuDec;
     private step?;
     private xRef;
     private yRef;
@@ -355,7 +483,10 @@ declare class LineLayer implements Layer {
     private decKey;
     private decSegments;
     constructor(gl: WebGL2RenderingContext, opts: LineOptions);
+    private syncGpu;
+    private disposeGpu;
     private configureVao;
+    private configureJoinVao;
     bounds(): {
         x: Range;
         y: Range;
@@ -376,6 +507,60 @@ declare class LineLayer implements Layer {
     dispose(): void;
 }
 
+interface QuiverOptions {
+    /** Arrow anchor positions (data space). */
+    x: ArrayLike<number>;
+    y: ArrayLike<number>;
+    /** Vector components at each anchor. */
+    u: ArrayLike<number>;
+    v: ArrayLike<number>;
+    /** Multiplier applied to (u,v) in data units. Default auto-fits the field. */
+    scale?: number;
+    color?: string | Color;
+    /** Shaft thickness in CSS px. Default 1.5. */
+    width?: number;
+    /** Arrowhead length in CSS px. Default 9. */
+    headSize?: number;
+    /** Color each arrow by a value (default: its magnitude) through a colormap. */
+    colorBy?: {
+        values?: ArrayLike<number>;
+        colormap?: ColormapName;
+        domain?: Range;
+    };
+    name?: string;
+    yAxis?: string;
+}
+declare class QuiverLayer implements Layer {
+    readonly id: string;
+    readonly name: string;
+    readonly colorCss: string;
+    readonly yAxis: string;
+    private gl;
+    private progs;
+    private shaftVao;
+    private headVao;
+    private buffers;
+    private uShaft;
+    private uHead;
+    private color;
+    private width;
+    private headSize;
+    private useVertexColor;
+    private count;
+    private xRef;
+    private yRef;
+    private xBounds;
+    private yBounds;
+    constructor(gl: WebGL2RenderingContext, opts: QuiverOptions);
+    private bindInstanceAttribs;
+    bounds(): {
+        x: Range;
+        y: Range;
+    } | null;
+    draw(state: DrawState): void;
+    dispose(): void;
+}
+
 interface ScatterOptions {
     x: ArrayLike<number>;
     y: ArrayLike<number>;
@@ -428,6 +613,56 @@ declare class ScatterLayer implements Layer {
     dispose(): void;
 }
 
+interface StemOptions {
+    x: ArrayLike<number>;
+    y: ArrayLike<number>;
+    /** Where stems start. Default 0. */
+    baseline?: number;
+    color?: string | Color;
+    /** Stem thickness in CSS px. Default 1.5. */
+    width?: number;
+    /** Tip marker diameter in CSS px (0 hides). Default 6. */
+    markerSize?: number;
+    name?: string;
+    yAxis?: string;
+}
+declare class StemLayer implements Layer {
+    readonly id: string;
+    readonly name: string;
+    readonly colorCss: string;
+    readonly yAxis: string;
+    private gl;
+    private progs;
+    private stemVao;
+    private markerVao;
+    private buffers;
+    private uStem;
+    private uMarker;
+    private color;
+    private width;
+    private markerSize;
+    private count;
+    private baseline;
+    private xRef;
+    private yRef;
+    private xs;
+    private ys;
+    private xBounds;
+    private yBounds;
+    constructor(gl: WebGL2RenderingContext, opts: StemOptions);
+    bounds(): {
+        x: Range;
+        y: Range;
+    } | null;
+    nearestByX(x: number): {
+        x: number;
+        y: number;
+        index: number;
+    } | null;
+    draw(state: DrawState): void;
+    dispose(): void;
+}
+
 /**
  * A scale maps data-space values to normalized [0,1] and back, and knows how to
  * generate its own "nice" ticks + default label format. `log` tells layers to
@@ -587,6 +822,10 @@ declare class Plot {
     addBox(opts: BoxOptions): BoxLayer;
     addHexbin(opts: HexbinOptions): HexbinLayer;
     addContour(opts: ContourOptions): ContourLayer;
+    addErrorBar(opts: ErrorBarOptions): ErrorBarLayer;
+    addStem(opts: StemOptions): StemLayer;
+    addQuiver(opts: QuiverOptions): QuiverLayer;
+    addCandlestick(opts: CandlestickOptions): CandlestickLayer;
     /** Compute an STFT of `signal` and render it as a heatmap (time × frequency). */
     addHeatmapSpectrogram(signal: ArrayLike<number>, opts?: {
         fftSize?: number;
@@ -958,4 +1197,4 @@ declare function parseColor(input: string): [number, number, number, number];
 /** Normalized RGBA (0..1) back to a CSS `rgba(...)` string. */
 declare function toColorCss(c: readonly [number, number, number, number]): string;
 
-export { AreaLayer, type AreaOptions, Axis, type AxisConfig, type AxisFrame, type AxisScaleOptions, BarLayer, type BarOptions, type Bounds, type Bounds3, type BoxGroup, BoxLayer, type BoxOptions, type BoxStats, type Color, type ColormapName, ContourLayer, type ContourOptions, type Density, type Dim, type DrawState, HeatmapLayer, type HeatmapOptions, HexbinLayer, type HexbinOptions, type Histogram, type InteractionMode, type Layer, type Layer3D, type Layout, LineLayer, type LineOptions, LinearScale, LogScale, Plot, Plot3D, type Plot3DOptions, type PlotOptions, PointCloudLayer, type PointCloudOptions, type PolarLineOptions, type PolarOptions, PolarPlot, type PolarScatterOptions, type PolarSeries, type RGB, type Range, type Scale, type ScaleType, ScatterLayer, type ScatterOptions, type Spectrogram, SurfaceLayer, type SurfaceOptions, type Theme, type Tick, type TicksSpec, TimeScale, type ToolbarHost, type ToolbarTheme, type YAxisOptions, autoTicks, boxStats, colormap, createToolbar, darkTheme, defaultFormat, fft, histogram, kde, lightTheme, makeScale, parseColor, quantileSorted, resolveTicks, spectrogram, toColorCss, withMinorTicks };
+export { AreaLayer, type AreaOptions, Axis, type AxisConfig, type AxisFrame, type AxisScaleOptions, BarLayer, type BarOptions, type Bounds, type Bounds3, type BoxGroup, BoxLayer, type BoxOptions, type BoxStats, CandlestickLayer, type CandlestickOptions, type Color, type ColormapName, ContourLayer, type ContourOptions, type Density, type Dim, type DrawState, ErrorBarLayer, type ErrorBarOptions, HeatmapLayer, type HeatmapOptions, HexbinLayer, type HexbinOptions, type Histogram, type InteractionMode, type Layer, type Layer3D, type Layout, LineLayer, type LineOptions, LinearScale, LogScale, Plot, Plot3D, type Plot3DOptions, type PlotOptions, PointCloudLayer, type PointCloudOptions, type PolarLineOptions, type PolarOptions, PolarPlot, type PolarScatterOptions, type PolarSeries, QuiverLayer, type QuiverOptions, type RGB, type Range, type Scale, type ScaleType, ScatterLayer, type ScatterOptions, type Spectrogram, StemLayer, type StemOptions, SurfaceLayer, type SurfaceOptions, type Theme, type Tick, type TicksSpec, TimeScale, type ToolbarHost, type ToolbarTheme, type YAxisOptions, autoTicks, boxStats, colormap, createToolbar, darkTheme, defaultFormat, fft, histogram, kde, lightTheme, makeScale, parseColor, quantileSorted, resolveTicks, spectrogram, toColorCss, withMinorTicks };