lightweight-charts-drawing 0.2.3 → 0.2.5

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 0.2.5 (01/10/2026)
+
+### Added
+
+- Volume profiles (fixed range, anchored): `DrawingStyle.vp`
+  (`VolumeProfileStyle`) with the study settings: rows layout (number of
+  rows / ticks per row) and row size, volume (Up/Down, Total, Delta), value
+  area volume, extend right (fixed range), histogram visibility, row values,
+  width (% of the box), placement, up / down and value area colours, VAH /
+  VAL / POC lines, developing POC and VA lines, histogram box colour.
+  Defaults: `volumeProfileDefaults(kind)`, merged settings:
+  `volumeProfileStyle(kind, style)`.
+
+### Changed
+
+- Pitchfan: each level is drawn with its own width and line style.
+- Info line: `extendLeft` / `extendRight` continue the line to the pane edges.
+- Highlighter: drawn at its width (no 12 px minimum).
+
+## 0.2.4 (01/10/2026)
+
+### Added
+
+- `Drawing.owner` / `NewDrawing.owner`: id of the study whose pane the drawing
+  lives in (absent = the main series pane). For hosts with several panes.
+- `magnetSnap(dp, coords, mode, snapToIndicators, ohlc = true)`: `ohlc = false`
+  snaps only to the indicator values (a pane without the main series).
+
+### Changed
+
+- Vertical line: factory `extendLine: true` (the line runs through every pane).
+
 ## 0.2.3 (01/10/2026)
 
 ### Changed
@@ -131,7 +163,7 @@ runtime (`src/runtime`). Breaking: the 0.1 API is removed.
 
 - The volume-based tools need bars with a volume: pass them with the
   `bars` option (series data usually has none).
-- Checks behind this release (in `docs/port-opentrader/`): the renderers
+- Checks behind this release: the renderers
   match OpenTrader's on 430 golden fixtures, the canvas renderer matches the
   SVG output on 774 fixtures (0.05 % of drawn pixels differ, text
   anti-aliasing), and all 86 tools pass a real-mouse survey (place, select,

package/dist/index.d.ts

@@ -442,8 +442,8 @@ export declare type DrawingStyle = {
     showImage?: boolean;
     plateColor?: string;
     signpostPosition?: number;
-    /** TV vertical line "Extend" (extendLine, factory on): the line runs
-     *  through every pane of the chart (OpenTrader draws in the main pane). */
+    /** Vertical line "Extend" (extendLine, factory on): the line runs
+     *  through every pane of the chart; off = its own pane only. */
     extendLine?: boolean;
     /** TV vertical line text orientation (factory vertical). */
     textOrientation?: "vertical" | "horizontal";
@@ -624,6 +624,10 @@ export declare type DrawingStyle = {
     vwapUpper?: RegressionLine[];
     vwapLower?: RegressionLine[];
     vwapPriceLabel?: boolean;
+    /** Fixed range / anchored volume profile settings (the reference VbP
+     *  study: Inputs + Style tab). Unset = the kind's factory settings
+     *  (`volumeProfileDefaults` in specs). */
+    vp?: VolumeProfileStyle;
 };
 
 /** Draws `items` on `ctx` (current transform = CSS pixels). */
@@ -806,6 +810,7 @@ export declare type NewDrawing = (OnePoint | TwoPoint | ThreePoint | FourPoint |
     };
     closed?: boolean;
     fmt?: number;
+    owner?: string;
 };
 
 export declare type OHLC = {
@@ -1358,7 +1363,50 @@ declare type UnitVisibility = {
     to: number;
 };
 
-export declare const VERSION = "0.2.3";
+export declare const VERSION = "0.2.4";
+
+/** Volume profile tools: the reference VbPFixed / VbPAnchored study
+ *  defaults (24 rows, Up/Down, 70% value area, histogram 30% of the box,
+ *  POC 2 px on, VAH / VAL 2 px off, developing plots 1 px off) with the
+ *  dark-theme colours of its themed colour list (cold gray 200 lines and
+ *  values, sky blue 400 at 50 / 75 % up, berry pink 400 at 50 / 75 % down,
+ *  sky blue 500 developing VA, sky blue 400 at 5 % box). Fixed range draws
+ *  from the left edge, anchored from the right. */
+export declare function volumeProfileDefaults(kind: DrawingKind): VolumeProfileStyle;
+
+/** Volume profile tool settings (reference VbPFixed / VbPAnchored study).
+ *  Inputs: rows layout (number of rows or ticks per row) and row size,
+ *  volume (Up/Down, Total, Delta), value area volume (%), extend right
+ *  (fixed range only). Style: the histogram (visible, values, width % of
+ *  the box, placement, up / down and value area up / down colours), the
+ *  VAH / VAL / POC lines, the developing POC and VA plots and the
+ *  histogram box colour. */
+export declare type VolumeProfileStyle = {
+    rowsLayout: "rows" | "ticks";
+    rows: number;
+    volume: "upDown" | "total" | "delta";
+    vaVolume: number;
+    extendRight: boolean;
+    visible: boolean;
+    showValues: boolean;
+    valuesColor: string;
+    percentWidth: number;
+    placement: "left" | "right";
+    upColor: string;
+    downColor: string;
+    vaUpColor: string;
+    vaDownColor: string;
+    vah: RegressionLine;
+    val: RegressionLine;
+    poc: RegressionLine;
+    developingPoc: RegressionLine;
+    developingVah: RegressionLine;
+    developingVal: RegressionLine;
+    boxColor: string;
+};
+
+/** The drawing's volume profile settings over the factory ones. */
+export declare function volumeProfileStyle(kind: DrawingKind, s: DrawingStyle): VolumeProfileStyle;
 
 declare type WithId<T> = T & {
     id: string;
@@ -1428,6 +1476,10 @@ declare type WithId<T> = T & {
     /** ObjectTree group tag — drawings sharing a tag render under one group
      *  header in the panel (set/cleared by its Manage mode). */
     group?: string;
+    /** Owner of the drawing's pane: the id of the study whose pane it was
+     *  drawn in (its price scale maps the points). Absent = the main series
+     *  pane. A drawing is drawn and clipped in its owner's pane. */
+    owner?: string;
 };
 
 export { }