lightweight-charts-indicators 0.9.1 → 0.10.0

package/README.md

@@ -204,7 +204,7 @@ chart.timeScale().subscribeVisibleLogicalRangeChange(range => {
 
 | Indicator | Export | Description |
 |-----------|--------|-------------|
-| MACD | `MACD` | Relationship between two EMAs |
+| MACD | `MACD` | Relationship between two moving averages (EMA or SMA) |
 | Momentum | `Momentum` | Rate of change of price |
 | Rate of Change | `ROC` | Percentage change over a period |
 | Balance of Power | `BOP` | Strength of buyers vs sellers |
@@ -375,6 +375,34 @@ const result = sma?.calculate(bars, sma.defaultInputs);
 const oscillators = indicatorRegistry.filter(i => i.category === 'Oscillators');
 ```
 
+### Settings dialog
+
+Each registry entry gives its inputs in `inputConfig`, in the order, with the titles, limits and layout of the
+original indicator. A settings dialog can be built from these fields:
+
+| Field | Meaning |
+|---|---|
+| `title`, `type`, `defval`, `options`, `min`, `max`, `step` | Label, control and limits (an empty title has no label) |
+| `group` | Section header: consecutive inputs with the same group are shown under it |
+| `inline` | Inputs with the same `inline` id are shown on one row |
+| `tooltip` | Info text of the input |
+| `display` | Where the value is shown outside the dialog (`'all'`, `'none'`, ...) |
+| `active` | The input is greyed out unless the condition on other inputs holds |
+
+```typescript
+import { isInputActive } from 'oakscriptjs';
+import { indicatorRegistry } from 'lightweight-charts-indicators';
+
+const { inputConfig } = indicatorRegistry.find(i => i.id === 'ma-ribbon')!;
+const inputs = { showMa2: false };
+
+for (const input of inputConfig) {
+  const enabled = isInputActive(input, inputs, inputConfig); // ma2Type, ma2Source, ma2Length, ma2Color: false
+}
+```
+
+An inactive input still gives its value to `calculate`.
+
 ## Building
 
 ```bash

package/dist/anchor-period.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Timeframe periods of the bars, for ports with a timeframe input (PineScript `time(tf)`, `timeframe.change(tf)`),
+ * and the chart timeframe of the bars (lower-timeframe volume ports).
+ *
+ * The original computes periods from the exchange time zone and the trading sessions of the symbol, which the bars
+ * do not carry. The port uses the UTC calendar and takes the session start of a trading day from the bars:
+ * - symbols with bars on Saturdays or Sundays trade every day: each UTC day is a trading day starting at 00:00 UTC
+ * - other symbols: the trading days are the UTC days that have bars, and a trading day starts at its first bar
+ * Then, as in the original:
+ * - "" (the chart timeframe): every bar is its own period
+ * - seconds / minutes: periods of the timeframe length aligned on the session start of the trading day
+ * - "D": the trading day; "nD": n trading days counted from the first trading day of the year (when the bars start
+ *   after it, the count starts at the first bar)
+ * - "W": the week from Monday; "nW": n weeks counted from the first Monday of the year
+ * - "M": the month; "nM": n months counted from January
+ * - `time(tf)` of D / W / M periods: the session start of the first trading day of the period (the first bar of
+ *   the period on symbols that do not trade every day)
+ * Exact on UTC 24x7 symbols and on symbols whose trading day is inside the UTC day with bars from the session start
+ * (e.g. US stocks); not on sessions that cross 00:00 UTC (futures, forex). Before the first bar the port has no
+ * trading days: the first period of the bars (the first year for "nD" on symbols that do not trade every day) can
+ * differ.
+ */
+/**
+ * PineScript `time(tf)` of each bar: the start of the `tf` period that contains the bar, in the unit of the bar
+ * times (seconds as lightweight-charts, or ms). A bar opens a new period (`timeframe.change(tf)`) when its value
+ * differs from the previous bar's. `tf` = "" (the chart timeframe) gives the bar times.
+ * @throws RangeError for a string that is not a timeframe, or a tick timeframe
+ */
+export declare function periodStarts(bars: ReadonlyArray<{
+    time: number;
+}>, tf: string): number[];
+/**
+ * Chart timeframe of the bars ("1", "60", "1D", "1W", "1M", ...), from the most frequent gap between two bars
+ * (`barInterval`): one day on daily bars even with weekends and holidays, 28 to 31 days on monthly bars.
+ * Empty string with fewer than 2 bars.
+ */
+export declare function chartTimeframe(bars: ReadonlyArray<{
+    time: number;
+}>): string;
+//# sourceMappingURL=anchor-period.d.ts.map

package/dist/anchor-period.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"anchor-period.d.ts","sourceRoot":"","sources":["../src/anchor-period.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AA2BH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CA+CxF;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,MAAM,CAQ5E"}