@pipsend/charts 2.3.12 → 2.3.14

package/dist/typings.d.ts

@@ -37,6 +37,11 @@ declare abstract class DrawingToolBase implements IDrawingTool {
 	isVisible(): boolean;
 	/** Series the tool is attached to. */
 	series(): ISeriesApi<SeriesType>;
+	/**
+	 * Box the selection toolbar anchors to, in pane pixels. Null falls back to
+	 * the serialized points, which cannot place a line across the whole pane.
+	 */
+	selectionBox(): DrawingBounds | null;
 	getState(): DrawingToolState;
 	abstract remove(): void;
 	protected abstract _update(): void;
@@ -292,7 +297,9 @@ export declare class CrossLineTool extends DrawingToolBase {
 	private _grab;
 	private _moveStartTime;
 	private _moveStartPrice;
+	private _placement;
 	constructor(context: DrawingContext, options: CrossLineToolOptions);
+	isComplete(): boolean;
 	private _createPrimitive;
 	private _requestUpdate;
 	protected _update(): void;
@@ -464,11 +471,13 @@ export declare class DrawingToolsManager {
 	 * the chart is panned or zoomed.
 	 */
 	selectionBounds(): DrawingBounds | null;
+	/** Relative to the chart element; the tool's box is relative to its pane. */
+	private _boundsOf;
 	/**
 	 * Bounds come from the tool's own serialized points, so this works for every
 	 * tool without each one having to report a box.
 	 */
-	private _boundsOf;
+	private _boxFromPoints;
 	/** Panes below the first one are offset inside the chart element. */
 	private _paneOffsetOf;
 	private _emitSelection;
@@ -632,6 +641,7 @@ export declare class FibonacciExtensionTool extends DrawingToolBase {
 	private _isHovered;
 	private _isDragging;
 	private _dragTarget;
+	private _placement;
 	constructor(context: DrawingContext, options: FibonacciExtensionOptions);
 	private _createPrimitive;
 	private _createPaneView;
@@ -798,7 +808,11 @@ export declare class GanttTool extends DrawingToolBase {
 	private _grab;
 	private _moveStart;
 	private _hoveredSegmentIndex;
+	private _placement;
 	constructor(context: DrawingContext, options: GanttToolOptions);
+	private _placeAt;
+	isComplete(): boolean;
+	selectionBox(): DrawingBounds | null;
 	private _createPrimitive;
 	private _createPaneView;
 	drawToCanvas(ctx: CanvasRenderingContext2D, horizontalPixelRatio: number, verticalPixelRatio: number): void;
@@ -845,7 +859,11 @@ export declare class HorizontalLineTool extends DrawingToolBase {
 	private _isDragging;
 	private _grab;
 	private _moveStartPrice;
+	private _placement;
 	constructor(context: DrawingContext, options: HorizontalLineToolOptions);
+	private _placeAt;
+	isComplete(): boolean;
+	selectionBox(): DrawingBounds | null;
 	private _createPrimitive;
 	private _createPaneView;
 	/** Where the line starts, in CSS pixels. Zero unless it is a ray. */
@@ -1242,6 +1260,7 @@ export declare class PositionTool extends DrawingToolBase {
 	private _paneView;
 	private _isSelected;
 	private _isHovered;
+	private _placement;
 	private _isDragging;
 	private _dragTarget;
 	private _grab;
@@ -1249,6 +1268,9 @@ export declare class PositionTool extends DrawingToolBase {
 	private _profitRect;
 	private _lossRect;
 	constructor(context: DrawingContext, options: PositionToolOptions);
+	private _placeAt;
+	isComplete(): boolean;
+	private _span;
 	private _createPrimitive;
 	private _createPaneView;
 	drawToCanvas(ctx: CanvasRenderingContext2D, horizontalPixelRatio: number, verticalPixelRatio: number): void;
@@ -1482,6 +1504,7 @@ export declare class TextTool extends DrawingToolBase {
 	private _moveStart;
 	private _isEditing;
 	private _clickOutsideHandler;
+	private _placement;
 	constructor(context: DrawingContext, options: TextToolOptions);
 	private _setupClickOutsideHandler;
 	private _createPrimitive;
@@ -1510,6 +1533,9 @@ export declare class TextTool extends DrawingToolBase {
 	 */
 	private _hitTestPrimitive;
 	hitTest(x: number, y: number): boolean;
+	private _tailSize;
+	private _boxOrigin;
+	private _traceBox;
 	hitTestEndpoint(x: number, y: number): "anchor" | null;
 	startDrag(target: "anchor" | "body", grab: DragAnchor): void;
 	stopDrag(): void;
@@ -1634,7 +1660,10 @@ export declare class VerticalLineTool extends DrawingToolBase {
 	private _isDragging;
 	private _grab;
 	private _moveStartTime;
+	private _placement;
 	constructor(context: DrawingContext, options: VerticalLineToolOptions);
+	isComplete(): boolean;
+	selectionBox(): DrawingBounds | null;
 	private _createPrimitive;
 	private _createPaneView;
 	drawToCanvas(ctx: CanvasRenderingContext2D, horizontalPixelRatio: number, verticalPixelRatio: number): void;
@@ -3321,6 +3350,8 @@ export interface ControllableLine {
 export interface CrossLineToolOptions extends DrawingToolOptions {
 	time?: Time;
 	price?: number;
+	/** Waits for a click that sets the time and the price. */
+	interactive?: boolean;
 	lineColor?: string;
 	lineWidth?: number;
 	lineStyle?: "solid" | "dashed" | "dotted";
@@ -3505,8 +3536,7 @@ export interface DraggablePriceLineOptions {
 	formatTitle?: (price: number) => string;
 }
 /**
- * Where a tool sits on screen, in pixels relative to the chart element, so a
- * floating UI can be anchored to it.
+ * Where a tool sits on screen, in pixels, so a floating UI can be anchored to it.
  */
 export interface DrawingBounds {
 	left: number;
@@ -3579,6 +3609,7 @@ export interface FibonacciExtensionOptions extends DrawingToolOptions {
 	lineWidth?: number;
 	showLabels?: boolean;
 	extendLines?: boolean;
+	/** Waits for three clicks that set its points in order. */
 	interactive?: boolean;
 	onUpdate?: () => void;
 	onRemove?: () => void;
@@ -3660,6 +3691,8 @@ export interface GanttSegment {
 }
 export interface GanttToolOptions extends DrawingToolOptions {
 	segments?: GanttSegment[];
+	/** Waits for a click that sets where the segments start, and in which row. */
+	interactive?: boolean;
 	rowHeight?: number;
 	rowSpacing?: number;
 	fillOpacity?: number;
@@ -3817,6 +3850,7 @@ export interface HistogramStyleOptions {
 }
 export interface HorizontalLineToolOptions extends DrawingToolOptions {
 	price?: number;
+	/** Waits for a click that sets the level, and the start of a ray. */
 	interactive?: boolean;
 	/**
 	 * Where the line starts. Left undefined it spans the whole chart; set, the
@@ -6317,11 +6351,13 @@ export interface PositionMetrics {
 export interface PositionToolOptions extends DrawingToolOptions {
 	entryPrice: number;
 	entryTime: Time;
+	/** Right edge of the box. Without it the box spans a fifth of the pane. */
 	endTime?: Time;
 	stopLoss?: number;
 	takeProfit?: number;
 	quantity?: number;
 	pipConfig?: PipConfig;
+	/** Waits for a click to place the entry; stop and target keep their distance from it. */
 	interactive?: boolean;
 	profitColor?: string;
 	lossColor?: string;
@@ -6673,7 +6709,10 @@ export interface RectangleToolOptions extends DrawingToolOptions {
 	borderStyle?: "solid" | "dashed" | "dotted";
 	showLabel?: boolean;
 	labelText?: string;
-	labelPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "center";
+	labelPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "center" | "left" | "right";
+	labelColor?: string;
+	labelBackgroundColor?: string;
+	labelFontSize?: number;
 	onUpdate?: () => void;
 	onRemove?: () => void;
 }
@@ -7259,9 +7298,16 @@ export interface TextToolOptions extends DrawingToolOptions {
 	borderWidth?: number;
 	textAlign?: "left" | "center" | "right";
 	maxWidth?: number;
+	anchor?: TextToolAnchor;
+	pointer?: boolean;
+	borderRadius?: number;
+	/** Waits for a click that sets `time` and `price`. */
+	interactive?: boolean;
 	onUpdate?: () => void;
 	onRemove?: () => void;
 	onTextChange?: (text: string) => void;
+	/** Called once an interactive text has been placed. */
+	onComplete?: () => void;
 }
 export interface TextWatermarkLineOptions {
 	/**
@@ -7595,6 +7641,7 @@ export interface VerticalGradientColor {
 }
 export interface VerticalLineToolOptions extends DrawingToolOptions {
 	time?: Time;
+	/** Waits for a click that sets the time. */
 	interactive?: boolean;
 	lineColor?: string;
 	lineWidth?: number;
@@ -8040,9 +8087,10 @@ export type SeriesMarkerPricePosition = "atPriceTop" | "atPriceBottom" | "atPric
  *
  * `tag` draws the text inside a rounded bubble with a pointer aimed at the
  * anchor, which is what trading platforms use for BUY/SELL callouts. The other
- * shapes draw the text next to the shape instead.
+ * shapes draw the text next to the shape instead. `xcross` is a thin ×, the
+ * usual mark for a signal that was cancelled or expired.
  */
-export type SeriesMarkerShape = "circle" | "square" | "arrowUp" | "arrowDown" | "tag";
+export type SeriesMarkerShape = "circle" | "square" | "arrowUp" | "arrowDown" | "tag" | "xcross";
 /**
  * The visual stacking order for the markers within the chart.
  *
@@ -8073,6 +8121,12 @@ export type SessionPeriod = "daily" | "weekly" | "monthly";
  * A custom function used to handle changes to the time scale's size.
  */
 export type SizeChangeEventHandler = (width: number, height: number) => void;
+/**
+ * Where the `time`/`price` point sits on the label. `top-left` hangs the box below and to the
+ * right of the point; `left`, `right` and `center` centre it on the price, the way a price label
+ * at the end of a line reads. `pointer` adds a tail from the box to the point for `left`/`right`.
+ */
+export type TextToolAnchor = "top-left" | "left" | "right" | "center";
 /**
  * The `TickMarkFormatter` is used to customize tick mark labels on the time scale.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "private": false,
-  "version": "2.3.12",
+  "version": "2.3.14",
   "name": "@pipsend/charts",
   "author": "Pipsend",
   "license": "SEE LICENSE IN LICENSE",