wickchart 1.4.0 → 1.6.0

package/types/core.d.ts

@@ -294,6 +294,91 @@ export declare function calcMACD(closes: number[], fast?: number, slow?: number,
     signal: Array<number | null>;
     hist: Array<number | null>;
 };
+/** True range: max(h−l, |h−prev close|, |l−prev close|); first bar is h−l.
+ * @param {Bar[]} bars
+ * @returns {Array<number|null>}
+ */
+export declare function calcTrueRange(bars: Bar[]): Array<number | null>;
+/**
+ * Average True Range (Wilder smoothing; seeded with the SMA of the first
+ * `period` true ranges).
+ * @param {Bar[]} bars
+ * @param {number} period
+ * @returns {Array<number|null>}
+ */
+export declare function calcATR(bars: Bar[], period?: number): Array<number | null>;
+/**
+ * Volume-weighted average price over the hlc3 typical price, anchored to
+ * each UTC day (resets at the session boundary).
+ * @param {Bar[]} bars
+ * @returns {Array<number|null>}
+ */
+export declare function calcVWAP(bars: Bar[]): Array<number | null>;
+/**
+ * On-balance volume: cumulative volume signed by close-to-close direction.
+ * @param {Bar[]} bars
+ * @returns {Array<number|null>}
+ */
+export declare function calcOBV(bars: Bar[]): Array<number | null>;
+/**
+ * Stochastic oscillator (slow): raw %K over `period`, smoothed by `smooth`;
+ * %D is the SMA of %K.
+ * @param {Bar[]} bars
+ * @param {number} period
+ * @param {number} smooth
+ * @returns {{k:Array<number|null>, d:Array<number|null>}}
+ */
+export declare function calcStoch(bars: Bar[], period?: number, smooth?: number): {
+    k: Array<number | null>;
+    d: Array<number | null>;
+};
+/**
+ * Commodity Channel Index: typical price vs its SMA, scaled by mean deviation.
+ * @param {Bar[]} bars
+ * @param {number} period
+ * @returns {Array<number|null>}
+ */
+export declare function calcCCI(bars: Bar[], period?: number): Array<number | null>;
+/**
+ * Williams %R: −100 at the period low, 0 at the period high.
+ * @param {Bar[]} bars
+ * @param {number} period
+ * @returns {Array<number|null>}
+ */
+export declare function calcWilliamsR(bars: Bar[], period?: number): Array<number | null>;
+/**
+ * Donchian channels: highest high / lowest low over `period`, plus mid.
+ * @param {Bar[]} bars
+ * @param {number} period
+ * @returns {{upper:Array<number|null>, mid:Array<number|null>, lower:Array<number|null>}}
+ */
+export declare function calcDonchian(bars: Bar[], period?: number): {
+    upper: Array<number | null>;
+    mid: Array<number | null>;
+    lower: Array<number | null>;
+};
+/**
+ * Keltner channels: EMA mid ± mult × ATR.
+ * @param {Bar[]} bars
+ * @param {number} period
+ * @param {number} [mult]
+ * @returns {{upper:Array<number|null>, mid:Array<number|null>, lower:Array<number|null>}}
+ */
+export declare function calcKeltner(bars: Bar[], period?: number, mult?: number): {
+    upper: Array<number | null>;
+    mid: Array<number | null>;
+    lower: Array<number | null>;
+};
+/**
+ * SuperTrend: ATR bands that flip with the trend. Returns the trend line
+ * (support in uptrends, resistance in downtrends) with a one-bar null gap
+ * at flips so the renderer breaks the line.
+ * @param {Bar[]} bars
+ * @param {number} period
+ * @param {number} [mult]
+ * @returns {Array<number|null>}
+ */
+export declare function calcSuperTrend(bars: Bar[], period?: number, mult?: number): Array<number | null>;
 /**
  * Merge older (backfilled) bars in front of `existing`.
  * Dedupes by time (existing bars win); only strictly older bars are prepended.
@@ -435,11 +520,12 @@ export declare const BUILTIN_INDICATORS: Map<string, {
         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;
@@ -449,11 +535,27 @@ export declare const BUILTIN_INDICATORS: Map<string, {
         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;
@@ -463,6 +565,22 @@ export declare const BUILTIN_INDICATORS: Map<string, {
         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: {
@@ -470,9 +588,49 @@ export declare const BUILTIN_INDICATORS: Map<string, {
             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;
+    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;
@@ -482,6 +640,7 @@ export declare const BUILTIN_INDICATORS: Map<string, {
         fast?: undefined;
         slow?: undefined;
         signal?: undefined;
+        smooth?: undefined;
     };
     guides: number[];
     range: number[];
@@ -489,15 +648,15 @@ export declare const BUILTIN_INDICATORS: Map<string, {
     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;
@@ -508,6 +667,87 @@ export declare const BUILTIN_INDICATORS: Map<string, {
         }[];
         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[];
 }>;
 /**
  * Parse an `indicators` attribute string against a registry.

package/types/wick-chart.d.ts

@@ -46,6 +46,10 @@ declare class WickChart extends HTMLElementBase {
             y1: number;
             h: number;
         }[];
+        dock: {
+            y0: number;
+            h: number;
+        };
     };
     _cache: {
         v: number;
@@ -246,11 +250,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;
@@ -260,11 +265,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;
@@ -274,6 +330,7 @@ declare class WickChart extends HTMLElementBase {
             fast?: undefined;
             slow?: undefined;
             signal?: undefined;
+            smooth?: undefined;
         };
         compute: (bars: any, p: any) => {
             lines: {
@@ -281,9 +338,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;
@@ -293,6 +370,7 @@ declare class WickChart extends HTMLElementBase {
             fast?: undefined;
             slow?: undefined;
             signal?: undefined;
+            smooth?: undefined;
         };
         guides: number[];
         range: number[];
@@ -300,15 +378,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;
@@ -319,6 +397,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.
@@ -636,7 +795,13 @@ declare class WickChart extends HTMLElementBase {
      * 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
+     *
+     * A layer may also declare `insetBottom` (px, 0..160): the largest
+     * declared inset reserves a docked strip at the very bottom of the
+     * canvas — all chart content (panes + time axis) shrinks above it and
+     * the strip is handed to layers as `api.layout.dock = { y0, h }`
+     * (used by the wickchart-navigator plugin).
+     * @param {{id?: string, draw: Function, onPointer?: Function, insetBottom?: number}} 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)
      */
@@ -644,6 +809,7 @@ declare class WickChart extends HTMLElementBase {
         id?: string;
         draw: Function;
         onPointer?: Function;
+        insetBottom?: number;
     }): object | null;
     /**
      * Remove a layer added via addLayer (pass the returned handle or its id).
@@ -655,6 +821,11 @@ declare class WickChart extends HTMLElementBase {
     requestDraw(): void;
     /** Paint every registered layer. Called from _render with live state. */
     _drawLayers(ctx: any, pal: any, ly: any, d: any): void;
+    /**
+     * Bottom space reserved by plugin layers: the largest declared
+     * `insetBottom` (px, clamped 0..160 at addLayer time), or 0.
+     */
+    _dockInset(): number;
     /** 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. */