wickchart 1.3.0 → 1.5.0

package/types/wick-chart.d.ts

@@ -172,6 +172,12 @@ declare class WickChart extends HTMLElementBase {
         idxAtMid: number;
         midX: number;
     };
+    _layers: any[];
+    _layerClaim: {
+        layer: any;
+        pointerId: any;
+    };
+    _layerSeq: number;
     _loadingMore: boolean;
     _noMore: boolean;
     _positions: any[];
@@ -240,11 +246,12 @@ declare class WickChart extends HTMLElementBase {
             fast?: undefined;
             slow?: undefined;
             signal?: undefined;
+            smooth?: undefined;
         };
         compute: (bars: any, p: any) => number[];
-        range?: undefined;
         color?: undefined;
         guides?: undefined;
+        range?: undefined;
         fmt?: undefined;
     } | {
         kind: string;
@@ -254,11 +261,62 @@ declare class WickChart extends HTMLElementBase {
             fast?: undefined;
             slow?: undefined;
             signal?: undefined;
+            smooth?: undefined;
+        };
+        compute: (bars: any, p: any) => number[];
+        color?: undefined;
+        guides?: undefined;
+        range?: undefined;
+        fmt?: undefined;
+    } | {
+        kind: string;
+        params: {
+            mult?: undefined;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            smooth?: undefined;
+            period?: undefined;
+        };
+        compute: (bars: any) => number[];
+        color?: undefined;
+        guides?: undefined;
+        range?: undefined;
+        fmt?: undefined;
+    } | {
+        kind: string;
+        params: {
+            period: number;
+            mult: number;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            smooth?: undefined;
         };
         compute: (bars: any, p: any) => number[];
+        color?: undefined;
+        guides?: undefined;
         range?: undefined;
+        fmt?: undefined;
+    } | {
+        kind: string;
+        params: {
+            period: number;
+            mult?: undefined;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            smooth?: undefined;
+        };
+        compute: (bars: any, p: any) => {
+            lines: {
+                name: string;
+                values: number[];
+            }[];
+        };
         color?: undefined;
         guides?: undefined;
+        range?: undefined;
         fmt?: undefined;
     } | {
         kind: string;
@@ -268,6 +326,7 @@ declare class WickChart extends HTMLElementBase {
             fast?: undefined;
             slow?: undefined;
             signal?: undefined;
+            smooth?: undefined;
         };
         compute: (bars: any, p: any) => {
             lines: {
@@ -275,9 +334,29 @@ declare class WickChart extends HTMLElementBase {
                 values: number[];
             }[];
         };
+        color?: undefined;
+        guides?: undefined;
         range?: undefined;
+        fmt?: undefined;
+    } | {
+        kind: string;
+        params: {
+            period: number;
+            mult: number;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            smooth?: undefined;
+        };
+        compute: (bars: any, p: any) => {
+            lines: {
+                name: string;
+                values: number[];
+            }[];
+        };
         color?: undefined;
         guides?: undefined;
+        range?: undefined;
         fmt?: undefined;
     } | {
         kind: string;
@@ -287,6 +366,7 @@ declare class WickChart extends HTMLElementBase {
             fast?: undefined;
             slow?: undefined;
             signal?: undefined;
+            smooth?: undefined;
         };
         guides: number[];
         range: number[];
@@ -294,15 +374,15 @@ declare class WickChart extends HTMLElementBase {
         color: string;
         compute: (bars: any, p: any) => number[];
     } | {
-        range?: undefined;
         color?: undefined;
         kind: string;
         params: {
             mult?: undefined;
-            period?: undefined;
             fast: number;
             slow: number;
             signal: number;
+            smooth?: undefined;
+            period?: undefined;
         };
         guides: number[];
         fmt: string;
@@ -313,6 +393,87 @@ declare class WickChart extends HTMLElementBase {
             }[];
             histogram: number[];
         };
+        range?: undefined;
+    } | {
+        color?: undefined;
+        kind: string;
+        params: {
+            mult?: undefined;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            period: number;
+            smooth?: undefined;
+        };
+        fmt: string;
+        compute: (bars: any, p: any) => number[];
+        guides?: undefined;
+        range?: undefined;
+    } | {
+        color?: undefined;
+        kind: string;
+        params: {
+            mult?: undefined;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            period: number;
+            smooth: number;
+        };
+        guides: number[];
+        range: number[];
+        fmt: string;
+        compute: (bars: any, p: any) => {
+            lines: {
+                name: string;
+                values: number[];
+            }[];
+        };
+    } | {
+        color?: undefined;
+        kind: string;
+        params: {
+            mult?: undefined;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            smooth?: undefined;
+            period?: undefined;
+        };
+        fmt: string;
+        compute: (bars: any) => number[];
+        guides?: undefined;
+        range?: undefined;
+    } | {
+        color?: undefined;
+        kind: string;
+        params: {
+            mult?: undefined;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            smooth?: undefined;
+            period: number;
+        };
+        guides: number[];
+        fmt: string;
+        compute: (bars: any, p: any) => number[];
+        range?: undefined;
+    } | {
+        color?: undefined;
+        kind: string;
+        params: {
+            mult?: undefined;
+            fast?: undefined;
+            slow?: undefined;
+            signal?: undefined;
+            smooth?: undefined;
+            period: number;
+        };
+        guides: number[];
+        range: number[];
+        fmt: string;
+        compute: (bars: any, p: any) => number[];
     }>;
     /**
      * Register a custom indicator.
@@ -623,6 +784,75 @@ declare class WickChart extends HTMLElementBase {
     _updateLegend(): void;
     /** Position P&L chips (top-right HTML overlay). */
     _updateHud(): void;
+    /**
+     * Register a plugin layer. `layer.draw(api)` runs on every render, above
+     * chart content and under the crosshair; `layer.onPointer(pev)` is asked
+     * first on pointerdown and claims the gesture by returning true — the
+     * layer then receives that pointer's move/up/cancel events (plus a
+     * 'cancel' on Escape) and the chart suppresses its own pan/measure/brush
+     * for the duration.
+     * @param {{id?: string, draw: Function, onPointer?: Function}} layer
+     * @returns {object|null} the normalized layer handle (with `id`), or null
+     *   if the layer was rejected (no draw fn, or 16 layers already added)
+     */
+    addLayer(layer: {
+        id?: string;
+        draw: Function;
+        onPointer?: Function;
+    }): object | null;
+    /**
+     * Remove a layer added via addLayer (pass the returned handle or its id).
+     * @param {object|string} idOrLayer
+     * @returns {boolean} true if a layer was removed
+     */
+    removeLayer(idOrLayer: object | string): boolean;
+    /** Ask for a repaint on the next frame (interactive layers call this). */
+    requestDraw(): void;
+    /** Paint every registered layer. Called from _render with live state. */
+    _drawLayers(ctx: any, pal: any, ly: any, d: any): void;
+    /** Ask layers, in order, whether one claims this pointerdown. */
+    _layerHit(e: any, pt: any): any;
+    /** Deliver a pointer event to a claiming layer; never throws outward. */
+    _routeLayer(layer: any, e: any, pt: any, type: any): void;
+    _layerPointerEvent(e: any, pt: any, type: any): {
+        type: any;
+        x: any;
+        y: any;
+        pointerId: any;
+        button: any;
+        shiftKey: boolean;
+        ctrlKey: boolean;
+        altKey: boolean;
+        metaKey: boolean;
+    };
+    /**
+     * x-pixel for a bar time (ms or s, auto-detected). Extrapolates past the
+     * last bar into future space using the median bar interval, so layers can
+     * anchor trendlines to tomorrow, not just to history.
+     * @param {number} time
+     * @returns {number|null}
+     */
+    timeToX(time: number): number | null;
+    /**
+     * Bar time (ms) at an x-pixel — the inverse of timeToX, interpolating
+     * between bars and extrapolating beyond both data edges.
+     * @param {number} x
+     * @returns {number|null}
+     */
+    xToTime(x: number): number | null;
+    /**
+     * y-pixel for a price in the main pane (current scale; log-aware).
+     * Unclamped — values off-screen still map, layers decide how to clip.
+     * @param {number} price
+     * @returns {number|null}
+     */
+    priceToY(price: number): number | null;
+    /**
+     * Price at a y-pixel in the main pane — the inverse of priceToY.
+     * @param {number} y
+     * @returns {number|null}
+     */
+    yToPrice(y: number): number | null;
     _localPoint(e: any): {
         x: number;
         y: number;