@pipsend/charts 2.3.2 → 2.3.4

package/dist/typings.d.ts

@@ -874,9 +874,6 @@ export declare class HorizontalLineTool extends DrawingToolBase {
 	protected _update(): void;
 	remove(): void;
 }
-/**
- * Interactive Line Manager - Permite crear líneas haciendo clic en el gráfico
- */
 export declare class InteractiveLineManager {
 	private _chart;
 	private _series;
@@ -892,24 +889,14 @@ export declare class InteractiveLineManager {
 	 */
 	private _getPriceFromMouseEvent;
 	/**
-	 * Activa el modo de creación de líneas por clic
-	 * @param mode - Tipo de línea a crear
-	 * @param customOptions - Opciones personalizadas para líneas custom
-	 * @returns Promesa que se resuelve cuando el usuario hace clic
+	 * Arms the chart so the next click drops a line.
+	 *
+	 * @returns The line, once the user has clicked.
 	 */
 	enableClickToCreate(mode: LineCreationMode, customOptions?: Partial<DraggablePriceLineOptions>): Promise<DraggablePriceLine | null>;
-	/**
-	 * Desactiva el modo de creación por clic
-	 */
 	disableClickToCreate(): void;
 	private _createLineAtPrice;
-	/**
-	 * Obtiene el modo actual de creación
-	 */
 	getCreationMode(): LineCreationMode;
-	/**
-	 * Verifica si está en modo de creación
-	 */
 	isCreating(): boolean;
 }
 /**
@@ -1218,66 +1205,29 @@ export declare class PositionLine implements ISeriesPrimitive, ControllableLine
 	private _applyPrice;
 	private _buildRendererData;
 }
-/**
- * Gestor de marcadores de posiciones de trading
- */
 export declare class PositionMarkersManager<TimeType> {
 	private _markersPlugin;
 	private _positions;
 	private _options;
 	constructor(series: ISeriesApi<SeriesType, TimeType>, options?: PositionMarkersOptions);
-	/**
-	 * Agrega una posición al gráfico
-	 */
 	addPosition(position: TradingPosition<TimeType>): void;
-	/**
-	 * Agrega múltiples posiciones al gráfico
-	 */
 	addPositions(positions: TradingPosition<TimeType>[]): void;
-	/**
-	 * Establece las posiciones (reemplaza las existentes)
-	 */
+	/** Replaces every position currently on the chart. */
 	setPositions(positions: TradingPosition<TimeType>[]): void;
-	/**
-	 * Cierra una posición abierta agregando el punto de salida
-	 */
+	/** Closes an open position by giving it an exit point. */
 	closePosition(id: string, exit: {
 		time: TimeType;
 		price: number;
 	}, exitText?: string): void;
-	/**
-	 * Elimina una posición por ID
-	 */
 	removePosition(id: string): void;
-	/**
-	 * Limpia todas las posiciones
-	 */
 	clearPositions(): void;
-	/**
-	 * Obtiene todas las posiciones actuales
-	 */
 	getPositions(): readonly TradingPosition<TimeType>[];
-	/**
-	 * Actualiza las opciones del gestor
-	 */
 	applyOptions(options: PositionMarkersOptions): void;
-	/**
-	 * Convierte las posiciones a marcadores de serie
-	 */
 	private _positionsToMarkers;
-	/**
-	 * Actualiza los marcadores en el gráfico
-	 */
 	private _updateMarkers;
-	/**
-	 * Desconecta el plugin y limpia recursos
-	 */
 	detach(): void;
 }
-/**
- * Position Tool - Herramienta unificada para marcar posiciones long/short
- * Muestra dos rectángulos ajustables (profit/loss) con línea vertical conectora
- */
+/** Two adjustable boxes, profit and loss, joined by a vertical connector. */
 export declare class PositionTool extends DrawingToolBase {
 	private _positionOptions;
 	private _calculator;
@@ -1436,10 +1386,7 @@ export declare class RulerCalculator {
 	 */
 	getPipConfig(): PipConfig;
 }
-/**
- * Measurement Ruler Tool - Herramienta para medir distancia entre dos puntos
- * Muestra pips, porcentaje, tiempo transcurrido y número de barras
- */
+/** Measures two points: pips, percent, elapsed time and bar count. */
 export declare class RulerTool extends DrawingToolBase {
 	private _rulerOptions;
 	private _calculator;
@@ -2349,17 +2296,13 @@ export declare function createHorizontalLineTool(context: DrawingContext, option
  */
 export declare function createImageWatermark<T>(pane: IPaneApi<T>, imageUrl: string, options: DeepPartial<ImageWatermarkOptions>): IImageWatermarkPluginApi<T>;
 /**
- * Crea un manager interactivo para añadir líneas con clics
- * @param chart - Chart instance
- * @param series - Series instance
- * @returns InteractiveLineManager
+ * Lets the user place draggable lines by clicking the chart.
+ *
  * @example
  * ```typescript
  * const manager = createInteractiveLineManager(chart, candleSeries);
- *
- * // Activar modo de creación
  * const line = await manager.enableClickToCreate('stop-loss', {
- *     onDragEnd: (price) => console.log('SL:', price)
+ *     onDragEnd: (price) => console.log('SL:', price),
  * });
  * ```
  */
@@ -2400,47 +2343,18 @@ export declare function createPolygonTool(context: DrawingContext, options: Poly
  */
 export declare function createPositionLine(series: ISeriesApi<SeriesType>, chart: IChartApi, options: PositionLineOptions): PositionLine;
 /**
- * Crea un gestor de marcadores de posiciones de trading
- *
- * @param series - Serie a la que se adjuntarán los marcadores
- * @param positions - Posiciones iniciales (opcional)
- * @param options - Opciones de configuración (opcional)
- * @returns Instancia del gestor de posiciones
+ * Marks trades on a series with an arrow at the entry and, once closed, at the
+ * exit.
  *
  * @example
  * ```typescript
- * // Crear el gestor
- * const positionMarkers = createPositionMarkers(candleSeries);
- *
- * // Agregar una posición long
- * positionMarkers.addPosition({
- *   type: 'long',
- *   entry: { time: '2023-01-01', price: 100.50 },
- *   exit: { time: '2023-01-05', price: 105.20 },
- *   id: 'pos-1'
- * });
- *
- * // Agregar una posición short
- * positionMarkers.addPosition({
- *   type: 'short',
- *   entry: { time: '2023-01-10', price: 110.00 },
- *   exit: { time: '2023-01-15', price: 107.50 },
- *   id: 'pos-2'
- * });
- *
- * // Agregar múltiples posiciones
- * positionMarkers.setPositions([
- *   {
+ * const markers = createPositionMarkers(candleSeries);
+ * markers.addPosition({
  *     type: 'long',
- *     entry: { time: '2023-02-01', price: 95.00 },
- *     exit: { time: '2023-02-10', price: 98.50 }
- *   },
- *   {
- *     type: 'short',
- *     entry: { time: '2023-02-15', price: 102.00 },
- *     exit: { time: '2023-02-20', price: 99.00 }
- *   }
- * ]);
+ *     entry: { time: '2023-01-01', price: 100.50 },
+ *     exit: { time: '2023-01-05', price: 105.20 },
+ *     id: 'pos-1',
+ * });
  * ```
  */
 export declare function createPositionMarkers<TimeType>(series: ISeriesApi<SeriesType, TimeType>, positions?: TradingPosition<TimeType>[], options?: PositionMarkersOptions): PositionMarkersManager<TimeType>;
@@ -6104,9 +6018,6 @@ export interface ParallelChannelToolOptions extends DrawingToolOptions {
 	onRemove?: () => void;
 	onComplete?: () => void;
 }
-/**
- * Position Calculator - Cálculos de P&L, pips, R:R para trading
- */
 export interface PipConfig {
 	pipValue: number;
 	decimals: number;
@@ -6356,37 +6267,19 @@ export interface PositionLineUpdate extends Partial<Omit<PositionLineOptions, "e
 	takeProfit?: Partial<PositionLineLevelOptions>;
 	stopLoss?: Partial<PositionLineLevelOptions>;
 }
-/**
- * Opciones para el gestor de posiciones
- */
 export interface PositionMarkersOptions {
-	/**
-	 * Colores predeterminados para posiciones long
-	 */
 	longColors?: {
 		entry?: string;
 		exit?: string;
 	};
-	/**
-	 * Colores predeterminados para posiciones short
-	 */
 	shortColors?: {
 		entry?: string;
 		exit?: string;
 	};
-	/**
-	 * Tamaño predeterminado de las flechas
-	 */
 	defaultSize?: number;
-	/**
-	 * Offset vertical para las flechas de entrada (en puntos de precio)
-	 * Positivo = arriba, Negativo = abajo
-	 */
+	/** Vertical offset of the entry arrow, in price points. Positive is up. */
 	entryOffset?: number;
-	/**
-	 * Offset vertical para las flechas de salida (en puntos de precio)
-	 * Positivo = arriba, Negativo = abajo
-	 */
+	/** Vertical offset of the exit arrow, in price points. Positive is up. */
 	exitOffset?: number;
 }
 export interface PositionMetrics {
@@ -7556,47 +7449,26 @@ export interface TradingLineOptions {
 	 */
 	formatTitle?: (price: number) => string;
 }
-/**
- * Representa una posición de trading con punto de entrada y salida opcional
- */
+/** A trade, with an exit once it is closed. */
 export interface TradingPosition<TimeType> {
-	/**
-	 * Tipo de posición (long o short)
-	 */
 	type: PositionType;
-	/**
-	 * Punto de entrada
-	 */
 	entry: {
 		time: TimeType;
 		price: number;
 	};
-	/**
-	 * Punto de salida (opcional - para posiciones abiertas)
-	 */
+	/** Absent while the position is still open. */
 	exit?: {
 		time: TimeType;
 		price: number;
 	};
-	/**
-	 * ID opcional para identificar la posición
-	 */
 	id?: string;
-	/**
-	 * Color personalizado para las flechas (opcional)
-	 * Si no se especifica, se usarán colores predeterminados según el tipo
-	 */
+	/** Overrides the colours the position type would otherwise pick. */
 	color?: {
 		entry?: string;
 		exit?: string;
 	};
-	/**
-	 * Tamaño de las flechas (opcional, por defecto 1)
-	 */
+	/** @defaultValue 1 */
 	size?: number;
-	/**
-	 * Texto opcional para las flechas
-	 */
 	text?: {
 		entry?: string;
 		exit?: string;
@@ -8062,9 +7934,6 @@ export type PositionLineLevel = "entry" | "takeProfit" | "stopLoss";
  * The parts of a level that respond to the pointer.
  */
 export type PositionLinePart = "line" | "body" | "close";
-/**
- * Tipo de posición de trading
- */
 export type PositionType = "long" | "short";
 /**
  * Represents information used to format prices.

package/package.json

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