@tradecanvas/commons 1.47.0 → 1.49.0

package/dist/types/builtInIndicators.d.ts

@@ -0,0 +1,1326 @@
+import { NumberParam } from './indicator.js';
+/**
+ * The 134 built-in indicators, by id: the inputs
+ * `chart.addIndicator(id, params)` takes, each optional (its default in its
+ * note), and the keys of the lines it draws, as
+ * `chart.getIndicatorOutput(instanceId)` and `indicatorSource(instanceId, key)`
+ * name them (an output may hold a few more, such as Ichimoku's `chikou`).
+ * The chart adds four that read other symbols, `compareSymbol`, `spread`,
+ * `correlation` and `correlationlog`; they take any inputs.
+ */
+export interface BuiltInIndicators {
+    /** Simple Moving Average, on the price pane. Lines: `value` (SMA). */
+    sma: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Exponential Moving Average, on the price pane. Lines: `value` (EMA). */
+    ema: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Bollinger Bands, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
+    bb: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** Default 2. */
+            stdDev?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'upper' | 'middle' | 'lower';
+    };
+    /** Volume Weighted Average Price, on the price pane. Lines: `value` (VWAP). */
+    vwap: {
+        params: {};
+        lines: 'value';
+    };
+    /** Ichimoku Cloud, on the price pane. Lines: `tenkan` (Conversion), `kijun` (Base), `senkouA` (Lead A), `senkouB` (Lead B). */
+    ichimoku: {
+        params: {
+            /** Default 9. */
+            tenkan?: NumberParam;
+            /** Default 26. */
+            kijun?: NumberParam;
+            /** Default 52. */
+            senkou?: NumberParam;
+            /** Default 26. */
+            displacement?: NumberParam;
+        };
+        lines: 'tenkan' | 'kijun' | 'senkouA' | 'senkouB';
+    };
+    /** Parabolic SAR, on the price pane. Lines: `value` (SAR). */
+    psar: {
+        params: {
+            /** Default 0.02. */
+            step?: NumberParam;
+            /** Default 0.2. */
+            max?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Supertrend, on the price pane. Lines: `value` (Supertrend). */
+    supertrend: {
+        params: {
+            /** Default 10. */
+            period?: NumberParam;
+            /** Default 3. */
+            multiplier?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Keltner Channel, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
+    keltner: {
+        params: {
+            /** Default 20. */
+            emaPeriod?: NumberParam;
+            /** Default 10. */
+            atrPeriod?: NumberParam;
+            /** Default 1.5. */
+            multiplier?: NumberParam;
+        };
+        lines: 'upper' | 'middle' | 'lower';
+    };
+    /** Donchian Channel, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
+    donchian: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+        };
+        lines: 'upper' | 'middle' | 'lower';
+    };
+    /** Pivot Points, on the price pane. Lines: `r3` (R3), `r2` (R2), `r1` (R1), `pp` (P), `s1` (S1), `s2` (S2), `s3` (S3). */
+    pivots: {
+        params: {
+            /** At least 1. Default 24. */
+            lookback?: NumberParam;
+            /** Default `'traditional'`. */
+            type?: 'traditional' | 'fibonacci' | 'woodie' | 'classic' | 'camarilla' | 'dm' | (string & {});
+        };
+        lines: 'r3' | 'r2' | 'r1' | 'pp' | 's1' | 's2' | 's3';
+    };
+    /** Anchored VWAP, on the price pane. Lines: `value` (AVWAP). */
+    avwap: {
+        params: {
+            /** Default 0. */
+            anchorTime?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** ZigZag, on the price pane. Lines: `pivot` (Pivot). */
+    zigzag: {
+        params: {
+            /** Default 5. */
+            deviation?: NumberParam;
+        };
+        lines: 'pivot';
+    };
+    /** Linear Regression Channel, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
+    lrc: {
+        params: {
+            /** Default 100. */
+            period?: NumberParam;
+            /** Default 2. */
+            stdDev?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'upper' | 'middle' | 'lower';
+    };
+    /** Hull Moving Average, on the price pane. Lines: `value` (HMA). */
+    hma: {
+        params: {
+            /** Default 21. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** MTF Moving Average, on the price pane. Lines: `value` (MA). */
+    mtfma: {
+        params: {
+            /** Default 50. */
+            period?: NumberParam;
+            /** Default `'1d'`. */
+            timeframe?: string;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Session VWAP, on the price pane. Lines: `value` (VWAP), `u1` (+1σ), `l1` (−1σ), `u2` (+2σ), `l2` (−2σ), `u3` (+3σ), `l3` (−3σ). */
+    svwap: {
+        params: {
+            /** Default 1. */
+            bands?: NumberParam;
+        };
+        lines: 'value' | 'u1' | 'l1' | 'u2' | 'l2' | 'u3' | 'l3';
+    };
+    /** Chandelier Exit, on the price pane. Lines: `long` (Long), `short` (Short). */
+    chandelier: {
+        params: {
+            /** Default 22. */
+            period?: NumberParam;
+            /** Default 3. */
+            multiplier?: NumberParam;
+        };
+        lines: 'long' | 'short';
+    };
+    /** Alligator, on the price pane. Lines: `jaw` (Jaw), `teeth` (Teeth), `lips` (Lips). */
+    alligator: {
+        params: {
+            /** Default 13. */
+            jaw?: NumberParam;
+            /** Default 8. */
+            teeth?: NumberParam;
+            /** Default 5. */
+            lips?: NumberParam;
+            /** Default 8. */
+            jawShift?: NumberParam;
+            /** Default 5. */
+            teethShift?: NumberParam;
+            /** Default 3. */
+            lipsShift?: NumberParam;
+        };
+        lines: 'jaw' | 'teeth' | 'lips';
+    };
+    /** Volume Weighted Moving Average, on the price pane. Lines: `value` (VWMA). */
+    vwma: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Weighted Moving Average, on the price pane. Lines: `value` (WMA). */
+    wma: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Moving Average Envelope, on the price pane. Lines: `upper` (Upper), `basis` (Basis), `lower` (Lower). */
+    envelope: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** Default 2.5. */
+            percent?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'upper' | 'basis' | 'lower';
+    };
+    /** Triple EMA, on the price pane. Lines: `value` (TEMA). */
+    tema: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Relative Strength Index, in a pane of its own. Lines: `value` (RSI). Levels at 30, 70. */
+    rsi: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** MACD, in a pane of its own. Lines: `histogram` (Histogram), `macd` (MACD), `signal` (Signal). */
+    macd: {
+        params: {
+            /** Default 12. */
+            fast?: NumberParam;
+            /** Default 26. */
+            slow?: NumberParam;
+            /** Default 9. */
+            signal?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'histogram' | 'macd' | 'signal';
+    };
+    /** Stochastic Oscillator, in a pane of its own. Lines: `k` (%K), `d` (%D). Levels at 20, 80. */
+    stochastic: {
+        params: {
+            /** Default 14. */
+            kPeriod?: NumberParam;
+            /** Default 3. */
+            dPeriod?: NumberParam;
+            /** Default 3. */
+            smooth?: NumberParam;
+        };
+        lines: 'k' | 'd';
+    };
+    /** Average True Range, in a pane of its own. Lines: `value` (ATR). */
+    atr: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Average Directional Index, in a pane of its own. Lines: `adx` (ADX), `plusDI` (+DI), `minusDI` (−DI). */
+    adx: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'adx' | 'plusDI' | 'minusDI';
+    };
+    /** On Balance Volume, in a pane of its own. Lines: `value` (OBV). */
+    obv: {
+        params: {};
+        lines: 'value';
+    };
+    /** Williams %R, in a pane of its own. Lines: `value` (%R). Levels at -80, -20. */
+    williamsR: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Commodity Channel Index, in a pane of its own. Lines: `value` (CCI). Levels at -100, 0, 100. */
+    cci: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Money Flow Index, in a pane of its own. Lines: `value` (MFI). Levels at 20, 80. */
+    mfi: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Aroon, in a pane of its own. Lines: `up` (Up), `down` (Down). */
+    aroon: {
+        params: {
+            /** Default 25. */
+            period?: NumberParam;
+        };
+        lines: 'up' | 'down';
+    };
+    /** Rate of Change, in a pane of its own. Lines: `value` (ROC). Levels at 0. */
+    roc: {
+        params: {
+            /** Default 12. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** True Strength Index, in a pane of its own. Lines: `tsi` (TSI), `signal` (Signal). Levels at 0. */
+    tsi: {
+        params: {
+            /** Default 25. */
+            longPeriod?: NumberParam;
+            /** Default 13. */
+            shortPeriod?: NumberParam;
+            /** Default 7. */
+            signalPeriod?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'tsi' | 'signal';
+    };
+    /** Chaikin Money Flow, in a pane of its own. Lines: `value` (CMF). */
+    cmf: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Standard Deviation, in a pane of its own. Lines: `value` (StdDev). */
+    stddev: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Volume Profile, on the price pane. No lines. */
+    volumeProfile: {
+        params: {
+            /** Default 24. */
+            rows?: NumberParam;
+        };
+        lines: never;
+    };
+    /** Accumulation/Distribution, in a pane of its own. Lines: `value` (A/D). */
+    ad: {
+        params: {};
+        lines: 'value';
+    };
+    /** Volume Rate of Change, in a pane of its own. Lines: `value` (VROC). Levels at 0. */
+    vroc: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Awesome Oscillator, in a pane of its own. Lines: `value` (AO). */
+    ao: {
+        params: {
+            /** Default 5. */
+            fast?: NumberParam;
+            /** Default 34. */
+            slow?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Chaikin Oscillator, in a pane of its own. Lines: `value` (Chaikin). */
+    chaikinOsc: {
+        params: {
+            /** Default 3. */
+            fast?: NumberParam;
+            /** Default 10. */
+            slow?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Volume Delta, in a pane of its own. Lines: `value` (Delta). */
+    voldelta: {
+        params: {
+            /** Default 0. */
+            mode?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Vortex Indicator, in a pane of its own. Lines: `viPlus` (VI+), `viMinus` (VI−). Levels at 1. */
+    vortex: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'viPlus' | 'viMinus';
+    };
+    /** Choppiness Index, in a pane of its own. Lines: `value` (CHOP). Levels at 38.2, 61.8. */
+    chop: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Ultimate Oscillator, in a pane of its own. Lines: `value` (UO). Levels at 30, 70. */
+    uo: {
+        params: {
+            /** Default 7. */
+            fast?: NumberParam;
+            /** Default 14. */
+            mid?: NumberParam;
+            /** Default 28. */
+            slow?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Force Index, in a pane of its own. Lines: `value` (EFI). Levels at 0. */
+    fi: {
+        params: {
+            /** Default 13. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Connors RSI, in a pane of its own. Lines: `value` (CRSI). Levels at 10, 90. */
+    crsi: {
+        params: {
+            /** Default 3. */
+            rsiPeriod?: NumberParam;
+            /** Default 2. */
+            streakPeriod?: NumberParam;
+            /** Default 100. */
+            rankPeriod?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Coppock Curve, in a pane of its own. Lines: `value` (Coppock). Levels at 0. */
+    coppock: {
+        params: {
+            /** Default 14. */
+            longRoc?: NumberParam;
+            /** Default 11. */
+            shortRoc?: NumberParam;
+            /** Default 10. */
+            wma?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Know Sure Thing, in a pane of its own. Lines: `value` (KST), `signal` (Signal). Levels at 0. */
+    kst: {
+        params: {
+            /** Default 10. */
+            roc1?: NumberParam;
+            /** Default 15. */
+            roc2?: NumberParam;
+            /** Default 20. */
+            roc3?: NumberParam;
+            /** Default 30. */
+            roc4?: NumberParam;
+            /** Default 10. */
+            sma1?: NumberParam;
+            /** Default 10. */
+            sma2?: NumberParam;
+            /** Default 10. */
+            sma3?: NumberParam;
+            /** Default 15. */
+            sma4?: NumberParam;
+            /** Default 9. */
+            signal?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value' | 'signal';
+    };
+    /** Elder Ray, in a pane of its own. Lines: `bull` (Bull), `bear` (Bear). */
+    elderray: {
+        params: {
+            /** Default 13. */
+            period?: NumberParam;
+        };
+        lines: 'bull' | 'bear';
+    };
+    /** Schaff Trend Cycle, in a pane of its own. Lines: `value` (STC). Levels at 25, 75. */
+    stc: {
+        params: {
+            /** Default 23. */
+            fast?: NumberParam;
+            /** Default 50. */
+            slow?: NumberParam;
+            /** Default 10. */
+            cycle?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Klinger Oscillator, in a pane of its own. Lines: `value` (KVO), `signal` (Signal). Levels at 0. */
+    kvo: {
+        params: {
+            /** Default 34. */
+            fast?: NumberParam;
+            /** Default 55. */
+            slow?: NumberParam;
+            /** Default 13. */
+            signal?: NumberParam;
+        };
+        lines: 'value' | 'signal';
+    };
+    /** Fisher Transform, in a pane of its own. Lines: `value` (Fisher), `trigger` (Trigger). Levels at 0. */
+    fisher: {
+        params: {
+            /** Default 9. */
+            period?: NumberParam;
+        };
+        lines: 'value' | 'trigger';
+    };
+    /** Detrended Price Oscillator, in a pane of its own. Lines: `value` (DPO). */
+    dpo: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Balance of Power, in a pane of its own. Lines: `value` (BOP). Levels at 0. */
+    bop: {
+        params: {
+            /** Default 14. */
+            smooth?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Mass Index, in a pane of its own. Lines: `value` (Mass). Levels at 26.5, 27. */
+    massindex: {
+        params: {
+            /** Default 9. */
+            ema?: NumberParam;
+            /** Default 25. */
+            sum?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Chande Momentum, in a pane of its own. Lines: `value` (CMO). Levels at -50, 0, 50. */
+    cmo: {
+        params: {
+            /** Default 9. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** TRIX, in a pane of its own. Lines: `value` (TRIX), `signal` (Signal). Levels at 0. */
+    trix: {
+        params: {
+            /** Default 15. */
+            period?: NumberParam;
+            /** Default 9. */
+            signal?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value' | 'signal';
+    };
+    /** Ease of Movement, in a pane of its own. Lines: `value` (EOM). Levels at 0. */
+    emv: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Price Volume Trend, in a pane of its own. Lines: `value` (PVT). */
+    pvt: {
+        params: {};
+        lines: 'value';
+    };
+    /** Williams A/D, in a pane of its own. Lines: `value` (WAD). */
+    wad: {
+        params: {};
+        lines: 'value';
+    };
+    /** Chaikin Volatility, in a pane of its own. Lines: `value` (CV). Levels at 0. */
+    chaikinvol: {
+        params: {
+            /** Default 10. */
+            ema?: NumberParam;
+            /** Default 10. */
+            roc?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Relative Vigor Index, in a pane of its own. Lines: `value` (RVGI), `signal` (Signal). Levels at 0. */
+    rvi: {
+        params: {
+            /** Default 10. */
+            period?: NumberParam;
+        };
+        lines: 'value' | 'signal';
+    };
+    /** Stochastic RSI, in a pane of its own. Lines: `k` (%K), `d` (%D). Levels at 20, 80. */
+    stochrsi: {
+        params: {
+            /** Default 14. */
+            rsiPeriod?: NumberParam;
+            /** Default 14. */
+            stochPeriod?: NumberParam;
+            /** Default 3. */
+            k?: NumberParam;
+            /** Default 3. */
+            d?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'k' | 'd';
+    };
+    /** Percentage Price Oscillator, in a pane of its own. Lines: `hist` (Histogram), `value` (PPO), `signal` (Signal). Levels at 0. */
+    ppo: {
+        params: {
+            /** Default 12. */
+            fast?: NumberParam;
+            /** Default 26. */
+            slow?: NumberParam;
+            /** Default 9. */
+            signal?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'hist' | 'value' | 'signal';
+    };
+    /** Accelerator Oscillator, in a pane of its own. Lines: `value` (AC). */
+    ac: {
+        params: {};
+        lines: 'value';
+    };
+    /** Relative Momentum Index, in a pane of its own. Lines: `value` (RMI). Levels at 30, 70. */
+    rmi: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** Default 5. */
+            momentum?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Disparity Index, in a pane of its own. Lines: `value` (DI). Levels at 0. */
+    disparity: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Qstick, in a pane of its own. Lines: `value` (Qstick). Levels at 0. */
+    qstick: {
+        params: {
+            /** Default 8. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Pretty Good Oscillator, in a pane of its own. Lines: `value` (PGO). Levels at -3, 0, 3. */
+    pgo: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Double Exponential Moving Average, on the price pane. Lines: `value` (DEMA). */
+    dema: {
+        params: {
+            /** At least 1. Default 20. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Smoothed Moving Average, on the price pane. Lines: `value` (SMMA). */
+    smma: {
+        params: {
+            /** At least 1. Default 14. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Arnaud Legoux Moving Average, on the price pane. Lines: `value` (ALMA). */
+    alma: {
+        params: {
+            /** At least 1, at most 5000. Default 9. */
+            period?: NumberParam;
+            /** At least 0, at most 1, in steps of 0.05. Default 0.85. */
+            offset?: NumberParam;
+            /** At least 0.5, in steps of 0.5. Default 6. */
+            sigma?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Kaufman Adaptive Moving Average, on the price pane. Lines: `value` (KAMA). */
+    kama: {
+        params: {
+            /** At least 1. Default 10. */
+            period?: NumberParam;
+            /** At least 1. Default 2. */
+            fast?: NumberParam;
+            /** At least 1. Default 30. */
+            slow?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Least Squares Moving Average, on the price pane. Lines: `value` (LSMA). */
+    lsma: {
+        params: {
+            /** At least 2, at most 5000. Default 25. */
+            period?: NumberParam;
+            /** In steps of 1. Default 0. */
+            offset?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** McGinley Dynamic, on the price pane. Lines: `value` (McGinley). */
+    mcginley: {
+        params: {
+            /** At least 1. Default 14. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** MA Cross, on the price pane. Lines: `fast` (Fast), `slow` (Slow). */
+    macross: {
+        params: {
+            /** At least 1. Default 9. */
+            fast?: NumberParam;
+            /** At least 1. Default 21. */
+            slow?: NumberParam;
+            /** Default `'sma'`. */
+            type?: 'sma' | 'ema' | 'sma-ema' | (string & {});
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'fast' | 'slow';
+    };
+    /** Williams Fractals, on the price pane. Lines: `up` (Up), `down` (Down). */
+    fractals: {
+        params: {
+            /** At least 1, at most 10. Default 2. */
+            period?: NumberParam;
+        };
+        lines: 'up' | 'down';
+    };
+    /** Chande Kroll Stop, on the price pane. Lines: `long` (Stop Long), `short` (Stop Short). */
+    cks: {
+        params: {
+            /** ATR length. At least 1. Default 10. */
+            p?: NumberParam;
+            /** ATR multiplier. At least 0, in steps of 0.1. Default 1. */
+            x?: NumberParam;
+            /** Stop length. At least 1. Default 9. */
+            q?: NumberParam;
+        };
+        lines: 'long' | 'short';
+    };
+    /** Bollinger Bands %B, in a pane of its own. Lines: `value` (%B). Levels at 0, 0.5, 1. */
+    bbpb: {
+        params: {
+            /** At least 2. Default 20. */
+            period?: NumberParam;
+            /** At least 0.1, in steps of 0.1. Default 2. */
+            stdDev?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Bollinger BandWidth, in a pane of its own. Lines: `value` (BBW). */
+    bbw: {
+        params: {
+            /** At least 2. Default 20. */
+            period?: NumberParam;
+            /** At least 0.1, in steps of 0.1. Default 2. */
+            stdDev?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Momentum, in a pane of its own. Lines: `value` (MOM). Levels at 0. */
+    mom: {
+        params: {
+            /** At least 1. Default 10. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Historical Volatility, in a pane of its own. Lines: `value` (HV). */
+    hv: {
+        params: {
+            /** At least 2. Default 10. */
+            period?: NumberParam;
+            /** Bars per year. At least 1. Default 365. */
+            annual?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Volume Oscillator, in a pane of its own. Lines: `value` (Vol Osc). Levels at 0. */
+    vo: {
+        params: {
+            /** At least 1. Default 5. */
+            short?: NumberParam;
+            /** At least 1. Default 10. */
+            long?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Ulcer Index, in a pane of its own. Lines: `value` (Ulcer). */
+    ulcer: {
+        params: {
+            /** At least 1. Default 14. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Stochastic Momentum Index, in a pane of its own. Lines: `smi` (SMI), `signal` (Signal). Levels at 40, -40. */
+    smi: {
+        params: {
+            /** At least 1. Default 10. */
+            period?: NumberParam;
+            /** At least 1. Default 3. */
+            smooth?: NumberParam;
+            /** At least 1. Default 3. */
+            signal?: NumberParam;
+        };
+        lines: 'smi' | 'signal';
+    };
+    /** Relative Volatility Index, in a pane of its own. Lines: `value` (RVI). Levels at 80, 50, 20. */
+    rvix: {
+        params: {
+            /** At least 2. Default 10. */
+            period?: NumberParam;
+            /** At least 1. Default 14. */
+            smooth?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Trend Strength Index, in a pane of its own. Lines: `value` (Trend). Levels at 0. */
+    trendstrength: {
+        params: {
+            /** At least 2. Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Linear Regression Slope, in a pane of its own. Lines: `value` (Slope). Levels at 0. */
+    lrslope: {
+        params: {
+            /** At least 2. Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Standard Error, in a pane of its own. Lines: `value` (StdErr). */
+    stderror: {
+        params: {
+            /** At least 3. Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Average Day Range, in a pane of its own. Lines: `value` (ADR). */
+    adr: {
+        params: {
+            /** At least 1. Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Net Volume, in a pane of its own. Lines: `value` (Net). Levels at 0. */
+    netvolume: {
+        params: {};
+        lines: 'value';
+    };
+    /** Standard Error Bands, on the price pane. Lines: `upper` (Upper), `middle` (Middle), `lower` (Lower). */
+    seb: {
+        params: {
+            /** At least 3. Default 21. */
+            period?: NumberParam;
+            /** At least 0, in steps of 0.1. Default 2. */
+            mult?: NumberParam;
+            /** At least 1. Default 3. */
+            smooth?: NumberParam;
+        };
+        lines: 'upper' | 'middle' | 'lower';
+    };
+    /** Guppy Multiple Moving Average, on the price pane. Lines: `s3` (EMA 3), `s5` (EMA 5), `s8` (EMA 8), `s10` (EMA 10), `s12` (EMA 12), `s15` (EMA 15), `l30` (EMA 30), `l35` (EMA 35), `l40` (EMA 40), `l45` (EMA 45), `l50` (EMA 50), `l60` (EMA 60). */
+    gmma: {
+        params: {};
+        lines: 's3' | 's5' | 's8' | 's10' | 's12' | 's15' | 'l30' | 'l35' | 'l40' | 'l45' | 'l50' | 'l60';
+    };
+    /** Moving Average Ribbon, on the price pane. Lines: `ma1` (MA 1), `ma2` (MA 2), `ma3` (MA 3), `ma4` (MA 4). */
+    maribbon: {
+        params: {
+            /** At least 1. Default 20. */
+            ma1?: NumberParam;
+            /** At least 1. Default 50. */
+            ma2?: NumberParam;
+            /** At least 1. Default 100. */
+            ma3?: NumberParam;
+            /** At least 1. Default 200. */
+            ma4?: NumberParam;
+            /** At least 0, at most 1. Default 0. */
+            exponential?: NumberParam;
+        };
+        lines: 'ma1' | 'ma2' | 'ma3' | 'ma4';
+    };
+    /** Average Price, on the price pane. Lines: `value` (Average). */
+    avgprice: {
+        params: {};
+        lines: 'value';
+    };
+    /** Median Price, on the price pane. Lines: `value` (Median). */
+    medprice: {
+        params: {};
+        lines: 'value';
+    };
+    /** Typical Price, on the price pane. Lines: `value` (Typical). */
+    typprice: {
+        params: {};
+        lines: 'value';
+    };
+    /** Moving Average Channel, on the price pane. Lines: `upper` (Upper), `lower` (Lower). */
+    machannel: {
+        params: {
+            /** At least 1. Default 20. */
+            upperLength?: NumberParam;
+            /** At least 1. Default 20. */
+            lowerLength?: NumberParam;
+            /** At least -500, at most 500. Default 0. */
+            upperOffset?: NumberParam;
+            /** At least -500, at most 500. Default 0. */
+            lowerOffset?: NumberParam;
+        };
+        lines: 'upper' | 'lower';
+    };
+    /** Moving Average Hamming, on the price pane. Lines: `value` (MA). */
+    hamming: {
+        params: {
+            /** At least 2, at most 500. Default 10. */
+            period?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Moving Average Double, on the price pane. Lines: `ma1` (MA 1), `ma2` (MA 2). */
+    madouble: {
+        params: {
+            /** At least 1. Default 20. */
+            first?: NumberParam;
+            /** At least 1. Default 50. */
+            second?: NumberParam;
+            /** Default `'sma'`. */
+            type?: 'sma' | 'ema' | 'wma' | (string & {});
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'ma1' | 'ma2';
+    };
+    /** Moving Average Triple, on the price pane. Lines: `ma1` (MA 1), `ma2` (MA 2), `ma3` (MA 3). */
+    matriple: {
+        params: {
+            /** At least 1. Default 10. */
+            first?: NumberParam;
+            /** At least 1. Default 20. */
+            second?: NumberParam;
+            /** At least 1. Default 50. */
+            third?: NumberParam;
+            /** Default `'sma'`. */
+            type?: 'sma' | 'ema' | 'wma' | (string & {});
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'ma1' | 'ma2' | 'ma3';
+    };
+    /** Volatility Index, on the price pane. Lines: `sar` (Stop). */
+    volindex: {
+        params: {
+            /** At least 1. Default 7. */
+            period?: NumberParam;
+            /** ATR multiple. At least 0.1, in steps of 0.1. Default 3. */
+            mult?: NumberParam;
+        };
+        lines: 'sar';
+    };
+    /** Accumulative Swing Index, in a pane of its own. Lines: `value` (ASI). */
+    asi: {
+        params: {
+            /** Limit move. At least 0.0001, in steps of 0.1. Default 10. */
+            limit?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Advance/Decline, in a pane of its own. Lines: `value` (Ratio). */
+    advdecline: {
+        params: {
+            /** At least 1. Default 10. */
+            length?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Majority Rule, in a pane of its own. Lines: `value` (Majority). Levels at 50. */
+    majority: {
+        params: {
+            /** At least 1. Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Chop Zone, in a pane of its own. Lines: `angle` (Angle). */
+    chopzone: {
+        params: {};
+        lines: 'angle';
+    };
+    /** SMI Ergodic, in a pane of its own. Lines: `oscillator` (Oscillator), `indicator` (Indicator), `signal` (Signal). */
+    smiergodic: {
+        params: {
+            /** At least 1. Default 5. */
+            short?: NumberParam;
+            /** At least 1. Default 20. */
+            long?: NumberParam;
+            /** At least 1. Default 5. */
+            signal?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'oscillator' | 'indicator' | 'signal';
+    };
+    /** Price Oscillator, in a pane of its own. Lines: `value` (PO). */
+    po: {
+        params: {
+            /** At least 1. Default 10. */
+            short?: NumberParam;
+            /** At least 1. Default 21. */
+            long?: NumberParam;
+            /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
+            source?: string;
+        };
+        lines: 'value';
+    };
+    /** Volatility O-H-L-C, in a pane of its own. Lines: `value` (Volatility). */
+    volohlc: {
+        params: {
+            /** At least 1. Default 10. */
+            period?: NumberParam;
+            /** Bars per year. At least 1. Default 365. */
+            annual?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Volatility Zero Trend Close-to-Close, in a pane of its own. Lines: `value` (Volatility). */
+    volzt: {
+        params: {
+            /** At least 1. Default 10. */
+            period?: NumberParam;
+            /** Bars per year. At least 1. Default 365. */
+            annual?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Psychological Line, in a pane of its own. Lines: `value` (PSY). Levels at 25, 75. */
+    psy: {
+        params: {
+            /** Default 10. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** New Psychological Line, in a pane of its own. Lines: `value` (New PSY). Levels at -50, 0, 50. */
+    newpsy: {
+        params: {
+            /** Default 10. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Volume Ratio, in a pane of its own. Lines: `value` (VR). Levels at 70, 150, 450. */
+    vr: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** AB Ratio, in a pane of its own. Lines: `a` (A), `b` (B). Levels at 100. */
+    abratio: {
+        params: {
+            /** Default 26. */
+            period?: NumberParam;
+        };
+        lines: 'a' | 'b';
+    };
+    /** Sonar, in a pane of its own. Lines: `sonar` (Sonar), `signal` (Signal). Levels at 0. */
+    sonar: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+            /** Default 9. */
+            lookback?: NumberParam;
+            /** Default 9. */
+            signal?: NumberParam;
+        };
+        lines: 'sonar' | 'signal';
+    };
+    /** Sigma, in a pane of its own. Lines: `value` (Sigma). Levels at -2, 0, 2. */
+    sigma: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Vertical Horizontal Filter, in a pane of its own. Lines: `value` (VHF). */
+    vhf: {
+        params: {
+            /** Default 28. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** R-Squared, in a pane of its own. Lines: `value` (R²). */
+    rsquared: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Random Walk Index, in a pane of its own. Lines: `high` (RWI High), `low` (RWI Low). Levels at 1. */
+    rwi: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'high' | 'low';
+    };
+    /** Negative Volume Index, in a pane of its own. Lines: `value` (NVI), `signal` (Signal). */
+    nvi: {
+        params: {
+            /** Default 255. */
+            signal?: NumberParam;
+        };
+        lines: 'value' | 'signal';
+    };
+    /** Positive Volume Index, in a pane of its own. Lines: `value` (PVI), `signal` (Signal). */
+    pvi: {
+        params: {
+            /** Default 255. */
+            signal?: NumberParam;
+        };
+        lines: 'value' | 'signal';
+    };
+    /** True Range, in a pane of its own. Lines: `value` (TR). */
+    tr: {
+        params: {};
+        lines: 'value';
+    };
+    /** Intraday Intensity, in a pane of its own. Lines: `value` (III %). Levels at 0. */
+    iii: {
+        params: {
+            /** Default 21. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Volume vs Average, in a pane of its own. Lines: `value` (Vol %). Levels at 0. */
+    volpct: {
+        params: {
+            /** Default 20. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Volume Change, in a pane of its own. Lines: `value` (Volume). */
+    volchange: {
+        params: {};
+        lines: 'value';
+    };
+    /** Trade Value, in a pane of its own. Lines: `value` (Value). */
+    tradevalue: {
+        params: {};
+        lines: 'value';
+    };
+    /** Binary Wave, in a pane of its own. Lines: `value` (Wave). Levels at 0. */
+    binarywave: {
+        params: {
+            /** Default 20. */
+            ma?: NumberParam;
+            /** Default 12. */
+            fast?: NumberParam;
+            /** Default 26. */
+            slow?: NumberParam;
+            /** Default 9. */
+            signal?: NumberParam;
+            /** Default 12. */
+            roc?: NumberParam;
+            /** Default 14. */
+            stoch?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Smoothed Rate of Change, in a pane of its own. Lines: `value` (S-ROC). Levels at 0. */
+    sroc: {
+        params: {
+            /** Default 13. */
+            ema?: NumberParam;
+            /** Default 21. */
+            roc?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Time Series Forecast, on the price pane. Lines: `value` (TSF). */
+    tsf: {
+        params: {
+            /** Default 14. */
+            period?: NumberParam;
+        };
+        lines: 'value';
+    };
+    /** Weighted Close, on the price pane. Lines: `value` (Weighted). */
+    wclose: {
+        params: {};
+        lines: 'value';
+    };
+    /** DeMark Projected Range, on the price pane. Lines: `high` (Projected high), `low` (Projected low). */
+    demark: {
+        params: {};
+        lines: 'high' | 'low';
+    };
+    /** Moving Average Rainbow, on the price pane. Lines: `ma1` (MA 1), `ma2` (MA 2), `ma3` (MA 3), `ma4` (MA 4), `ma5` (MA 5), `ma6` (MA 6), `ma7` (MA 7), `ma8` (MA 8), `ma9` (MA 9), `ma10` (MA 10), `ma11` (MA 11), `ma12` (MA 12), `ma13` (MA 13), `ma14` (MA 14), `ma15` (MA 15), `ma16` (MA 16), `ma17` (MA 17), `ma18` (MA 18), `ma19` (MA 19), `ma20` (MA 20). */
+    rainbow: {
+        params: {
+            /** At least 1. Default 10. */
+            first?: NumberParam;
+            /** At least 1. Default 10. */
+            step?: NumberParam;
+            /** At least 1, at most 20. Default 10. */
+            count?: NumberParam;
+            /** At least 0, at most 1. Default 0. */
+            exponential?: NumberParam;
+        };
+        lines: 'ma1' | 'ma2' | 'ma3' | 'ma4' | 'ma5' | 'ma6' | 'ma7' | 'ma8' | 'ma9' | 'ma10' | 'ma11' | 'ma12' | 'ma13' | 'ma14' | 'ma15' | 'ma16' | 'ma17' | 'ma18' | 'ma19' | 'ma20';
+    };
+    /** Candlestick Patterns, on the price pane. Lines: `bull` (Bullish), `bear` (Bearish), `neutral` (Indecision). */
+    candlepatterns: {
+        params: {
+            /** At least 2. Default 10. */
+            trendPeriod?: NumberParam;
+            /** At least 0, at most 1. Default 1. */
+            reversal?: NumberParam;
+            /** At least 0, at most 1. Default 1. */
+            continuation?: NumberParam;
+            /** At least 0, at most 1. Default 0. */
+            indecision?: NumberParam;
+        };
+        lines: 'bull' | 'bear' | 'neutral';
+    };
+}
+//# sourceMappingURL=builtInIndicators.d.ts.map