openalgo-charts 1.0.21 → 1.0.22

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.
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /** Library version string. Matches package.json (published npm release). */
2
- declare const VERSION = "1.0.21";
2
+ declare const VERSION = "1.0.22";
3
3
  /** Returns the current library version. */
4
4
  declare function version(): string;
5
5
 
@@ -1730,17 +1730,17 @@ interface ChartOptions {
1730
1730
  * land underneath and their settings / close buttons become invisible and
1731
1731
  * unclickable.
1732
1732
  *
1733
- * `paneIndex` defaults to 0, because that overlay is nearly always on the
1734
- * price pane. Every other pane keeps the default corner: a lower indicator
1735
- * pane is short, so applying a price-pane offset there would push its legend
1736
- * off the pane entirely.
1733
+ * It follows whichever pane currently renders at that corner, which is
1734
+ * normally pane 0 but maximizing a lower pane parks the others at a
1735
+ * placeholder weight, so the maximized pane moves into the same corner and
1736
+ * inherits the offset. Every other pane keeps the default corner, because a
1737
+ * short lower pane would have its legend pushed off it entirely.
1737
1738
  *
1738
- * Defaults to `{ top: 6, left: 8, paneIndex: 0 }`.
1739
+ * Defaults to `{ top: 6, left: 8 }`.
1739
1740
  */
1740
1741
  legendOffset?: {
1741
1742
  top?: number;
1742
1743
  left?: number;
1743
- paneIndex?: number;
1744
1744
  };
1745
1745
  /**
1746
1746
  * Crosshair behaviour. 'normal' (default) — the cross follows the pointer
@@ -2086,6 +2086,19 @@ declare class Chart {
2086
2086
  * the gap instead of leaving a hole where it used to sit.
2087
2087
  */
2088
2088
  private _restackLegends;
2089
+ /**
2090
+ * Apply `legendOffset` to whichever pane currently renders at the chart's
2091
+ * top-left, rather than a fixed index.
2092
+ *
2093
+ * The offset describes a region of the *chart* the host has covered with its
2094
+ * own overlay — a symbol line, an OHLC readout. Normally that is pane 0, but
2095
+ * maximizing a lower pane parks the others at a placeholder weight, so the
2096
+ * maximized pane ends up rendering in that same corner. Pinning the offset to
2097
+ * pane 0 left it drawing its legend straight through the host's readout.
2098
+ *
2099
+ * Host-added legend rows are left alone: the host positions its own.
2100
+ */
2101
+ private _syncLegendOffsets;
2089
2102
  /** A host for the (lazy-loaded) trade layer to attach/detach its primitives on a pane. */
2090
2103
  tradeHost(paneIndex?: number): {
2091
2104
  addPrimitive(p: IPrimitive): void;