@barchart/chart-lib 2.389.1 → 2.391.0

chart-lib/barchart.chart.d.ts

@@ -2010,6 +2010,14 @@ declare module "@barchart/chart-lib" {
         time: number;
     }
 
+    /** A pixel coordinate relative to the chart, accepted by @see ChartAccessor.toMainAxisPoint and returned by @see ChartAccessor.fromMainAxisPoint. */
+    export interface Point2d {
+        /** Horizontal (x) pixel offset from the chart's left edge. */
+        x: number;
+        /** Vertical (y) pixel offset from the chart's top edge. */
+        y: number;
+    }
+
     export interface Annotation {
         id: AnnotationId;
         axisIndex: number;
@@ -2151,7 +2159,9 @@ declare module "@barchart/chart-lib" {
         /** Replaces **all** annotations of the main axis — including any user-created ones — with the given models. Intended for fully programmatically-driven charts (strike/breakeven markers etc.) where users don't draw their own annotations. No-op for headless charts or before a main plot exists. */
         setMainAxisAnnotations(annotations: AnnotationModel[]): void;
         /** Converts pixel coordinates (relative to the chart) into the main axis' data coordinates; `time` is `undefined` when the x position cannot be mapped to the series. Returns `null` for headless charts or before a main plot exists. */
-        toMainAxisPoint(p: { x: number; y: number }): { price?: number; time?: Date } | null;
+        toMainAxisPoint(p: Point2d): { price?: number; time?: Date } | null;
+        /** Inverse of @see toMainAxisPoint: converts the main axis' data coordinates (time, price) into pixel coordinates relative to the chart. Returns `null` for headless charts, before a main plot exists, or when the point cannot be mapped to a pixel. */
+        fromMainAxisPoint(p: AnnotationPoint): Point2d | null;
         /** Helper method to return back the default template, the same one you've provided during the feed's @see init call. */
         getDefaultTemplate(): string;
         /** Main API entry point. Please check out online documentation for details. */