@pipsend/charts 2.1.0 → 2.2.1

package/dist/typings.d.ts

@@ -15,6 +15,7 @@ declare abstract class DrawingToolBase implements IDrawingTool {
 	private _generateId;
 	get id(): string;
 	get type(): string;
+	isComplete(): boolean;
 	/**
 	 * Lets a tool hand the base its own options object, once, in the constructor.
 	 *
@@ -139,6 +140,7 @@ export declare class ArrowTool extends DrawingToolBase {
 	protected _serializeShape(): SerializedDrawingTool;
 	private _requestUpdate;
 	protected _update(): void;
+	isComplete(): boolean;
 	remove(): void;
 }
 /**
@@ -258,6 +260,7 @@ export declare class CircleTool extends DrawingToolBase {
 	protected _serializeShape(): SerializedDrawingTool;
 	private _requestUpdate;
 	protected _update(): void;
+	isComplete(): boolean;
 	remove(): void;
 }
 /**
@@ -384,6 +387,9 @@ export declare class DrawingToolsManager {
 	private readonly _selectionChanged;
 	private _isDragging;
 	private _draggedToolId;
+	private _pendingToolIds;
+	private _completionCheck;
+	private readonly _drawingCompleted;
 	constructor(chart: IChartApi, series: ISeriesApi<any>, options?: DrawingToolsManagerOptions);
 	/**
 	 * Start drawing a new tool of the specified type
@@ -404,6 +410,12 @@ export declare class DrawingToolsManager {
 	 * were different, and neither survived a restore.
 	 */
 	addTool(tool: DrawingToolBase, id?: string): string;
+	hasPendingDrawing(): boolean;
+	/** Removes every tool still waiting for points; returns how many were dropped. */
+	cancelPendingDrawings(): number;
+	subscribeDrawingCompleted(handler: (toolId: string) => void): void;
+	unsubscribeDrawingCompleted(handler: (toolId: string) => void): void;
+	private _scheduleCompletionCheck;
 	/**
 	 * Remove a tool by ID
 	 */
@@ -687,6 +699,7 @@ export declare class FibonacciFanTool extends DrawingToolBase {
 	protected _serializeShape(): SerializedDrawingTool;
 	private _requestUpdate;
 	protected _update(): void;
+	isComplete(): boolean;
 	remove(): void;
 }
 export declare class FibonacciTool extends DrawingToolBase {
@@ -747,6 +760,7 @@ export declare class FibonacciTool extends DrawingToolBase {
 	 */
 	private _hitTestPrimitive;
 	hitTest(x: number, y: number): boolean;
+	isComplete(): boolean;
 	remove(): void;
 	destroy(): void;
 	private _requestUpdate;
@@ -933,6 +947,7 @@ export declare class ParallelChannelTool extends DrawingToolBase {
 	isSelected(): boolean;
 	setHovered(hovered: boolean): void;
 	isHovered(): boolean;
+	isComplete(): boolean;
 	remove(): void;
 	protected _serializeShape(): SerializedDrawingTool;
 }
@@ -990,6 +1005,7 @@ export declare class PitchforkTool extends DrawingToolBase {
 	isSelected(): boolean;
 	setHovered(hovered: boolean): void;
 	isHovered(): boolean;
+	isComplete(): boolean;
 	remove(): void;
 	protected _serializeShape(): SerializedDrawingTool;
 }
@@ -1051,6 +1067,7 @@ export declare class PolygonTool extends DrawingToolBase {
 	isHovered(): boolean;
 	/** The corners, for callers that need the shape rather than its picture. */
 	points(): readonly PolygonVertex[];
+	isComplete(): boolean;
 	remove(): void;
 	protected _serializeShape(): SerializedDrawingTool;
 }
@@ -1269,6 +1286,7 @@ export declare class RectangleTool extends DrawingToolBase {
 	protected _serializeShape(): SerializedDrawingTool;
 	private _requestUpdate;
 	protected _update(): void;
+	isComplete(): boolean;
 	remove(): void;
 }
 export declare class RulerCalculator {
@@ -1495,6 +1513,7 @@ export declare class TrendLineTool extends DrawingToolBase {
 	private _dragStartPoint1;
 	private _dragStartPoint2;
 	private _isComplete;
+	private _interactive;
 	private _previewPoint;
 	constructor(context: DrawingContext, options: TrendLineToolOptions);
 	private _initializeInteractiveMode;
@@ -1543,6 +1562,7 @@ export declare class TrendLineTool extends DrawingToolBase {
 	protected _serializeShape(): SerializedDrawingTool;
 	private _requestUpdate;
 	protected _update(): void;
+	isComplete(): boolean;
 	remove(): void;
 }
 export declare class VerticalLineTool extends DrawingToolBase {
@@ -1906,9 +1926,9 @@ export declare function applyEMA(series: ISeriesApi<SeriesType>, chart: IChartAp
  * Draw a source series as Heikin Ashi candles.
  *
  * The source series is left in place holding its real prices — it is only
- * hidden — so indicators bound to it keep computing on the true OHLC, and
- * `remove()` puts the chart back exactly as it was. That makes this usable as a
- * chart-type toggle:
+ * painted transparent — so indicators bound to it keep computing on the true
+ * OHLC, its price lines and primitives stay on screen, and `remove()` puts the
+ * chart back exactly as it was. That makes this usable as a chart-type toggle:
  *
  * ```js
  * const ha = applyHeikinAshi(candleSeries, chart);
@@ -2474,6 +2494,21 @@ export declare function defaultHorzScaleBehavior(): new () => IHorzScaleBehavior
  * Now ignores symbol and uses price-based detection
  */
 export declare function getPipConfig(symbolOrPrice: string | number, price?: number): PipConfig;
+/**
+ * Take a series off the screen without hiding it.
+ *
+ * `visible: false` takes down everything hung off the series as well: its
+ * price lines, primitives and price-axis label stop rendering. A transform
+ * that only wants the bars themselves out of the way — Heikin Ashi drawing
+ * over its source — needs the series to stay visible to the engine, so its
+ * paint is made transparent instead and the last-value label and price line
+ * are switched off. Custom series have no known colours; those fall back to
+ * `visible: false`.
+ *
+ * @param series - Series to blank out.
+ * @returns Puts back the options the series had when it was blanked.
+ */
+export declare function hideSeriesPaint(series: ISeriesApi<SeriesType>): () => void;
 /**
  * Check if a time value is a business day object.
  *
@@ -3680,8 +3715,11 @@ export interface HeikinAshiOptions {
 	/** Wick color of falling candles. */
 	wickDownColor?: string;
 	/**
-	 * Hide the source series while the Heikin Ashi candles are shown, so the two
-	 * do not overlap. The original visibility is restored by `remove()`.
+	 * Blank out the source series while the Heikin Ashi candles are shown, so
+	 * the two do not overlap. The source is painted transparent rather than
+	 * hidden: it stays visible to the engine, so its price lines, primitives
+	 * and everything else hung off it keep rendering. `remove()` puts its paint
+	 * back.
 	 *
 	 * @defaultValue `true`
 	 */

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.0",
+  "version": "2.2.1",
   "name": "@pipsend/charts",
   "author": "Pipsend",
   "license": "SEE LICENSE IN LICENSE",