@qfo/qfchart 0.8.0 → 0.8.1

package/dist/index.d.ts

@@ -95,6 +95,7 @@ interface QFChartOptions {
     };
     dataZoom?: {
         visible?: boolean;
+        pannable?: boolean;
         position?: 'top' | 'bottom';
         height?: number;
         start?: number;
@@ -147,8 +148,10 @@ interface ChartContext {
     updateDrawing(drawing: DrawingElement): void;
     lockChart(): void;
     unlockChart(): void;
+    registerDrawingRenderer(renderer: DrawingRenderer): void;
+    snapToCandle(point: Coordinate): Coordinate;
 }
-type DrawingType = 'line' | 'fibonacci';
+type DrawingType = string;
 interface DrawingElement {
     id: string;
     type: DrawingType;
@@ -159,6 +162,21 @@ interface DrawingElement {
         lineWidth?: number;
     };
 }
+interface DrawingRenderContext {
+    drawing: DrawingElement;
+    /** Pixel coords for each point, in the same order as drawing.points */
+    pixelPoints: [number, number][];
+    /** Whether this drawing is currently selected */
+    isSelected: boolean;
+    /** The ECharts custom series api object */
+    api: any;
+}
+interface DrawingRenderer {
+    /** The drawing type this renderer handles */
+    type: string;
+    /** Return an ECharts custom series renderItem group element */
+    render(ctx: DrawingRenderContext): any;
+}
 interface PluginConfig {
     id: string;
     name?: string;
@@ -253,6 +271,7 @@ declare class QFChart implements ChartContext {
     private countdownInterval;
     private selectedDrawingId;
     private drawings;
+    private drawingRenderers;
     coordinateConversion: {
         pixelToData: (point: {
             x: number;
@@ -308,6 +327,14 @@ declare class QFChart implements ChartContext {
     getOptions(): QFChartOptions;
     disableTools(): void;
     registerPlugin(plugin: Plugin): void;
+    registerDrawingRenderer(renderer: DrawingRenderer): void;
+    snapToCandle(point: {
+        x: number;
+        y: number;
+    }): {
+        x: number;
+        y: number;
+    };
     addDrawing(drawing: DrawingElement): void;
     removeDrawing(id: string): void;
     getDrawing(id: string): DrawingElement | undefined;
@@ -422,6 +449,13 @@ declare abstract class AbstractPlugin implements Plugin {
     icon?: string;
     protected context: ChartContext;
     private eventListeners;
+    private _snapIndicator;
+    private _snapMoveHandler;
+    private _snapKeyDownHandler;
+    private _snapKeyUpHandler;
+    private _snapBlurHandler;
+    private _snapActive;
+    private _lastMouseEvent;
     constructor(config: PluginConfig);
     init(context: ChartContext): void;
     /**
@@ -464,6 +498,16 @@ declare abstract class AbstractPlugin implements Plugin {
      * Access to market data.
      */
     protected get marketData(): OHLCV[];
+    /**
+     * Get the event point coordinates, snapping to nearest candle OHLC if Ctrl is held.
+     * Use this instead of [params.offsetX, params.offsetY] in click/mousemove handlers.
+     */
+    protected getPoint(params: any): [number, number];
+    private _bindSnapIndicator;
+    private _unbindSnapIndicator;
+    private _removeSnapGraphic;
+    private _showSnapAt;
+    private _hideSnap;
 }
 
 declare class MeasureTool extends AbstractPlugin {
@@ -479,7 +523,7 @@ declare class MeasureTool extends AbstractPlugin {
     private lineH;
     private arrowStart;
     private arrowEnd;
-    constructor(options: {
+    constructor(options?: {
         name?: string;
         icon?: string;
     });
@@ -508,7 +552,7 @@ declare class LineTool extends AbstractPlugin {
     private line;
     private startCircle;
     private endCircle;
-    constructor(options: {
+    constructor(options?: {
         name?: string;
         icon?: string;
     });
@@ -516,20 +560,18 @@ declare class LineTool extends AbstractPlugin {
     protected onActivate(): void;
     protected onDeactivate(): void;
     protected onDestroy(): void;
-    private onMouseDown;
-    private onChartInteraction;
     private onClick;
-    private saveDataCoordinates;
-    private updateGraphicFromData;
-    private enableClearListeners;
-    private clearHandlers;
-    private disableClearListeners;
     private onMouseMove;
     private initGraphic;
     private removeGraphic;
     private updateGraphic;
 }
 
+declare class LineDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
 declare class FibonacciTool extends AbstractPlugin {
     private startPoint;
     private endPoint;
@@ -541,6 +583,7 @@ declare class FibonacciTool extends AbstractPlugin {
         name?: string;
         icon?: string;
     });
+    protected onInit(): void;
     onActivate(): void;
     onDeactivate(): void;
     private bindEvents;
@@ -553,5 +596,269 @@ declare class FibonacciTool extends AbstractPlugin {
     private saveDrawing;
 }
 
-export { AbstractPlugin, FibonacciTool, LineTool, MeasureTool, QFChart };
-export type { ChartContext, Coordinate, DataCoordinate, DrawingElement, DrawingType, Indicator$1 as Indicator, IndicatorOptions, IndicatorPlot, IndicatorPoint, IndicatorStyle, OHLCV, Plugin, PluginConfig, QFChartOptions };
+declare class FibonacciDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class FibonacciChannelTool extends AbstractPlugin {
+    private startPoint;
+    private endPoint;
+    private widthPoint;
+    private state;
+    private graphicGroup;
+    private readonly levels;
+    private readonly colors;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    onActivate(): void;
+    onDeactivate(): void;
+    private bindEvents;
+    private unbindEvents;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class FibonacciChannelDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class FibSpeedResistanceFanTool extends AbstractPlugin {
+    private startPoint;
+    private endPoint;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private bindEvents;
+    private unbindEvents;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class FibSpeedResistanceFanDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class FibTrendExtensionTool extends AbstractPlugin {
+    private points;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private bindEvents;
+    private unbindEvents;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class FibTrendExtensionDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class XABCDPatternTool extends AbstractPlugin {
+    private points;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private bindEvents;
+    private unbindEvents;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class XABCDPatternDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class ABCDPatternTool extends AbstractPlugin {
+    private points;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class ABCDPatternDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class CypherPatternTool extends AbstractPlugin {
+    private points;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class CypherPatternDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class HeadAndShouldersTool extends AbstractPlugin {
+    private points;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class HeadAndShouldersDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class TrianglePatternTool extends AbstractPlugin {
+    private points;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class TrianglePatternDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+declare class ThreeDrivesPatternTool extends AbstractPlugin {
+    private points;
+    private state;
+    private graphicGroup;
+    constructor(options?: {
+        name?: string;
+        icon?: string;
+    });
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    private onClick;
+    private onMouseMove;
+    private initGraphic;
+    private removeGraphic;
+    private updateGraphic;
+    private saveDrawing;
+}
+
+declare class ThreeDrivesPatternDrawingRenderer implements DrawingRenderer {
+    type: string;
+    render(ctx: DrawingRenderContext): any;
+}
+
+interface ToolGroupConfig extends Omit<PluginConfig, 'id'> {
+    id?: string;
+    name: string;
+    icon?: string;
+}
+declare class ToolGroup extends AbstractPlugin {
+    private plugins;
+    private activeSubPlugin;
+    private menuElement;
+    private buttonElement;
+    private originalIcon;
+    private arrowSvg;
+    constructor(config: ToolGroupConfig);
+    add(plugin: Plugin): void;
+    protected onInit(): void;
+    protected onActivate(): void;
+    protected onDeactivate(): void;
+    protected onDestroy(): void;
+    private showMenu;
+    private hideMenu;
+    private handleOutsideClick;
+    private activateSubPlugin;
+}
+
+declare class DrawingRendererRegistry {
+    private renderers;
+    register(renderer: DrawingRenderer): void;
+    get(type: string): DrawingRenderer | undefined;
+}
+
+export { ABCDPatternDrawingRenderer, ABCDPatternTool, AbstractPlugin, CypherPatternDrawingRenderer, CypherPatternTool, DrawingRendererRegistry, FibSpeedResistanceFanDrawingRenderer, FibSpeedResistanceFanTool, FibTrendExtensionDrawingRenderer, FibTrendExtensionTool, FibonacciChannelDrawingRenderer, FibonacciChannelTool, FibonacciDrawingRenderer, FibonacciTool, HeadAndShouldersDrawingRenderer, HeadAndShouldersTool, LineDrawingRenderer, LineTool, MeasureTool, QFChart, ThreeDrivesPatternDrawingRenderer, ThreeDrivesPatternTool, ToolGroup, TrianglePatternDrawingRenderer, TrianglePatternTool, XABCDPatternDrawingRenderer, XABCDPatternTool };
+export type { ChartContext, Coordinate, DataCoordinate, DrawingElement, DrawingRenderContext, DrawingRenderer, DrawingType, Indicator$1 as Indicator, IndicatorOptions, IndicatorPlot, IndicatorPoint, IndicatorStyle, OHLCV, Plugin, PluginConfig, QFChartOptions, ToolGroupConfig };