hyperprop-charting-library 0.1.134 → 0.1.135

package/docs/API.md

@@ -482,11 +482,27 @@ chart.setActiveDrawingTool("fib-retracement"); // first click starts, second cli
 chart.setActiveDrawingTool("fib-extension");   // three clicks: trend start, trend end, projection origin
 chart.setActiveDrawingTool("long-position");   // single click drops a long risk/reward box
 chart.setActiveDrawingTool("short-position");  // single click drops a short risk/reward box
+chart.setActiveDrawingTool("measure");         // next drag (or click-move-click) measures; see below
 chart.setActiveDrawingTool(null);              // back to normal cursor/pan
 ```
 
 Use `getDrawings()` / `setDrawings()` for persistence.
 
+### Measure tool (TradingView-style ruler)
+
+`"measure"` is transient — the only tool that never creates a drawing. Drag
+(or click, move, click) across the plot to get a translucent box with
+direction arrows and a stats pill: signed price change, % move, tick count
+(when `tickSize` is configured), bar count, and wall-clock duration. Blue for
+an up measurement, red for down.
+
+- The overlay stays pinned to its bars/prices through pans and zooms.
+- It clears on the next click, on Escape, on `cancelDrawing()`, or when the
+  active tool changes; it is never emitted through `onDrawingsChange`.
+- After each measurement the chart reverts to the cursor (one-shot, like
+  TradingView) and reports it via `onActiveDrawingToolChange`.
+- Shortcut: **Shift+drag** on the plot measures without arming the tool.
+
 ---
 
 ## `ChartInstance` Methods
@@ -522,8 +538,9 @@ Use `getDrawings()` / `setDrawings()` for persistence.
 - `cancelDrawing(): boolean` — abort an in-progress multi-click drawing (between the first click and the final point, e.g. a half-drawn trendline/ray/fib). Returns `true` if a draft was cancelled. Wire it to Escape.
 - Hold **Shift** while drawing or dragging an endpoint of a `trendline`/`ray` to constrain it to the nearest 0/45/90° angle (e.g. a perfectly horizontal line).
 - `setMagnetMode(mode): void` / `getMagnetMode()` — magnet/snap for all drawing tools. `"none"` off, `"weak"` snaps to a candle's OHLC only when the cursor is near a value, `"strong"` always snaps to the nearest OHLC of the bar under the cursor. Holding Cmd/Ctrl while drawing/dragging forces strong snapping regardless of the mode.
-- `setActiveDrawingTool(tool: DrawingToolType | null): void` (`DrawingToolType` = `"horizontal-line" | "vertical-line" | "trendline" | "ray" | "fib-retracement"`)
+- `setActiveDrawingTool(tool: DrawingToolType | null): void` (`DrawingToolType` = `"horizontal-line" | "vertical-line" | "trendline" | "ray" | "fib-retracement" | "fib-extension" | "long-position" | "short-position" | "price-range" | "rectangle" | "text" | "note" | "measure"`)
 - `getActiveDrawingTool(): DrawingToolType | null`
+- `onActiveDrawingToolChange(handler: ((tool: DrawingToolType | null) => void) | null): void` — fires whenever the active tool changes, including the chart auto-reverting to the cursor after a tool completes (all tools do this when their shape is placed; `measure` does it after every measurement). Keeps host toolbars in sync without polling.
 - `setDrawings(drawings: DrawingObjectOptions[]): void`
 - `getDrawings(): DrawingObjectOptions[]`
 - `addDrawing(drawing: DrawingObjectOptions): string`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperprop-charting-library",
-  "version": "0.1.134",
+  "version": "0.1.135",
   "description": "Lightweight TypeScript charting core",
   "type": "module",
   "main": "./dist/hyperprop-charting-library.cjs",