openalgo-charts 1.0.23 → 1.0.25

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /** Library version string. Matches package.json (published npm release). */
-declare const VERSION = "1.0.23";
+declare const VERSION = "1.0.24";
 /** Returns the current library version. */
 declare function version(): string;
 
@@ -2482,6 +2482,58 @@ interface LogoWatermarkOptions {
     tint?: string;
     /** Layer order vs the series. Default `top`. */
     zOrder?: ZOrder;
+    /**
+     * Text revealed to the right of the mark on hover — "Chart by OpenAlgo".
+     * The mark alone is what sits on the chart at rest; the wording is only
+     * needed when someone looks at it, so it unrolls rather than occupying the
+     * corner permanently. Omit for a plain, non-interactive mark.
+     */
+    label?: string;
+    /** Hit-test id, so the chart can report hover. Default `watermark`. */
+    id?: string;
+    /** Reveal duration in seconds. Default 0.18. */
+    revealSeconds?: number;
+    /** Label colour. Defaults to `tint`, then the theme's text. */
+    labelColor?: string;
+    /** Label size in media px. Default 12. */
+    fontSize?: number;
+    /**
+     * Rounded plate behind the mark and label. Without one the wording sits
+     * straight on the candles and is unreadable wherever the chart is busy.
+     * Defaults to a translucent form of the theme background; `'none'` omits it.
+     */
+    background?: string;
+    /** Plate border. Defaults to the theme's axis line. `'none'` omits it. */
+    borderColor?: string;
+    /** Plate corner radius in media px. Default 6. */
+    radius?: number;
+    /**
+     * Plate padding around the lockup, in media px. A number pads both axes;
+     * `{ x, y }` pads them separately. Default `{ x: 7, y: 4 }`, which keeps the
+     * revealed label clear of the plate edge.
+     *
+     * Use it to size the resting plate exactly: a 40px mark with `padding: 2.5`
+     * sits in a 45x45 square. The plate widens as the label unrolls; the padding
+     * is what stays constant.
+     */
+    padding?: number | {
+        x: number;
+        y: number;
+    };
+    /**
+     * Where the mark points. A canvas cannot hold an anchor, so this only marks
+     * it as clickable — the hit reports a pointer cursor, and the host opens
+     * {@link href} from its own click handler.
+     *
+     * Given a bare URL, `href()` appends UTM parameters naming the page the chart
+     * is embedded in, so the referral is attributable. Pass a URL that already
+     * has a query string to compose your own and skip that entirely.
+     */
+    href?: string;
+    /** `utm_medium` for the composed link. Default `oac-link`. */
+    utmMedium?: string;
+    /** `utm_campaign` for the composed link. Default `oac-chart`. */
+    utmCampaign?: string;
 }
 /** Top-left placement (in media px) of a `w x h` logo within a `plotW x plotH` plot. */
 declare function watermarkRect(position: WatermarkPosition, margin: number, w: number, h: number, plotW: number, plotH: number): {
@@ -2492,6 +2544,12 @@ declare function watermarkRect(position: WatermarkPosition, margin: number, w: n
 };
 declare class LogoWatermark implements IPrimitive {
     private _opts;
+    /** 0..1 reveal progress, eased toward hover state each frame. */
+    private _reveal;
+    private _lastFrameMs;
+    /** Label width in media px, measured once the font is known. */
+    private _labelW;
+    private readonly _now;
     private _host;
     private _img;
     private _ready;
@@ -2504,7 +2562,26 @@ declare class LogoWatermark implements IPrimitive {
     autoscaleInfo(): null;
     /** Live restyle. Pass a new `src`/`image` to swap the logo. */
     setOptions(patch: Partial<LogoWatermarkOptions>): void;
+    /**
+     * The mark's box, in media px. The label unrolls to its right, so the hit
+     * area is the mark alone — hovering the revealed text keeps it open because
+     * the pointer is still within the widened box below.
+     */
+    private _rect;
+    /**
+     * The link to open, with attribution appended. A caller who supplied their
+     * own query string gets it back untouched.
+     */
+    href(): string | undefined;
+    hitTest(x: number, y: number, rc: PrimitiveRenderContext): PrimitiveHit | null;
     draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void;
+    /**
+     * The single colour the mark and its label share. Either option can set it;
+     * they follow each other so the pair never renders in two shades.
+     */
+    private _ink;
+    /** Ease the reveal toward the hover state, asking for frames while moving. */
+    private _advanceReveal;
     /** Recolor the opaque logo pixels to `color` at (dw x dh) device px, cached. */
     private _tinted;
 }