@tradecanvas/commons 1.70.0 → 1.72.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,7 +13,7 @@ export interface BuiltInIndicators {
13
13
  /** Simple Moving Average, on the price pane. Lines: `value` (SMA). */
14
14
  sma: {
15
15
  params: {
16
- /** Default 20. */
16
+ /** A whole number, at least 1. Default 20. */
17
17
  period?: NumberParam;
18
18
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
19
19
  source?: string;
@@ -23,7 +23,7 @@ export interface BuiltInIndicators {
23
23
  /** Exponential Moving Average, on the price pane. Lines: `value` (EMA). */
24
24
  ema: {
25
25
  params: {
26
- /** Default 20. */
26
+ /** A whole number, at least 1. Default 20. */
27
27
  period?: NumberParam;
28
28
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
29
29
  source?: string;
@@ -33,9 +33,9 @@ export interface BuiltInIndicators {
33
33
  /** Bollinger Bands, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
34
34
  bb: {
35
35
  params: {
36
- /** Default 20. */
36
+ /** A whole number, at least 1. Default 20. */
37
37
  period?: NumberParam;
38
- /** Default 2. */
38
+ /** At least 0.1, in steps of 0.1. Default 2. */
39
39
  stdDev?: NumberParam;
40
40
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
41
41
  source?: string;
@@ -53,13 +53,13 @@ export interface BuiltInIndicators {
53
53
  /** Ichimoku Cloud, on the price pane. Lines: `tenkan` (Conversion), `kijun` (Base), `senkouA` (Lead A), `senkouB` (Lead B), `chikou` (Lagging Span). */
54
54
  ichimoku: {
55
55
  params: {
56
- /** Default 9. */
56
+ /** A whole number, at least 1. Default 9. */
57
57
  tenkan?: NumberParam;
58
- /** Default 26. */
58
+ /** A whole number, at least 1. Default 26. */
59
59
  kijun?: NumberParam;
60
- /** Default 52. */
60
+ /** A whole number, at least 1. Default 52. */
61
61
  senkou?: NumberParam;
62
- /** Default 26. */
62
+ /** A whole number, at least 0. Default 26. */
63
63
  displacement?: NumberParam;
64
64
  };
65
65
  lines: 'tenkan' | 'kijun' | 'senkouA' | 'senkouB' | 'chikou';
@@ -67,9 +67,9 @@ export interface BuiltInIndicators {
67
67
  /** Parabolic SAR, on the price pane. Lines: `value` (SAR). */
68
68
  psar: {
69
69
  params: {
70
- /** Default 0.02. */
70
+ /** At least 0.01, in steps of 0.01. Default 0.02. */
71
71
  step?: NumberParam;
72
- /** Default 0.2. */
72
+ /** At least 0.01, in steps of 0.01. Default 0.2. */
73
73
  max?: NumberParam;
74
74
  };
75
75
  lines: 'value';
@@ -77,9 +77,9 @@ export interface BuiltInIndicators {
77
77
  /** Supertrend, on the price pane. Lines: `value` (Supertrend). */
78
78
  supertrend: {
79
79
  params: {
80
- /** Default 10. */
80
+ /** A whole number, at least 1. Default 10. */
81
81
  period?: NumberParam;
82
- /** Default 3. */
82
+ /** At least 0.1, in steps of 0.1. Default 3. */
83
83
  multiplier?: NumberParam;
84
84
  };
85
85
  lines: 'value';
@@ -87,11 +87,11 @@ export interface BuiltInIndicators {
87
87
  /** Keltner Channel, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
88
88
  keltner: {
89
89
  params: {
90
- /** Default 20. */
90
+ /** A whole number, at least 1. Default 20. */
91
91
  emaPeriod?: NumberParam;
92
- /** Default 10. */
92
+ /** A whole number, at least 1. Default 10. */
93
93
  atrPeriod?: NumberParam;
94
- /** Default 1.5. */
94
+ /** At least 0.1, in steps of 0.1. Default 1.5. */
95
95
  multiplier?: NumberParam;
96
96
  };
97
97
  lines: 'upper' | 'middle' | 'lower';
@@ -99,7 +99,7 @@ export interface BuiltInIndicators {
99
99
  /** Donchian Channel, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
100
100
  donchian: {
101
101
  params: {
102
- /** Default 20. */
102
+ /** A whole number, at least 1. Default 20. */
103
103
  period?: NumberParam;
104
104
  };
105
105
  lines: 'upper' | 'middle' | 'lower';
@@ -107,7 +107,7 @@ export interface BuiltInIndicators {
107
107
  /** Pivot Points, on the price pane. Lines: `r3` (R3), `r2` (R2), `r1` (R1), `pp` (P), `s1` (S1), `s2` (S2), `s3` (S3). */
108
108
  pivots: {
109
109
  params: {
110
- /** At least 1. Default 24. */
110
+ /** A whole number, at least 1. Default 24. */
111
111
  lookback?: NumberParam;
112
112
  /** Default `'traditional'`. */
113
113
  type?: 'traditional' | 'fibonacci' | 'woodie' | 'classic' | 'camarilla' | 'dm' | (string & {});
@@ -117,7 +117,7 @@ export interface BuiltInIndicators {
117
117
  /** Anchored VWAP, on the price pane. Lines: `value` (AVWAP). */
118
118
  avwap: {
119
119
  params: {
120
- /** Default 0. */
120
+ /** A whole number. Default 0. */
121
121
  anchorTime?: NumberParam;
122
122
  };
123
123
  lines: 'value';
@@ -125,7 +125,7 @@ export interface BuiltInIndicators {
125
125
  /** ZigZag, on the price pane. Lines: `pivot` (Pivot). */
126
126
  zigzag: {
127
127
  params: {
128
- /** Default 5. */
128
+ /** At least 0.1, in steps of 0.1. Default 5. */
129
129
  deviation?: NumberParam;
130
130
  };
131
131
  lines: 'pivot';
@@ -133,9 +133,9 @@ export interface BuiltInIndicators {
133
133
  /** Linear Regression Channel, on the price pane. Lines: `upper` (Upper), `middle` (Basis), `lower` (Lower). */
134
134
  lrc: {
135
135
  params: {
136
- /** Default 100. */
136
+ /** A whole number, at least 2. Default 100. */
137
137
  period?: NumberParam;
138
- /** Default 2. */
138
+ /** At least 0.1, in steps of 0.1. Default 2. */
139
139
  stdDev?: NumberParam;
140
140
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
141
141
  source?: string;
@@ -145,7 +145,7 @@ export interface BuiltInIndicators {
145
145
  /** Hull Moving Average, on the price pane. Lines: `value` (HMA). */
146
146
  hma: {
147
147
  params: {
148
- /** Default 21. */
148
+ /** A whole number, at least 2. Default 21. */
149
149
  period?: NumberParam;
150
150
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
151
151
  source?: string;
@@ -155,7 +155,7 @@ export interface BuiltInIndicators {
155
155
  /** MTF Moving Average, on the price pane. Lines: `value` (MA). */
156
156
  mtfma: {
157
157
  params: {
158
- /** Default 50. */
158
+ /** A whole number, at least 1. Default 50. */
159
159
  period?: NumberParam;
160
160
  /** Default `'1d'`. */
161
161
  timeframe?: string;
@@ -167,7 +167,7 @@ export interface BuiltInIndicators {
167
167
  /** Session VWAP, on the price pane. Lines: `value` (VWAP), `u1` (+1σ), `l1` (−1σ), `u2` (+2σ), `l2` (−2σ), `u3` (+3σ), `l3` (−3σ). */
168
168
  svwap: {
169
169
  params: {
170
- /** Default 1. */
170
+ /** A whole number, at least 0, at most 3. Default 1. */
171
171
  bands?: NumberParam;
172
172
  };
173
173
  lines: 'value' | 'u1' | 'l1' | 'u2' | 'l2' | 'u3' | 'l3';
@@ -175,9 +175,9 @@ export interface BuiltInIndicators {
175
175
  /** Chandelier Exit, on the price pane. Lines: `long` (Long), `short` (Short). */
176
176
  chandelier: {
177
177
  params: {
178
- /** Default 22. */
178
+ /** A whole number, at least 1. Default 22. */
179
179
  period?: NumberParam;
180
- /** Default 3. */
180
+ /** At least 0.1, in steps of 0.1. Default 3. */
181
181
  multiplier?: NumberParam;
182
182
  };
183
183
  lines: 'long' | 'short';
@@ -185,17 +185,17 @@ export interface BuiltInIndicators {
185
185
  /** Alligator, on the price pane. Lines: `jaw` (Jaw), `teeth` (Teeth), `lips` (Lips). */
186
186
  alligator: {
187
187
  params: {
188
- /** Default 13. */
188
+ /** A whole number, at least 1. Default 13. */
189
189
  jaw?: NumberParam;
190
- /** Default 8. */
190
+ /** A whole number, at least 1. Default 8. */
191
191
  teeth?: NumberParam;
192
- /** Default 5. */
192
+ /** A whole number, at least 1. Default 5. */
193
193
  lips?: NumberParam;
194
- /** Default 8. */
194
+ /** A whole number, at least 0. Default 8. */
195
195
  jawShift?: NumberParam;
196
- /** Default 5. */
196
+ /** A whole number, at least 0. Default 5. */
197
197
  teethShift?: NumberParam;
198
- /** Default 3. */
198
+ /** A whole number, at least 0. Default 3. */
199
199
  lipsShift?: NumberParam;
200
200
  };
201
201
  lines: 'jaw' | 'teeth' | 'lips';
@@ -203,7 +203,7 @@ export interface BuiltInIndicators {
203
203
  /** Volume Weighted Moving Average, on the price pane. Lines: `value` (VWMA). */
204
204
  vwma: {
205
205
  params: {
206
- /** Default 20. */
206
+ /** A whole number, at least 1. Default 20. */
207
207
  period?: NumberParam;
208
208
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
209
209
  source?: string;
@@ -213,7 +213,7 @@ export interface BuiltInIndicators {
213
213
  /** Weighted Moving Average, on the price pane. Lines: `value` (WMA). */
214
214
  wma: {
215
215
  params: {
216
- /** Default 20. */
216
+ /** A whole number, at least 1. Default 20. */
217
217
  period?: NumberParam;
218
218
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
219
219
  source?: string;
@@ -223,9 +223,9 @@ export interface BuiltInIndicators {
223
223
  /** Moving Average Envelope, on the price pane. Lines: `upper` (Upper), `basis` (Basis), `lower` (Lower). */
224
224
  envelope: {
225
225
  params: {
226
- /** Default 20. */
226
+ /** A whole number, at least 1. Default 20. */
227
227
  period?: NumberParam;
228
- /** Default 2.5. */
228
+ /** At least 0, in steps of 0.1. Default 2.5. */
229
229
  percent?: NumberParam;
230
230
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
231
231
  source?: string;
@@ -235,7 +235,7 @@ export interface BuiltInIndicators {
235
235
  /** Triple EMA, on the price pane. Lines: `value` (TEMA). */
236
236
  tema: {
237
237
  params: {
238
- /** Default 20. */
238
+ /** A whole number, at least 1. Default 20. */
239
239
  period?: NumberParam;
240
240
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
241
241
  source?: string;
@@ -245,7 +245,7 @@ export interface BuiltInIndicators {
245
245
  /** Relative Strength Index, in a pane of its own. Lines: `value` (RSI). Levels at 30, 70. */
246
246
  rsi: {
247
247
  params: {
248
- /** Default 14. */
248
+ /** A whole number, at least 1. Default 14. */
249
249
  period?: NumberParam;
250
250
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
251
251
  source?: string;
@@ -255,11 +255,11 @@ export interface BuiltInIndicators {
255
255
  /** MACD, in a pane of its own. Lines: `histogram` (Histogram), `macd` (MACD), `signal` (Signal). */
256
256
  macd: {
257
257
  params: {
258
- /** Default 12. */
258
+ /** A whole number, at least 1. Default 12. */
259
259
  fast?: NumberParam;
260
- /** Default 26. */
260
+ /** A whole number, at least 1. Default 26. */
261
261
  slow?: NumberParam;
262
- /** Default 9. */
262
+ /** A whole number, at least 1. Default 9. */
263
263
  signal?: NumberParam;
264
264
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
265
265
  source?: string;
@@ -269,11 +269,11 @@ export interface BuiltInIndicators {
269
269
  /** Stochastic Oscillator, in a pane of its own. Lines: `k` (%K), `d` (%D). Levels at 20, 80. */
270
270
  stochastic: {
271
271
  params: {
272
- /** Default 14. */
272
+ /** A whole number, at least 1. Default 14. */
273
273
  kPeriod?: NumberParam;
274
- /** Default 3. */
274
+ /** A whole number, at least 1. Default 3. */
275
275
  dPeriod?: NumberParam;
276
- /** Default 3. */
276
+ /** A whole number, at least 1. Default 3. */
277
277
  smooth?: NumberParam;
278
278
  };
279
279
  lines: 'k' | 'd';
@@ -281,7 +281,7 @@ export interface BuiltInIndicators {
281
281
  /** Average True Range, in a pane of its own. Lines: `value` (ATR). */
282
282
  atr: {
283
283
  params: {
284
- /** Default 14. */
284
+ /** A whole number, at least 1. Default 14. */
285
285
  period?: NumberParam;
286
286
  };
287
287
  lines: 'value';
@@ -289,7 +289,7 @@ export interface BuiltInIndicators {
289
289
  /** Average Directional Index, in a pane of its own. Lines: `adx` (ADX), `plusDI` (+DI), `minusDI` (−DI). */
290
290
  adx: {
291
291
  params: {
292
- /** Default 14. */
292
+ /** A whole number, at least 1. Default 14. */
293
293
  period?: NumberParam;
294
294
  };
295
295
  lines: 'adx' | 'plusDI' | 'minusDI';
@@ -302,7 +302,7 @@ export interface BuiltInIndicators {
302
302
  /** Williams %R, in a pane of its own. Lines: `value` (%R). Levels at -80, -20. */
303
303
  williamsR: {
304
304
  params: {
305
- /** Default 14. */
305
+ /** A whole number, at least 1. Default 14. */
306
306
  period?: NumberParam;
307
307
  };
308
308
  lines: 'value';
@@ -310,7 +310,7 @@ export interface BuiltInIndicators {
310
310
  /** Commodity Channel Index, in a pane of its own. Lines: `value` (CCI). Levels at -100, 0, 100. */
311
311
  cci: {
312
312
  params: {
313
- /** Default 20. */
313
+ /** A whole number, at least 1. Default 20. */
314
314
  period?: NumberParam;
315
315
  };
316
316
  lines: 'value';
@@ -318,7 +318,7 @@ export interface BuiltInIndicators {
318
318
  /** Money Flow Index, in a pane of its own. Lines: `value` (MFI). Levels at 20, 80. */
319
319
  mfi: {
320
320
  params: {
321
- /** Default 14. */
321
+ /** A whole number, at least 1. Default 14. */
322
322
  period?: NumberParam;
323
323
  };
324
324
  lines: 'value';
@@ -326,7 +326,7 @@ export interface BuiltInIndicators {
326
326
  /** Aroon, in a pane of its own. Lines: `up` (Up), `down` (Down). */
327
327
  aroon: {
328
328
  params: {
329
- /** Default 25. */
329
+ /** A whole number, at least 1. Default 25. */
330
330
  period?: NumberParam;
331
331
  };
332
332
  lines: 'up' | 'down';
@@ -334,7 +334,7 @@ export interface BuiltInIndicators {
334
334
  /** Rate of Change, in a pane of its own. Lines: `value` (ROC). Levels at 0. */
335
335
  roc: {
336
336
  params: {
337
- /** Default 12. */
337
+ /** A whole number, at least 1. Default 12. */
338
338
  period?: NumberParam;
339
339
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
340
340
  source?: string;
@@ -344,11 +344,11 @@ export interface BuiltInIndicators {
344
344
  /** True Strength Index, in a pane of its own. Lines: `tsi` (TSI), `signal` (Signal). Levels at 0. */
345
345
  tsi: {
346
346
  params: {
347
- /** Default 25. */
347
+ /** A whole number, at least 1. Default 25. */
348
348
  longPeriod?: NumberParam;
349
- /** Default 13. */
349
+ /** A whole number, at least 1. Default 13. */
350
350
  shortPeriod?: NumberParam;
351
- /** Default 7. */
351
+ /** A whole number, at least 1. Default 7. */
352
352
  signalPeriod?: NumberParam;
353
353
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
354
354
  source?: string;
@@ -358,7 +358,7 @@ export interface BuiltInIndicators {
358
358
  /** Chaikin Money Flow, in a pane of its own. Lines: `value` (CMF). */
359
359
  cmf: {
360
360
  params: {
361
- /** Default 20. */
361
+ /** A whole number, at least 1. Default 20. */
362
362
  period?: NumberParam;
363
363
  };
364
364
  lines: 'value';
@@ -366,7 +366,7 @@ export interface BuiltInIndicators {
366
366
  /** Standard Deviation, in a pane of its own. Lines: `value` (StdDev). */
367
367
  stddev: {
368
368
  params: {
369
- /** Default 20. */
369
+ /** A whole number, at least 1. Default 20. */
370
370
  period?: NumberParam;
371
371
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
372
372
  source?: string;
@@ -376,7 +376,7 @@ export interface BuiltInIndicators {
376
376
  /** Volume Profile, on the price pane. No lines. */
377
377
  volumeProfile: {
378
378
  params: {
379
- /** Default 24. */
379
+ /** A whole number, at least 1. Default 24. */
380
380
  rows?: NumberParam;
381
381
  };
382
382
  lines: never;
@@ -389,7 +389,7 @@ export interface BuiltInIndicators {
389
389
  /** Volume Rate of Change, in a pane of its own. Lines: `value` (VROC). Levels at 0. */
390
390
  vroc: {
391
391
  params: {
392
- /** Default 14. */
392
+ /** A whole number, at least 1. Default 14. */
393
393
  period?: NumberParam;
394
394
  };
395
395
  lines: 'value';
@@ -397,9 +397,9 @@ export interface BuiltInIndicators {
397
397
  /** Awesome Oscillator, in a pane of its own. Lines: `value` (AO). */
398
398
  ao: {
399
399
  params: {
400
- /** Default 5. */
400
+ /** A whole number, at least 1. Default 5. */
401
401
  fast?: NumberParam;
402
- /** Default 34. */
402
+ /** A whole number, at least 1. Default 34. */
403
403
  slow?: NumberParam;
404
404
  };
405
405
  lines: 'value';
@@ -407,9 +407,9 @@ export interface BuiltInIndicators {
407
407
  /** Chaikin Oscillator, in a pane of its own. Lines: `value` (Chaikin). */
408
408
  chaikinOsc: {
409
409
  params: {
410
- /** Default 3. */
410
+ /** A whole number, at least 1. Default 3. */
411
411
  fast?: NumberParam;
412
- /** Default 10. */
412
+ /** A whole number, at least 1. Default 10. */
413
413
  slow?: NumberParam;
414
414
  };
415
415
  lines: 'value';
@@ -417,7 +417,7 @@ export interface BuiltInIndicators {
417
417
  /** Volume Delta, in a pane of its own. Lines: `value` (Delta). */
418
418
  voldelta: {
419
419
  params: {
420
- /** Default 0. */
420
+ /** A whole number, at least 0, at most 1. Default 0. */
421
421
  mode?: NumberParam;
422
422
  };
423
423
  lines: 'value';
@@ -425,7 +425,7 @@ export interface BuiltInIndicators {
425
425
  /** Vortex Indicator, in a pane of its own. Lines: `viPlus` (VI+), `viMinus` (VI−). Levels at 1. */
426
426
  vortex: {
427
427
  params: {
428
- /** Default 14. */
428
+ /** A whole number, at least 1. Default 14. */
429
429
  period?: NumberParam;
430
430
  };
431
431
  lines: 'viPlus' | 'viMinus';
@@ -433,7 +433,7 @@ export interface BuiltInIndicators {
433
433
  /** Choppiness Index, in a pane of its own. Lines: `value` (CHOP). Levels at 38.2, 61.8. */
434
434
  chop: {
435
435
  params: {
436
- /** Default 14. */
436
+ /** A whole number, at least 2. Default 14. */
437
437
  period?: NumberParam;
438
438
  };
439
439
  lines: 'value';
@@ -441,11 +441,11 @@ export interface BuiltInIndicators {
441
441
  /** Ultimate Oscillator, in a pane of its own. Lines: `value` (UO). Levels at 30, 70. */
442
442
  uo: {
443
443
  params: {
444
- /** Default 7. */
444
+ /** A whole number, at least 1. Default 7. */
445
445
  fast?: NumberParam;
446
- /** Default 14. */
446
+ /** A whole number, at least 1. Default 14. */
447
447
  mid?: NumberParam;
448
- /** Default 28. */
448
+ /** A whole number, at least 1. Default 28. */
449
449
  slow?: NumberParam;
450
450
  };
451
451
  lines: 'value';
@@ -453,7 +453,7 @@ export interface BuiltInIndicators {
453
453
  /** Force Index, in a pane of its own. Lines: `value` (EFI). Levels at 0. */
454
454
  fi: {
455
455
  params: {
456
- /** Default 13. */
456
+ /** A whole number, at least 1. Default 13. */
457
457
  period?: NumberParam;
458
458
  };
459
459
  lines: 'value';
@@ -461,11 +461,11 @@ export interface BuiltInIndicators {
461
461
  /** Connors RSI, in a pane of its own. Lines: `value` (CRSI). Levels at 10, 90. */
462
462
  crsi: {
463
463
  params: {
464
- /** Default 3. */
464
+ /** A whole number, at least 1. Default 3. */
465
465
  rsiPeriod?: NumberParam;
466
- /** Default 2. */
466
+ /** A whole number, at least 1. Default 2. */
467
467
  streakPeriod?: NumberParam;
468
- /** Default 100. */
468
+ /** A whole number, at least 1. Default 100. */
469
469
  rankPeriod?: NumberParam;
470
470
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
471
471
  source?: string;
@@ -475,11 +475,11 @@ export interface BuiltInIndicators {
475
475
  /** Coppock Curve, in a pane of its own. Lines: `value` (Coppock). Levels at 0. */
476
476
  coppock: {
477
477
  params: {
478
- /** Default 14. */
478
+ /** A whole number, at least 1. Default 14. */
479
479
  longRoc?: NumberParam;
480
- /** Default 11. */
480
+ /** A whole number, at least 1. Default 11. */
481
481
  shortRoc?: NumberParam;
482
- /** Default 10. */
482
+ /** A whole number, at least 1. Default 10. */
483
483
  wma?: NumberParam;
484
484
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
485
485
  source?: string;
@@ -489,23 +489,23 @@ export interface BuiltInIndicators {
489
489
  /** Know Sure Thing, in a pane of its own. Lines: `value` (KST), `signal` (Signal). Levels at 0. */
490
490
  kst: {
491
491
  params: {
492
- /** Default 10. */
492
+ /** A whole number, at least 1. Default 10. */
493
493
  roc1?: NumberParam;
494
- /** Default 15. */
494
+ /** A whole number, at least 1. Default 15. */
495
495
  roc2?: NumberParam;
496
- /** Default 20. */
496
+ /** A whole number, at least 1. Default 20. */
497
497
  roc3?: NumberParam;
498
- /** Default 30. */
498
+ /** A whole number, at least 1. Default 30. */
499
499
  roc4?: NumberParam;
500
- /** Default 10. */
500
+ /** A whole number, at least 1. Default 10. */
501
501
  sma1?: NumberParam;
502
- /** Default 10. */
502
+ /** A whole number, at least 1. Default 10. */
503
503
  sma2?: NumberParam;
504
- /** Default 10. */
504
+ /** A whole number, at least 1. Default 10. */
505
505
  sma3?: NumberParam;
506
- /** Default 15. */
506
+ /** A whole number, at least 1. Default 15. */
507
507
  sma4?: NumberParam;
508
- /** Default 9. */
508
+ /** A whole number, at least 1. Default 9. */
509
509
  signal?: NumberParam;
510
510
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
511
511
  source?: string;
@@ -515,7 +515,7 @@ export interface BuiltInIndicators {
515
515
  /** Elder Ray, in a pane of its own. Lines: `bull` (Bull), `bear` (Bear). */
516
516
  elderray: {
517
517
  params: {
518
- /** Default 13. */
518
+ /** A whole number, at least 1. Default 13. */
519
519
  period?: NumberParam;
520
520
  };
521
521
  lines: 'bull' | 'bear';
@@ -523,11 +523,11 @@ export interface BuiltInIndicators {
523
523
  /** Schaff Trend Cycle, in a pane of its own. Lines: `value` (STC). Levels at 25, 75. */
524
524
  stc: {
525
525
  params: {
526
- /** Default 23. */
526
+ /** A whole number, at least 1. Default 23. */
527
527
  fast?: NumberParam;
528
- /** Default 50. */
528
+ /** A whole number, at least 1. Default 50. */
529
529
  slow?: NumberParam;
530
- /** Default 10. */
530
+ /** A whole number, at least 1. Default 10. */
531
531
  cycle?: NumberParam;
532
532
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
533
533
  source?: string;
@@ -537,11 +537,11 @@ export interface BuiltInIndicators {
537
537
  /** Klinger Oscillator, in a pane of its own. Lines: `value` (KVO), `signal` (Signal). Levels at 0. */
538
538
  kvo: {
539
539
  params: {
540
- /** Default 34. */
540
+ /** A whole number, at least 1. Default 34. */
541
541
  fast?: NumberParam;
542
- /** Default 55. */
542
+ /** A whole number, at least 1. Default 55. */
543
543
  slow?: NumberParam;
544
- /** Default 13. */
544
+ /** A whole number, at least 1. Default 13. */
545
545
  signal?: NumberParam;
546
546
  };
547
547
  lines: 'value' | 'signal';
@@ -549,7 +549,7 @@ export interface BuiltInIndicators {
549
549
  /** Fisher Transform, in a pane of its own. Lines: `value` (Fisher), `trigger` (Trigger). Levels at 0. */
550
550
  fisher: {
551
551
  params: {
552
- /** Default 9. */
552
+ /** A whole number, at least 1. Default 9. */
553
553
  period?: NumberParam;
554
554
  };
555
555
  lines: 'value' | 'trigger';
@@ -557,7 +557,7 @@ export interface BuiltInIndicators {
557
557
  /** Detrended Price Oscillator, in a pane of its own. Lines: `value` (DPO). */
558
558
  dpo: {
559
559
  params: {
560
- /** Default 20. */
560
+ /** A whole number, at least 2. Default 20. */
561
561
  period?: NumberParam;
562
562
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
563
563
  source?: string;
@@ -567,7 +567,7 @@ export interface BuiltInIndicators {
567
567
  /** Balance of Power, in a pane of its own. Lines: `value` (BOP). Levels at 0. */
568
568
  bop: {
569
569
  params: {
570
- /** Default 14. */
570
+ /** A whole number, at least 1. Default 14. */
571
571
  smooth?: NumberParam;
572
572
  };
573
573
  lines: 'value';
@@ -575,9 +575,9 @@ export interface BuiltInIndicators {
575
575
  /** Mass Index, in a pane of its own. Lines: `value` (Mass). Levels at 26.5, 27. */
576
576
  massindex: {
577
577
  params: {
578
- /** Default 9. */
578
+ /** A whole number, at least 1. Default 9. */
579
579
  ema?: NumberParam;
580
- /** Default 25. */
580
+ /** A whole number, at least 1. Default 25. */
581
581
  sum?: NumberParam;
582
582
  };
583
583
  lines: 'value';
@@ -585,7 +585,7 @@ export interface BuiltInIndicators {
585
585
  /** Chande Momentum, in a pane of its own. Lines: `value` (CMO). Levels at -50, 0, 50. */
586
586
  cmo: {
587
587
  params: {
588
- /** Default 9. */
588
+ /** A whole number, at least 1. Default 9. */
589
589
  period?: NumberParam;
590
590
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
591
591
  source?: string;
@@ -595,9 +595,9 @@ export interface BuiltInIndicators {
595
595
  /** TRIX, in a pane of its own. Lines: `value` (TRIX), `signal` (Signal). Levels at 0. */
596
596
  trix: {
597
597
  params: {
598
- /** Default 15. */
598
+ /** A whole number, at least 1. Default 15. */
599
599
  period?: NumberParam;
600
- /** Default 9. */
600
+ /** A whole number, at least 1. Default 9. */
601
601
  signal?: NumberParam;
602
602
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
603
603
  source?: string;
@@ -607,7 +607,7 @@ export interface BuiltInIndicators {
607
607
  /** Ease of Movement, in a pane of its own. Lines: `value` (EOM). Levels at 0. */
608
608
  emv: {
609
609
  params: {
610
- /** Default 14. */
610
+ /** A whole number, at least 1. Default 14. */
611
611
  period?: NumberParam;
612
612
  };
613
613
  lines: 'value';
@@ -625,9 +625,9 @@ export interface BuiltInIndicators {
625
625
  /** Chaikin Volatility, in a pane of its own. Lines: `value` (CV). Levels at 0. */
626
626
  chaikinvol: {
627
627
  params: {
628
- /** Default 10. */
628
+ /** A whole number, at least 1. Default 10. */
629
629
  ema?: NumberParam;
630
- /** Default 10. */
630
+ /** A whole number, at least 1. Default 10. */
631
631
  roc?: NumberParam;
632
632
  };
633
633
  lines: 'value';
@@ -635,7 +635,7 @@ export interface BuiltInIndicators {
635
635
  /** Relative Vigor Index, in a pane of its own. Lines: `value` (RVGI), `signal` (Signal). Levels at 0. */
636
636
  rvi: {
637
637
  params: {
638
- /** Default 10. */
638
+ /** A whole number, at least 1. Default 10. */
639
639
  period?: NumberParam;
640
640
  };
641
641
  lines: 'value' | 'signal';
@@ -643,13 +643,13 @@ export interface BuiltInIndicators {
643
643
  /** Stochastic RSI, in a pane of its own. Lines: `k` (%K), `d` (%D). Levels at 20, 80. */
644
644
  stochrsi: {
645
645
  params: {
646
- /** Default 14. */
646
+ /** A whole number, at least 1. Default 14. */
647
647
  rsiPeriod?: NumberParam;
648
- /** Default 14. */
648
+ /** A whole number, at least 1. Default 14. */
649
649
  stochPeriod?: NumberParam;
650
- /** Default 3. */
650
+ /** A whole number, at least 1. Default 3. */
651
651
  k?: NumberParam;
652
- /** Default 3. */
652
+ /** A whole number, at least 1. Default 3. */
653
653
  d?: NumberParam;
654
654
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
655
655
  source?: string;
@@ -659,11 +659,11 @@ export interface BuiltInIndicators {
659
659
  /** Percentage Price Oscillator, in a pane of its own. Lines: `hist` (Histogram), `value` (PPO), `signal` (Signal). Levels at 0. */
660
660
  ppo: {
661
661
  params: {
662
- /** Default 12. */
662
+ /** A whole number, at least 1. Default 12. */
663
663
  fast?: NumberParam;
664
- /** Default 26. */
664
+ /** A whole number, at least 1. Default 26. */
665
665
  slow?: NumberParam;
666
- /** Default 9. */
666
+ /** A whole number, at least 1. Default 9. */
667
667
  signal?: NumberParam;
668
668
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
669
669
  source?: string;
@@ -678,9 +678,9 @@ export interface BuiltInIndicators {
678
678
  /** Relative Momentum Index, in a pane of its own. Lines: `value` (RMI). Levels at 30, 70. */
679
679
  rmi: {
680
680
  params: {
681
- /** Default 20. */
681
+ /** A whole number, at least 1. Default 20. */
682
682
  period?: NumberParam;
683
- /** Default 5. */
683
+ /** A whole number, at least 1. Default 5. */
684
684
  momentum?: NumberParam;
685
685
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
686
686
  source?: string;
@@ -690,7 +690,7 @@ export interface BuiltInIndicators {
690
690
  /** Disparity Index, in a pane of its own. Lines: `value` (DI). Levels at 0. */
691
691
  disparity: {
692
692
  params: {
693
- /** Default 14. */
693
+ /** A whole number, at least 1. Default 14. */
694
694
  period?: NumberParam;
695
695
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
696
696
  source?: string;
@@ -700,7 +700,7 @@ export interface BuiltInIndicators {
700
700
  /** Qstick, in a pane of its own. Lines: `value` (Qstick). Levels at 0. */
701
701
  qstick: {
702
702
  params: {
703
- /** Default 8. */
703
+ /** A whole number, at least 1. Default 8. */
704
704
  period?: NumberParam;
705
705
  };
706
706
  lines: 'value';
@@ -708,7 +708,7 @@ export interface BuiltInIndicators {
708
708
  /** Pretty Good Oscillator, in a pane of its own. Lines: `value` (PGO). Levels at -3, 0, 3. */
709
709
  pgo: {
710
710
  params: {
711
- /** Default 14. */
711
+ /** A whole number, at least 1. Default 14. */
712
712
  period?: NumberParam;
713
713
  };
714
714
  lines: 'value';
@@ -716,7 +716,7 @@ export interface BuiltInIndicators {
716
716
  /** Double Exponential Moving Average, on the price pane. Lines: `value` (DEMA). */
717
717
  dema: {
718
718
  params: {
719
- /** At least 1. Default 20. */
719
+ /** A whole number, at least 1. Default 20. */
720
720
  period?: NumberParam;
721
721
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
722
722
  source?: string;
@@ -726,7 +726,7 @@ export interface BuiltInIndicators {
726
726
  /** Smoothed Moving Average, on the price pane. Lines: `value` (SMMA). */
727
727
  smma: {
728
728
  params: {
729
- /** At least 1. Default 14. */
729
+ /** A whole number, at least 1. Default 14. */
730
730
  period?: NumberParam;
731
731
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
732
732
  source?: string;
@@ -736,7 +736,7 @@ export interface BuiltInIndicators {
736
736
  /** Arnaud Legoux Moving Average, on the price pane. Lines: `value` (ALMA). */
737
737
  alma: {
738
738
  params: {
739
- /** At least 1, at most 5000. Default 9. */
739
+ /** A whole number, at least 1, at most 5000. Default 9. */
740
740
  period?: NumberParam;
741
741
  /** At least 0, at most 1, in steps of 0.05. Default 0.85. */
742
742
  offset?: NumberParam;
@@ -750,11 +750,11 @@ export interface BuiltInIndicators {
750
750
  /** Kaufman Adaptive Moving Average, on the price pane. Lines: `value` (KAMA). */
751
751
  kama: {
752
752
  params: {
753
- /** At least 1. Default 10. */
753
+ /** A whole number, at least 1. Default 10. */
754
754
  period?: NumberParam;
755
- /** At least 1. Default 2. */
755
+ /** A whole number, at least 1. Default 2. */
756
756
  fast?: NumberParam;
757
- /** At least 1. Default 30. */
757
+ /** A whole number, at least 1. Default 30. */
758
758
  slow?: NumberParam;
759
759
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
760
760
  source?: string;
@@ -764,9 +764,9 @@ export interface BuiltInIndicators {
764
764
  /** Least Squares Moving Average, on the price pane. Lines: `value` (LSMA). */
765
765
  lsma: {
766
766
  params: {
767
- /** At least 2, at most 5000. Default 25. */
767
+ /** A whole number, at least 2, at most 5000. Default 25. */
768
768
  period?: NumberParam;
769
- /** In steps of 1. Default 0. */
769
+ /** A whole number, in steps of 1. Default 0. */
770
770
  offset?: NumberParam;
771
771
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
772
772
  source?: string;
@@ -776,7 +776,7 @@ export interface BuiltInIndicators {
776
776
  /** McGinley Dynamic, on the price pane. Lines: `value` (McGinley). */
777
777
  mcginley: {
778
778
  params: {
779
- /** At least 1. Default 14. */
779
+ /** A whole number, at least 1. Default 14. */
780
780
  period?: NumberParam;
781
781
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
782
782
  source?: string;
@@ -786,9 +786,9 @@ export interface BuiltInIndicators {
786
786
  /** MA Cross, on the price pane. Lines: `fast` (Fast), `slow` (Slow). */
787
787
  macross: {
788
788
  params: {
789
- /** At least 1. Default 9. */
789
+ /** A whole number, at least 1. Default 9. */
790
790
  fast?: NumberParam;
791
- /** At least 1. Default 21. */
791
+ /** A whole number, at least 1. Default 21. */
792
792
  slow?: NumberParam;
793
793
  /** Default `'sma'`. */
794
794
  type?: 'sma' | 'ema' | 'sma-ema' | (string & {});
@@ -800,7 +800,7 @@ export interface BuiltInIndicators {
800
800
  /** Williams Fractals, on the price pane. Lines: `up` (Up), `down` (Down). */
801
801
  fractals: {
802
802
  params: {
803
- /** At least 1, at most 10. Default 2. */
803
+ /** A whole number, at least 1, at most 10. Default 2. */
804
804
  period?: NumberParam;
805
805
  };
806
806
  lines: 'up' | 'down';
@@ -808,11 +808,11 @@ export interface BuiltInIndicators {
808
808
  /** Chande Kroll Stop, on the price pane. Lines: `long` (Stop Long), `short` (Stop Short). */
809
809
  cks: {
810
810
  params: {
811
- /** ATR length. At least 1. Default 10. */
811
+ /** ATR length. A whole number, at least 1. Default 10. */
812
812
  p?: NumberParam;
813
813
  /** ATR multiplier. At least 0, in steps of 0.1. Default 1. */
814
814
  x?: NumberParam;
815
- /** Stop length. At least 1. Default 9. */
815
+ /** Stop length. A whole number, at least 1. Default 9. */
816
816
  q?: NumberParam;
817
817
  };
818
818
  lines: 'long' | 'short';
@@ -820,7 +820,7 @@ export interface BuiltInIndicators {
820
820
  /** Bollinger Bands %B, in a pane of its own. Lines: `value` (%B). Levels at 0, 0.5, 1. */
821
821
  bbpb: {
822
822
  params: {
823
- /** At least 2. Default 20. */
823
+ /** A whole number, at least 2. Default 20. */
824
824
  period?: NumberParam;
825
825
  /** At least 0.1, in steps of 0.1. Default 2. */
826
826
  stdDev?: NumberParam;
@@ -832,7 +832,7 @@ export interface BuiltInIndicators {
832
832
  /** Bollinger BandWidth, in a pane of its own. Lines: `value` (BBW). */
833
833
  bbw: {
834
834
  params: {
835
- /** At least 2. Default 20. */
835
+ /** A whole number, at least 2. Default 20. */
836
836
  period?: NumberParam;
837
837
  /** At least 0.1, in steps of 0.1. Default 2. */
838
838
  stdDev?: NumberParam;
@@ -844,7 +844,7 @@ export interface BuiltInIndicators {
844
844
  /** Momentum, in a pane of its own. Lines: `value` (MOM). Levels at 0. */
845
845
  mom: {
846
846
  params: {
847
- /** At least 1. Default 10. */
847
+ /** A whole number, at least 1. Default 10. */
848
848
  period?: NumberParam;
849
849
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
850
850
  source?: string;
@@ -854,7 +854,7 @@ export interface BuiltInIndicators {
854
854
  /** Historical Volatility, in a pane of its own. Lines: `value` (HV). */
855
855
  hv: {
856
856
  params: {
857
- /** At least 2. Default 10. */
857
+ /** A whole number, at least 2. Default 10. */
858
858
  period?: NumberParam;
859
859
  /** Bars per year. At least 1. Default 365. */
860
860
  annual?: NumberParam;
@@ -866,9 +866,9 @@ export interface BuiltInIndicators {
866
866
  /** Volume Oscillator, in a pane of its own. Lines: `value` (Vol Osc). Levels at 0. */
867
867
  vo: {
868
868
  params: {
869
- /** At least 1. Default 5. */
869
+ /** A whole number, at least 1. Default 5. */
870
870
  short?: NumberParam;
871
- /** At least 1. Default 10. */
871
+ /** A whole number, at least 1. Default 10. */
872
872
  long?: NumberParam;
873
873
  };
874
874
  lines: 'value';
@@ -876,7 +876,7 @@ export interface BuiltInIndicators {
876
876
  /** Ulcer Index, in a pane of its own. Lines: `value` (Ulcer). */
877
877
  ulcer: {
878
878
  params: {
879
- /** At least 1. Default 14. */
879
+ /** A whole number, at least 1. Default 14. */
880
880
  period?: NumberParam;
881
881
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
882
882
  source?: string;
@@ -886,11 +886,11 @@ export interface BuiltInIndicators {
886
886
  /** Stochastic Momentum Index, in a pane of its own. Lines: `smi` (SMI), `signal` (Signal). Levels at 40, -40. */
887
887
  smi: {
888
888
  params: {
889
- /** At least 1. Default 10. */
889
+ /** A whole number, at least 1. Default 10. */
890
890
  period?: NumberParam;
891
- /** At least 1. Default 3. */
891
+ /** A whole number, at least 1. Default 3. */
892
892
  smooth?: NumberParam;
893
- /** At least 1. Default 3. */
893
+ /** A whole number, at least 1. Default 3. */
894
894
  signal?: NumberParam;
895
895
  };
896
896
  lines: 'smi' | 'signal';
@@ -898,9 +898,9 @@ export interface BuiltInIndicators {
898
898
  /** Relative Volatility Index, in a pane of its own. Lines: `value` (RVI). Levels at 80, 50, 20. */
899
899
  rvix: {
900
900
  params: {
901
- /** At least 2. Default 10. */
901
+ /** A whole number, at least 2. Default 10. */
902
902
  period?: NumberParam;
903
- /** At least 1. Default 14. */
903
+ /** A whole number, at least 1. Default 14. */
904
904
  smooth?: NumberParam;
905
905
  };
906
906
  lines: 'value';
@@ -908,7 +908,7 @@ export interface BuiltInIndicators {
908
908
  /** Trend Strength Index, in a pane of its own. Lines: `value` (Trend). Levels at 0. */
909
909
  trendstrength: {
910
910
  params: {
911
- /** At least 2. Default 14. */
911
+ /** A whole number, at least 2. Default 14. */
912
912
  period?: NumberParam;
913
913
  };
914
914
  lines: 'value';
@@ -916,7 +916,7 @@ export interface BuiltInIndicators {
916
916
  /** Linear Regression Slope, in a pane of its own. Lines: `value` (Slope). Levels at 0. */
917
917
  lrslope: {
918
918
  params: {
919
- /** At least 2. Default 14. */
919
+ /** A whole number, at least 2. Default 14. */
920
920
  period?: NumberParam;
921
921
  };
922
922
  lines: 'value';
@@ -924,7 +924,7 @@ export interface BuiltInIndicators {
924
924
  /** Standard Error, in a pane of its own. Lines: `value` (StdErr). */
925
925
  stderror: {
926
926
  params: {
927
- /** At least 3. Default 14. */
927
+ /** A whole number, at least 3. Default 14. */
928
928
  period?: NumberParam;
929
929
  };
930
930
  lines: 'value';
@@ -932,7 +932,7 @@ export interface BuiltInIndicators {
932
932
  /** Average Day Range, in a pane of its own. Lines: `value` (ADR). */
933
933
  adr: {
934
934
  params: {
935
- /** At least 1. Default 14. */
935
+ /** A whole number, at least 1. Default 14. */
936
936
  period?: NumberParam;
937
937
  };
938
938
  lines: 'value';
@@ -945,11 +945,11 @@ export interface BuiltInIndicators {
945
945
  /** Standard Error Bands, on the price pane. Lines: `upper` (Upper), `middle` (Middle), `lower` (Lower). */
946
946
  seb: {
947
947
  params: {
948
- /** At least 3. Default 21. */
948
+ /** A whole number, at least 3. Default 21. */
949
949
  period?: NumberParam;
950
950
  /** At least 0, in steps of 0.1. Default 2. */
951
951
  mult?: NumberParam;
952
- /** At least 1. Default 3. */
952
+ /** A whole number, at least 1. Default 3. */
953
953
  smooth?: NumberParam;
954
954
  };
955
955
  lines: 'upper' | 'middle' | 'lower';
@@ -962,15 +962,15 @@ export interface BuiltInIndicators {
962
962
  /** Moving Average Ribbon, on the price pane. Lines: `ma1` (MA 1), `ma2` (MA 2), `ma3` (MA 3), `ma4` (MA 4). */
963
963
  maribbon: {
964
964
  params: {
965
- /** At least 1. Default 20. */
965
+ /** A whole number, at least 1. Default 20. */
966
966
  ma1?: NumberParam;
967
- /** At least 1. Default 50. */
967
+ /** A whole number, at least 1. Default 50. */
968
968
  ma2?: NumberParam;
969
- /** At least 1. Default 100. */
969
+ /** A whole number, at least 1. Default 100. */
970
970
  ma3?: NumberParam;
971
- /** At least 1. Default 200. */
971
+ /** A whole number, at least 1. Default 200. */
972
972
  ma4?: NumberParam;
973
- /** At least 0, at most 1. Default 0. */
973
+ /** A whole number, at least 0, at most 1. Default 0. */
974
974
  exponential?: NumberParam;
975
975
  };
976
976
  lines: 'ma1' | 'ma2' | 'ma3' | 'ma4';
@@ -993,13 +993,13 @@ export interface BuiltInIndicators {
993
993
  /** Moving Average Channel, on the price pane. Lines: `upper` (Upper), `lower` (Lower). */
994
994
  machannel: {
995
995
  params: {
996
- /** At least 1. Default 20. */
996
+ /** A whole number, at least 1. Default 20. */
997
997
  upperLength?: NumberParam;
998
- /** At least 1. Default 20. */
998
+ /** A whole number, at least 1. Default 20. */
999
999
  lowerLength?: NumberParam;
1000
- /** At least -500, at most 500. Default 0. */
1000
+ /** A whole number, at least -500, at most 500. Default 0. */
1001
1001
  upperOffset?: NumberParam;
1002
- /** At least -500, at most 500. Default 0. */
1002
+ /** A whole number, at least -500, at most 500. Default 0. */
1003
1003
  lowerOffset?: NumberParam;
1004
1004
  };
1005
1005
  lines: 'upper' | 'lower';
@@ -1007,7 +1007,7 @@ export interface BuiltInIndicators {
1007
1007
  /** Moving Average Hamming, on the price pane. Lines: `value` (MA). */
1008
1008
  hamming: {
1009
1009
  params: {
1010
- /** At least 2, at most 500. Default 10. */
1010
+ /** A whole number, at least 2, at most 500. Default 10. */
1011
1011
  period?: NumberParam;
1012
1012
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
1013
1013
  source?: string;
@@ -1017,9 +1017,9 @@ export interface BuiltInIndicators {
1017
1017
  /** Moving Average Double, on the price pane. Lines: `ma1` (MA 1), `ma2` (MA 2). */
1018
1018
  madouble: {
1019
1019
  params: {
1020
- /** At least 1. Default 20. */
1020
+ /** A whole number, at least 1. Default 20. */
1021
1021
  first?: NumberParam;
1022
- /** At least 1. Default 50. */
1022
+ /** A whole number, at least 1. Default 50. */
1023
1023
  second?: NumberParam;
1024
1024
  /** Default `'sma'`. */
1025
1025
  type?: 'sma' | 'ema' | 'wma' | (string & {});
@@ -1031,11 +1031,11 @@ export interface BuiltInIndicators {
1031
1031
  /** Moving Average Triple, on the price pane. Lines: `ma1` (MA 1), `ma2` (MA 2), `ma3` (MA 3). */
1032
1032
  matriple: {
1033
1033
  params: {
1034
- /** At least 1. Default 10. */
1034
+ /** A whole number, at least 1. Default 10. */
1035
1035
  first?: NumberParam;
1036
- /** At least 1. Default 20. */
1036
+ /** A whole number, at least 1. Default 20. */
1037
1037
  second?: NumberParam;
1038
- /** At least 1. Default 50. */
1038
+ /** A whole number, at least 1. Default 50. */
1039
1039
  third?: NumberParam;
1040
1040
  /** Default `'sma'`. */
1041
1041
  type?: 'sma' | 'ema' | 'wma' | (string & {});
@@ -1047,7 +1047,7 @@ export interface BuiltInIndicators {
1047
1047
  /** Volatility Index, on the price pane. Lines: `sar` (Stop). */
1048
1048
  volindex: {
1049
1049
  params: {
1050
- /** At least 1. Default 7. */
1050
+ /** A whole number, at least 1. Default 7. */
1051
1051
  period?: NumberParam;
1052
1052
  /** ATR multiple. At least 0.1, in steps of 0.1. Default 3. */
1053
1053
  mult?: NumberParam;
@@ -1065,7 +1065,7 @@ export interface BuiltInIndicators {
1065
1065
  /** Advance/Decline, in a pane of its own. Lines: `value` (Ratio). */
1066
1066
  advdecline: {
1067
1067
  params: {
1068
- /** At least 1. Default 10. */
1068
+ /** A whole number, at least 1. Default 10. */
1069
1069
  length?: NumberParam;
1070
1070
  };
1071
1071
  lines: 'value';
@@ -1073,7 +1073,7 @@ export interface BuiltInIndicators {
1073
1073
  /** Majority Rule, in a pane of its own. Lines: `value` (Majority). Levels at 50. */
1074
1074
  majority: {
1075
1075
  params: {
1076
- /** At least 1. Default 14. */
1076
+ /** A whole number, at least 1. Default 14. */
1077
1077
  period?: NumberParam;
1078
1078
  };
1079
1079
  lines: 'value';
@@ -1086,11 +1086,11 @@ export interface BuiltInIndicators {
1086
1086
  /** SMI Ergodic, in a pane of its own. Lines: `oscillator` (Oscillator), `indicator` (Indicator), `signal` (Signal). */
1087
1087
  smiergodic: {
1088
1088
  params: {
1089
- /** At least 1. Default 5. */
1089
+ /** A whole number, at least 1. Default 5. */
1090
1090
  short?: NumberParam;
1091
- /** At least 1. Default 20. */
1091
+ /** A whole number, at least 1. Default 20. */
1092
1092
  long?: NumberParam;
1093
- /** At least 1. Default 5. */
1093
+ /** A whole number, at least 1. Default 5. */
1094
1094
  signal?: NumberParam;
1095
1095
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
1096
1096
  source?: string;
@@ -1100,9 +1100,9 @@ export interface BuiltInIndicators {
1100
1100
  /** Price Oscillator, in a pane of its own. Lines: `value` (PO). */
1101
1101
  po: {
1102
1102
  params: {
1103
- /** At least 1. Default 10. */
1103
+ /** A whole number, at least 1. Default 10. */
1104
1104
  short?: NumberParam;
1105
- /** At least 1. Default 21. */
1105
+ /** A whole number, at least 1. Default 21. */
1106
1106
  long?: NumberParam;
1107
1107
  /** A price (`'close'`, `'hl2'` …) or another indicator's line (`indicatorSource(instanceId, key)`). Default `'close'`. */
1108
1108
  source?: string;
@@ -1112,7 +1112,7 @@ export interface BuiltInIndicators {
1112
1112
  /** Volatility O-H-L-C, in a pane of its own. Lines: `value` (Volatility). */
1113
1113
  volohlc: {
1114
1114
  params: {
1115
- /** At least 1. Default 10. */
1115
+ /** A whole number, at least 1. Default 10. */
1116
1116
  period?: NumberParam;
1117
1117
  /** Bars per year. At least 1. Default 365. */
1118
1118
  annual?: NumberParam;
@@ -1122,7 +1122,7 @@ export interface BuiltInIndicators {
1122
1122
  /** Volatility Zero Trend Close-to-Close, in a pane of its own. Lines: `value` (Volatility). */
1123
1123
  volzt: {
1124
1124
  params: {
1125
- /** At least 1. Default 10. */
1125
+ /** A whole number, at least 1. Default 10. */
1126
1126
  period?: NumberParam;
1127
1127
  /** Bars per year. At least 1. Default 365. */
1128
1128
  annual?: NumberParam;
@@ -1132,7 +1132,7 @@ export interface BuiltInIndicators {
1132
1132
  /** Psychological Line, in a pane of its own. Lines: `value` (PSY). Levels at 25, 75. */
1133
1133
  psy: {
1134
1134
  params: {
1135
- /** Default 10. */
1135
+ /** A whole number, at least 1. Default 10. */
1136
1136
  period?: NumberParam;
1137
1137
  };
1138
1138
  lines: 'value';
@@ -1140,7 +1140,7 @@ export interface BuiltInIndicators {
1140
1140
  /** New Psychological Line, in a pane of its own. Lines: `value` (New PSY). Levels at -50, 0, 50. */
1141
1141
  newpsy: {
1142
1142
  params: {
1143
- /** Default 10. */
1143
+ /** A whole number, at least 1. Default 10. */
1144
1144
  period?: NumberParam;
1145
1145
  };
1146
1146
  lines: 'value';
@@ -1148,7 +1148,7 @@ export interface BuiltInIndicators {
1148
1148
  /** Volume Ratio, in a pane of its own. Lines: `value` (VR). Levels at 70, 150, 450. */
1149
1149
  vr: {
1150
1150
  params: {
1151
- /** Default 20. */
1151
+ /** A whole number, at least 1. Default 20. */
1152
1152
  period?: NumberParam;
1153
1153
  };
1154
1154
  lines: 'value';
@@ -1156,7 +1156,7 @@ export interface BuiltInIndicators {
1156
1156
  /** AB Ratio, in a pane of its own. Lines: `a` (A), `b` (B). Levels at 100. */
1157
1157
  abratio: {
1158
1158
  params: {
1159
- /** Default 26. */
1159
+ /** A whole number, at least 1. Default 26. */
1160
1160
  period?: NumberParam;
1161
1161
  };
1162
1162
  lines: 'a' | 'b';
@@ -1164,11 +1164,11 @@ export interface BuiltInIndicators {
1164
1164
  /** Sonar, in a pane of its own. Lines: `sonar` (Sonar), `signal` (Signal). Levels at 0. */
1165
1165
  sonar: {
1166
1166
  params: {
1167
- /** Default 20. */
1167
+ /** A whole number, at least 1. Default 20. */
1168
1168
  period?: NumberParam;
1169
- /** Default 9. */
1169
+ /** A whole number, at least 1. Default 9. */
1170
1170
  lookback?: NumberParam;
1171
- /** Default 9. */
1171
+ /** A whole number, at least 1. Default 9. */
1172
1172
  signal?: NumberParam;
1173
1173
  };
1174
1174
  lines: 'sonar' | 'signal';
@@ -1176,7 +1176,7 @@ export interface BuiltInIndicators {
1176
1176
  /** Sigma, in a pane of its own. Lines: `value` (Sigma). Levels at -2, 0, 2. */
1177
1177
  sigma: {
1178
1178
  params: {
1179
- /** Default 20. */
1179
+ /** A whole number, at least 2. Default 20. */
1180
1180
  period?: NumberParam;
1181
1181
  };
1182
1182
  lines: 'value';
@@ -1184,7 +1184,7 @@ export interface BuiltInIndicators {
1184
1184
  /** Vertical Horizontal Filter, in a pane of its own. Lines: `value` (VHF). */
1185
1185
  vhf: {
1186
1186
  params: {
1187
- /** Default 28. */
1187
+ /** A whole number, at least 1. Default 28. */
1188
1188
  period?: NumberParam;
1189
1189
  };
1190
1190
  lines: 'value';
@@ -1192,7 +1192,7 @@ export interface BuiltInIndicators {
1192
1192
  /** R-Squared, in a pane of its own. Lines: `value` (R²). */
1193
1193
  rsquared: {
1194
1194
  params: {
1195
- /** Default 14. */
1195
+ /** A whole number, at least 2. Default 14. */
1196
1196
  period?: NumberParam;
1197
1197
  };
1198
1198
  lines: 'value';
@@ -1200,7 +1200,7 @@ export interface BuiltInIndicators {
1200
1200
  /** Random Walk Index, in a pane of its own. Lines: `high` (RWI High), `low` (RWI Low). Levels at 1. */
1201
1201
  rwi: {
1202
1202
  params: {
1203
- /** Default 14. */
1203
+ /** A whole number, at least 2. Default 14. */
1204
1204
  period?: NumberParam;
1205
1205
  };
1206
1206
  lines: 'high' | 'low';
@@ -1208,7 +1208,7 @@ export interface BuiltInIndicators {
1208
1208
  /** Negative Volume Index, in a pane of its own. Lines: `value` (NVI), `signal` (Signal). */
1209
1209
  nvi: {
1210
1210
  params: {
1211
- /** Default 255. */
1211
+ /** A whole number, at least 1. Default 255. */
1212
1212
  signal?: NumberParam;
1213
1213
  };
1214
1214
  lines: 'value' | 'signal';
@@ -1216,7 +1216,7 @@ export interface BuiltInIndicators {
1216
1216
  /** Positive Volume Index, in a pane of its own. Lines: `value` (PVI), `signal` (Signal). */
1217
1217
  pvi: {
1218
1218
  params: {
1219
- /** Default 255. */
1219
+ /** A whole number, at least 1. Default 255. */
1220
1220
  signal?: NumberParam;
1221
1221
  };
1222
1222
  lines: 'value' | 'signal';
@@ -1229,7 +1229,7 @@ export interface BuiltInIndicators {
1229
1229
  /** Intraday Intensity, in a pane of its own. Lines: `value` (III %). Levels at 0. */
1230
1230
  iii: {
1231
1231
  params: {
1232
- /** Default 21. */
1232
+ /** A whole number, at least 1. Default 21. */
1233
1233
  period?: NumberParam;
1234
1234
  };
1235
1235
  lines: 'value';
@@ -1237,7 +1237,7 @@ export interface BuiltInIndicators {
1237
1237
  /** Volume vs Average, in a pane of its own. Lines: `value` (Vol %). Levels at 0. */
1238
1238
  volpct: {
1239
1239
  params: {
1240
- /** Default 20. */
1240
+ /** A whole number, at least 1. Default 20. */
1241
1241
  period?: NumberParam;
1242
1242
  };
1243
1243
  lines: 'value';
@@ -1255,17 +1255,17 @@ export interface BuiltInIndicators {
1255
1255
  /** Binary Wave, in a pane of its own. Lines: `value` (Wave). Levels at 0. */
1256
1256
  binarywave: {
1257
1257
  params: {
1258
- /** Default 20. */
1258
+ /** A whole number, at least 1. Default 20. */
1259
1259
  ma?: NumberParam;
1260
- /** Default 12. */
1260
+ /** A whole number, at least 1. Default 12. */
1261
1261
  fast?: NumberParam;
1262
- /** Default 26. */
1262
+ /** A whole number, at least 1. Default 26. */
1263
1263
  slow?: NumberParam;
1264
- /** Default 9. */
1264
+ /** A whole number, at least 1. Default 9. */
1265
1265
  signal?: NumberParam;
1266
- /** Default 12. */
1266
+ /** A whole number, at least 1. Default 12. */
1267
1267
  roc?: NumberParam;
1268
- /** Default 14. */
1268
+ /** A whole number, at least 1. Default 14. */
1269
1269
  stoch?: NumberParam;
1270
1270
  };
1271
1271
  lines: 'value';
@@ -1273,9 +1273,9 @@ export interface BuiltInIndicators {
1273
1273
  /** Smoothed Rate of Change, in a pane of its own. Lines: `value` (S-ROC). Levels at 0. */
1274
1274
  sroc: {
1275
1275
  params: {
1276
- /** Default 13. */
1276
+ /** A whole number, at least 1. Default 13. */
1277
1277
  ema?: NumberParam;
1278
- /** Default 21. */
1278
+ /** A whole number, at least 1. Default 21. */
1279
1279
  roc?: NumberParam;
1280
1280
  };
1281
1281
  lines: 'value';
@@ -1283,7 +1283,7 @@ export interface BuiltInIndicators {
1283
1283
  /** Time Series Forecast, on the price pane. Lines: `value` (TSF). */
1284
1284
  tsf: {
1285
1285
  params: {
1286
- /** Default 14. */
1286
+ /** A whole number, at least 2. Default 14. */
1287
1287
  period?: NumberParam;
1288
1288
  };
1289
1289
  lines: 'value';
@@ -1301,13 +1301,13 @@ export interface BuiltInIndicators {
1301
1301
  /** 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). */
1302
1302
  rainbow: {
1303
1303
  params: {
1304
- /** At least 1. Default 10. */
1304
+ /** A whole number, at least 1. Default 10. */
1305
1305
  first?: NumberParam;
1306
- /** At least 1. Default 10. */
1306
+ /** A whole number, at least 1. Default 10. */
1307
1307
  step?: NumberParam;
1308
- /** At least 1, at most 20. Default 10. */
1308
+ /** A whole number, at least 1, at most 20. Default 10. */
1309
1309
  count?: NumberParam;
1310
- /** At least 0, at most 1. Default 0. */
1310
+ /** A whole number, at least 0, at most 1. Default 0. */
1311
1311
  exponential?: NumberParam;
1312
1312
  };
1313
1313
  lines: 'ma1' | 'ma2' | 'ma3' | 'ma4' | 'ma5' | 'ma6' | 'ma7' | 'ma8' | 'ma9' | 'ma10' | 'ma11' | 'ma12' | 'ma13' | 'ma14' | 'ma15' | 'ma16' | 'ma17' | 'ma18' | 'ma19' | 'ma20';
@@ -1315,13 +1315,13 @@ export interface BuiltInIndicators {
1315
1315
  /** Candlestick Patterns, on the price pane. Lines: `bull` (Bullish), `bear` (Bearish), `neutral` (Indecision). */
1316
1316
  candlepatterns: {
1317
1317
  params: {
1318
- /** At least 2. Default 10. */
1318
+ /** A whole number, at least 2. Default 10. */
1319
1319
  trendPeriod?: NumberParam;
1320
- /** At least 0, at most 1. Default 1. */
1320
+ /** A whole number, at least 0, at most 1. Default 1. */
1321
1321
  reversal?: NumberParam;
1322
- /** At least 0, at most 1. Default 1. */
1322
+ /** A whole number, at least 0, at most 1. Default 1. */
1323
1323
  continuation?: NumberParam;
1324
- /** At least 0, at most 1. Default 0. */
1324
+ /** A whole number, at least 0, at most 1. Default 0. */
1325
1325
  indecision?: NumberParam;
1326
1326
  };
1327
1327
  lines: 'bull' | 'bear' | 'neutral';