hyperprop-charting-library 0.1.133 → 0.1.135

package/dist/index.d.cts

@@ -90,7 +90,15 @@ interface ChartOptions {
     drawings?: DrawingObjectOptions[];
 }
 type IndicatorPane = "overlay" | "separate";
-type DrawingToolType = "horizontal-line" | "vertical-line" | "trendline" | "ray" | "fib-retracement" | "fib-extension" | "long-position" | "short-position" | "price-range" | "rectangle" | "text" | "note";
+type DrawingToolType = "horizontal-line" | "vertical-line" | "trendline" | "ray" | "fib-retracement" | "fib-extension" | "long-position" | "short-position" | "price-range" | "rectangle" | "text" | "note"
+/**
+ * TradingView-style ruler. Unlike every other tool it is transient: the
+ * measurement overlay is never added to the drawings list (no
+ * `onDrawingsChange`), and it clears on the next click, on Escape, or when
+ * the tool changes. Also reachable without arming the tool via Shift+drag
+ * on the plot.
+ */
+ | "measure";
 interface DrawingPoint {
     index: number;
     price: number;
@@ -501,69 +509,6 @@ interface LabelsOptions {
     labelHeight?: number;
     labelPaddingX?: number;
 }
-interface ScriptIndicatorInputDef {
-    key: string;
-    label?: string;
-    type?: "number" | "color" | "boolean" | "select" | "string";
-    default: unknown;
-    min?: number;
-    max?: number;
-    step?: number;
-    options?: Array<{
-        value: string;
-        label: string;
-    }>;
-}
-interface ScriptIndicatorDefinition {
-    /** Unique indicator id, e.g. "script:my-rsi". */
-    id: string;
-    name: string;
-    /** Defaults to "separate". */
-    pane?: IndicatorPane;
-    paneHeightRatio?: number;
-    inputs?: ScriptIndicatorInputDef[];
-    /**
-     * JavaScript source that must define `function compute(bars, inputs, hp)`.
-     * `bars` is an array of `{ time, o, h, l, c, v }`, `inputs` the resolved
-     * input values, and `hp` a bundle of TA helpers (sma, ema, rma, highest,
-     * lowest, change, stdev, atr). It must return `{ plots: [...] }`.
-     */
-    source: string;
-}
-interface ScriptPlotSpec {
-    title?: string;
-    values: Array<number | null>;
-    color?: string;
-    width?: number;
-    style?: "line" | "histogram";
-    negativeColor?: string;
-}
-interface ScriptComputeResult {
-    plots: ScriptPlotSpec[];
-    range?: {
-        min?: number;
-        max?: number;
-    };
-    guides?: number[];
-    decimals?: number;
-}
-/**
- * Compile-check a script without registering it: returns an error message, or
- * `null` when the script compiles. Runs with the same execution guard as the
- * chart, so a top-level infinite loop returns a budget error instead of
- * hanging the caller (e.g. an editor's save validation).
- */
-declare const validateScriptSource: (source: string) => string | null;
-/**
- * Compile a user-authored script into a regular indicator plugin. The plugin
- * can then be registered with `chart.registerIndicator(...)` and behaves like
- * a built-in: separate panes get the shared grid, legends, value lines,
- * drag-resize and hover controls; overlays autoscale with price.
- *
- * Compile/runtime errors never throw during rendering; they render as an
- * inline error message in the pane instead.
- */
-declare const compileScriptIndicator: (definition: ScriptIndicatorDefinition) => IndicatorPlugin;
 interface ChartInstance {
     updateOptions: (options: ChartOptions) => void;
     /** Switch the main series rendering style (candles, bars, line, ...). */
@@ -615,6 +560,14 @@ interface ChartInstance {
     removeDrawing: (id: string) => void;
     clearDrawings: () => void;
     onDrawingsChange: (handler: ((drawings: DrawingObjectOptions[]) => void) | null) => void;
+    /**
+     * Fires whenever the active drawing tool changes — including when the chart
+     * auto-reverts to the cursor after a tool completes (every drawing tool does
+     * this once its shape is placed; the transient `measure` tool does it after
+     * every measurement). Lets host toolbars stay in sync without polling
+     * `getActiveDrawingTool()`.
+     */
+    onActiveDrawingToolChange: (handler: ((tool: DrawingToolType | null) => void) | null) => void;
     onDrawingSelect: (handler: ((event: DrawingSelectEvent) => void) | null) => void;
     onDrawingDoubleClick: (handler: ((event: DrawingSelectEvent) => void) | null) => void;
     onDrawingEditText: (handler: ((event: DrawingSelectEvent) => void) | null) => void;
@@ -658,6 +611,71 @@ interface ViewportState {
     /** Manual Y-axis max override (null = auto-scale). */
     yMax: number | null;
 }
+
+interface ScriptIndicatorInputDef {
+    key: string;
+    label?: string;
+    type?: "number" | "color" | "boolean" | "select" | "string";
+    default: unknown;
+    min?: number;
+    max?: number;
+    step?: number;
+    options?: Array<{
+        value: string;
+        label: string;
+    }>;
+}
+interface ScriptIndicatorDefinition {
+    /** Unique indicator id, e.g. "script:my-rsi". */
+    id: string;
+    name: string;
+    /** Defaults to "separate". */
+    pane?: IndicatorPane;
+    paneHeightRatio?: number;
+    inputs?: ScriptIndicatorInputDef[];
+    /**
+     * JavaScript source that must define `function compute(bars, inputs, hp)`.
+     * `bars` is an array of `{ time, o, h, l, c, v }`, `inputs` the resolved
+     * input values, and `hp` a bundle of TA helpers (sma, ema, rma, highest,
+     * lowest, change, stdev, atr). It must return `{ plots: [...] }`.
+     */
+    source: string;
+}
+interface ScriptPlotSpec {
+    title?: string;
+    values: Array<number | null>;
+    color?: string;
+    width?: number;
+    style?: "line" | "histogram";
+    negativeColor?: string;
+}
+interface ScriptComputeResult {
+    plots: ScriptPlotSpec[];
+    range?: {
+        min?: number;
+        max?: number;
+    };
+    guides?: number[];
+    decimals?: number;
+}
+/**
+ * Compile-check a script without registering it: returns an error message, or
+ * `null` when the script compiles. Runs with the same execution guard as the
+ * chart, so a top-level infinite loop returns a budget error instead of
+ * hanging the caller (e.g. an editor's save validation).
+ */
+declare const validateScriptSource: (source: string) => string | null;
+/**
+ * Compile a user-authored script into a regular indicator plugin. The plugin
+ * can then be registered with `chart.registerIndicator(...)` and behaves like
+ * a built-in: separate panes get the shared grid, legends, value lines,
+ * drag-resize and hover controls; overlays autoscale with price.
+ *
+ * Compile/runtime errors never throw during rendering; they render as an
+ * inline error message in the pane instead.
+ */
+declare const compileScriptIndicator: (definition: ScriptIndicatorDefinition) => IndicatorPlugin;
+
 declare function createChart(element: HTMLElement, options?: ChartOptions): ChartInstance;
 
 export { type AxisOptions, type BuiltInIndicatorInfo, type ChartClickEvent, type ChartInstance, type ChartOptions, type ChartType, type CrosshairMoveEvent, type CrosshairOptions, type CrosshairPriceActionEvent, type DashPatternOptions, type DrawingDefaults, type DrawingHoverEvent, type DrawingObjectOptions, type DrawingPoint, type DrawingSelectEvent, type DrawingToolType, FIB_DEFAULT_PALETTE, type GridOptions, type IndicatorInstanceOptions, type IndicatorPane, type IndicatorPaneActionEvent, type IndicatorPaneAxisOptions, type IndicatorPaneGuideLine, type IndicatorPaneHeightChangeEvent, type IndicatorPaneRenderInfo, type IndicatorPaneValue, type IndicatorPaneValueLabel, type IndicatorPlugin, type IndicatorRenderContext, type LabelsOptions, type OhlcDataPoint, type OrderActionButton, type OrderActionEvent, type OrderLineOptions, POSITION_DEFAULT_COLORS, type PriceLineOptions, type ScriptComputeResult, type ScriptIndicatorDefinition, type ScriptIndicatorInputDef, type ScriptPlotSpec, type TickerLineOptions, type TradeMarkerOptions, type ViewportState, type WatermarkOptions, compileScriptIndicator, createChart, validateScriptSource };

package/dist/index.d.ts

@@ -90,7 +90,15 @@ interface ChartOptions {
     drawings?: DrawingObjectOptions[];
 }
 type IndicatorPane = "overlay" | "separate";
-type DrawingToolType = "horizontal-line" | "vertical-line" | "trendline" | "ray" | "fib-retracement" | "fib-extension" | "long-position" | "short-position" | "price-range" | "rectangle" | "text" | "note";
+type DrawingToolType = "horizontal-line" | "vertical-line" | "trendline" | "ray" | "fib-retracement" | "fib-extension" | "long-position" | "short-position" | "price-range" | "rectangle" | "text" | "note"
+/**
+ * TradingView-style ruler. Unlike every other tool it is transient: the
+ * measurement overlay is never added to the drawings list (no
+ * `onDrawingsChange`), and it clears on the next click, on Escape, or when
+ * the tool changes. Also reachable without arming the tool via Shift+drag
+ * on the plot.
+ */
+ | "measure";
 interface DrawingPoint {
     index: number;
     price: number;
@@ -501,69 +509,6 @@ interface LabelsOptions {
     labelHeight?: number;
     labelPaddingX?: number;
 }
-interface ScriptIndicatorInputDef {
-    key: string;
-    label?: string;
-    type?: "number" | "color" | "boolean" | "select" | "string";
-    default: unknown;
-    min?: number;
-    max?: number;
-    step?: number;
-    options?: Array<{
-        value: string;
-        label: string;
-    }>;
-}
-interface ScriptIndicatorDefinition {
-    /** Unique indicator id, e.g. "script:my-rsi". */
-    id: string;
-    name: string;
-    /** Defaults to "separate". */
-    pane?: IndicatorPane;
-    paneHeightRatio?: number;
-    inputs?: ScriptIndicatorInputDef[];
-    /**
-     * JavaScript source that must define `function compute(bars, inputs, hp)`.
-     * `bars` is an array of `{ time, o, h, l, c, v }`, `inputs` the resolved
-     * input values, and `hp` a bundle of TA helpers (sma, ema, rma, highest,
-     * lowest, change, stdev, atr). It must return `{ plots: [...] }`.
-     */
-    source: string;
-}
-interface ScriptPlotSpec {
-    title?: string;
-    values: Array<number | null>;
-    color?: string;
-    width?: number;
-    style?: "line" | "histogram";
-    negativeColor?: string;
-}
-interface ScriptComputeResult {
-    plots: ScriptPlotSpec[];
-    range?: {
-        min?: number;
-        max?: number;
-    };
-    guides?: number[];
-    decimals?: number;
-}
-/**
- * Compile-check a script without registering it: returns an error message, or
- * `null` when the script compiles. Runs with the same execution guard as the
- * chart, so a top-level infinite loop returns a budget error instead of
- * hanging the caller (e.g. an editor's save validation).
- */
-declare const validateScriptSource: (source: string) => string | null;
-/**
- * Compile a user-authored script into a regular indicator plugin. The plugin
- * can then be registered with `chart.registerIndicator(...)` and behaves like
- * a built-in: separate panes get the shared grid, legends, value lines,
- * drag-resize and hover controls; overlays autoscale with price.
- *
- * Compile/runtime errors never throw during rendering; they render as an
- * inline error message in the pane instead.
- */
-declare const compileScriptIndicator: (definition: ScriptIndicatorDefinition) => IndicatorPlugin;
 interface ChartInstance {
     updateOptions: (options: ChartOptions) => void;
     /** Switch the main series rendering style (candles, bars, line, ...). */
@@ -615,6 +560,14 @@ interface ChartInstance {
     removeDrawing: (id: string) => void;
     clearDrawings: () => void;
     onDrawingsChange: (handler: ((drawings: DrawingObjectOptions[]) => void) | null) => void;
+    /**
+     * Fires whenever the active drawing tool changes — including when the chart
+     * auto-reverts to the cursor after a tool completes (every drawing tool does
+     * this once its shape is placed; the transient `measure` tool does it after
+     * every measurement). Lets host toolbars stay in sync without polling
+     * `getActiveDrawingTool()`.
+     */
+    onActiveDrawingToolChange: (handler: ((tool: DrawingToolType | null) => void) | null) => void;
     onDrawingSelect: (handler: ((event: DrawingSelectEvent) => void) | null) => void;
     onDrawingDoubleClick: (handler: ((event: DrawingSelectEvent) => void) | null) => void;
     onDrawingEditText: (handler: ((event: DrawingSelectEvent) => void) | null) => void;
@@ -658,6 +611,71 @@ interface ViewportState {
     /** Manual Y-axis max override (null = auto-scale). */
     yMax: number | null;
 }
+
+interface ScriptIndicatorInputDef {
+    key: string;
+    label?: string;
+    type?: "number" | "color" | "boolean" | "select" | "string";
+    default: unknown;
+    min?: number;
+    max?: number;
+    step?: number;
+    options?: Array<{
+        value: string;
+        label: string;
+    }>;
+}
+interface ScriptIndicatorDefinition {
+    /** Unique indicator id, e.g. "script:my-rsi". */
+    id: string;
+    name: string;
+    /** Defaults to "separate". */
+    pane?: IndicatorPane;
+    paneHeightRatio?: number;
+    inputs?: ScriptIndicatorInputDef[];
+    /**
+     * JavaScript source that must define `function compute(bars, inputs, hp)`.
+     * `bars` is an array of `{ time, o, h, l, c, v }`, `inputs` the resolved
+     * input values, and `hp` a bundle of TA helpers (sma, ema, rma, highest,
+     * lowest, change, stdev, atr). It must return `{ plots: [...] }`.
+     */
+    source: string;
+}
+interface ScriptPlotSpec {
+    title?: string;
+    values: Array<number | null>;
+    color?: string;
+    width?: number;
+    style?: "line" | "histogram";
+    negativeColor?: string;
+}
+interface ScriptComputeResult {
+    plots: ScriptPlotSpec[];
+    range?: {
+        min?: number;
+        max?: number;
+    };
+    guides?: number[];
+    decimals?: number;
+}
+/**
+ * Compile-check a script without registering it: returns an error message, or
+ * `null` when the script compiles. Runs with the same execution guard as the
+ * chart, so a top-level infinite loop returns a budget error instead of
+ * hanging the caller (e.g. an editor's save validation).
+ */
+declare const validateScriptSource: (source: string) => string | null;
+/**
+ * Compile a user-authored script into a regular indicator plugin. The plugin
+ * can then be registered with `chart.registerIndicator(...)` and behaves like
+ * a built-in: separate panes get the shared grid, legends, value lines,
+ * drag-resize and hover controls; overlays autoscale with price.
+ *
+ * Compile/runtime errors never throw during rendering; they render as an
+ * inline error message in the pane instead.
+ */
+declare const compileScriptIndicator: (definition: ScriptIndicatorDefinition) => IndicatorPlugin;
+
 declare function createChart(element: HTMLElement, options?: ChartOptions): ChartInstance;
 
 export { type AxisOptions, type BuiltInIndicatorInfo, type ChartClickEvent, type ChartInstance, type ChartOptions, type ChartType, type CrosshairMoveEvent, type CrosshairOptions, type CrosshairPriceActionEvent, type DashPatternOptions, type DrawingDefaults, type DrawingHoverEvent, type DrawingObjectOptions, type DrawingPoint, type DrawingSelectEvent, type DrawingToolType, FIB_DEFAULT_PALETTE, type GridOptions, type IndicatorInstanceOptions, type IndicatorPane, type IndicatorPaneActionEvent, type IndicatorPaneAxisOptions, type IndicatorPaneGuideLine, type IndicatorPaneHeightChangeEvent, type IndicatorPaneRenderInfo, type IndicatorPaneValue, type IndicatorPaneValueLabel, type IndicatorPlugin, type IndicatorRenderContext, type LabelsOptions, type OhlcDataPoint, type OrderActionButton, type OrderActionEvent, type OrderLineOptions, POSITION_DEFAULT_COLORS, type PriceLineOptions, type ScriptComputeResult, type ScriptIndicatorDefinition, type ScriptIndicatorInputDef, type ScriptPlotSpec, type TickerLineOptions, type TradeMarkerOptions, type ViewportState, type WatermarkOptions, compileScriptIndicator, createChart, validateScriptSource };