scichart-engine 1.10.2 → 1.10.4

package/dist/core/ChartLegend.d.ts

@@ -8,10 +8,39 @@ export interface ChartLegendCallbacks {
     onInteractionEnd?: () => void;
     onHoverStart?: () => void;
     onHoverEnd?: () => void;
-    onSeriesHoverStart?: (series: Series) => void;
-    onSeriesHoverEnd?: (series: Series) => void;
+    /**
+     * Called when mouse enters a series item in legend
+     * @param series - The series being hovered
+     * @param highlightColor - Whether to apply color highlighting (from options)
+     */
+    onSeriesHoverStart?: (series: Series, highlightColor: boolean) => void;
+    /**
+     * Called when mouse leaves a series item in legend
+     * @param series - The series that was hovered
+     * @param highlightColor - Whether color highlighting was applied
+     */
+    onSeriesHoverEnd?: (series: Series, highlightColor: boolean) => void;
     onToggleVisibility?: (series: Series) => void;
 }
+/** Options for ChartLegend component */
+export interface ChartLegendOptions {
+    x?: number;
+    y?: number;
+    width?: number;
+    /**
+     * Highlight series color on hover (default: false)
+     * When false, series still comes to foreground but color doesn't change
+     */
+    highlightOnHover?: boolean;
+    /**
+     * Bring series to foreground (z-index) on hover (default: true)
+     */
+    bringToFrontOnHover?: boolean;
+    /** Allow dragging the legend (default: true) */
+    draggable?: boolean;
+    /** Allow resizing the legend (default: true) */
+    resizable?: boolean;
+}
 export declare class ChartLegend {
     private container;
     private visualContainer;
@@ -21,15 +50,12 @@ export declare class ChartLegend {
     private series;
     private callbacks;
     private swatchCanvases;
+    private options;
     private isDragging;
     private isResizing;
     private dragOffsetX;
     private dragOffsetY;
-    constructor(parent: HTMLElement, theme: ChartTheme, options: {
-        x?: number;
-        y?: number;
-        width?: number;
-    }, callbacks: ChartLegendCallbacks);
+    constructor(parent: HTMLElement, theme: ChartTheme, options: ChartLegendOptions, callbacks: ChartLegendCallbacks);
     private updateStyle;
     private initDragging;
     update(series: Series[]): void;

package/dist/core/OverlayRenderer.d.ts

@@ -2,11 +2,21 @@ import { Scale } from '../scales';
 import { ChartTheme } from '../theme';
 import { Series } from './Series';
 import { PlotArea, CursorState, AxisOptions } from '../types';
+import { ChartTitleOptions } from './layout/types';
 
 export declare class OverlayRenderer {
     private ctx;
     private theme;
+    private latexAPI;
     constructor(ctx: CanvasRenderingContext2D, theme: ChartTheme);
+    /**
+     * Set LaTeX API for rendering mathematical expressions
+     */
+    setLatexAPI(api: any): void;
+    /**
+     * Helper to draw text or LaTeX
+     */
+    private drawLatexOrText;
     /**
      * Update the theme
      */
@@ -14,7 +24,7 @@ export declare class OverlayRenderer {
     /**
      * Clear the overlay
      */
-    clear(width: number, height: number): void;
+    clear(): void;
     /**
      * Draw the grid
      */
@@ -35,6 +45,10 @@ export declare class OverlayRenderer {
      * Draw plot area border
      */
     drawPlotBorder(plotArea: PlotArea): void;
+    /**
+     * Draw chart title
+     */
+    drawChartTitle(plotArea: PlotArea, options: ChartTitleOptions): void;
     /**
      * Draw legend
      */
@@ -46,11 +60,15 @@ export declare class OverlayRenderer {
     /**
      * Draw cursor/crosshair
      */
-    drawCursor(plotArea: PlotArea, cursor: CursorState): void;
+    drawCursor(plotArea: PlotArea, cursor: CursorState, lineStyle?: 'solid' | 'dashed' | 'dotted'): void;
     /**
      * Draw tooltip
      */
     private drawTooltip;
+    /**
+     * Draw tooltip in a fixed corner position
+     */
+    private drawCornerTooltip;
     /**
      * Draw selection rectangle (Box Zoom)
      */

package/dist/core/annotations/AnnotationManager.d.ts

@@ -42,7 +42,11 @@ export declare class AnnotationManager {
     /**
      * Render all annotations
      */
-    render(ctx: CanvasRenderingContext2D, plotArea: PlotArea, bounds: Bounds): void;
+    render(ctx: CanvasRenderingContext2D, plotArea: PlotArea, bounds: Bounds, latexAPI?: any): void;
+    /**
+     * Helper to draw text or LaTeX
+     */
+    private drawLatexOrText;
     private renderAnnotation;
     private dataToPixelX;
     private dataToPixelY;

package/dist/core/annotations/types.d.ts

@@ -17,6 +17,8 @@ export interface BaseAnnotation {
     zIndex?: number;
     /** Tooltip text or configuration */
     tooltip?: string | any;
+    /** Use LaTeX rendering for labels/text (default: auto-detect) */
+    latex?: boolean;
 }
 export interface HorizontalLineAnnotation extends BaseAnnotation {
     type: 'horizontal-line';

package/dist/core/chart/ChartCore.d.ts

@@ -42,6 +42,7 @@ export declare class ChartImpl implements Chart {
     private showControls;
     private toolbarOptions?;
     private controls;
+    private layout;
     private _isDestroyed;
     private autoScroll;
     private showStatistics;
@@ -80,6 +81,7 @@ export declare class ChartImpl implements Chart {
     get sync(): any;
     get brokenAxis(): any;
     get forecasting(): any;
+    get latex(): any;
     private animationEngine;
     private animationConfig;
     get animations(): ChartAnimationConfig;
@@ -212,6 +214,7 @@ export declare class ChartImpl implements Chart {
      * Update X axis configuration
      */
     updateXAxis(options: Partial<AxisOptions>): void;
+    updateLayout(options: Partial<import('../layout').LayoutOptions>): void;
     /**
      * Get Y axis configuration by ID
      */

package/dist/core/chart/ChartPluginBridge.d.ts

@@ -22,6 +22,7 @@ export declare class ChartPluginBridge {
     get sync(): any;
     get brokenAxis(): any;
     get forecasting(): any;
+    get latex(): any;
     /**
      * Get a plugin API by name
      */

package/dist/core/chart/ChartRenderLoop.d.ts

@@ -23,8 +23,8 @@ export interface RenderLoopContext {
     overlay: OverlayRenderer;
     backgroundColor: [number, number, number, number];
     plotAreaBackground: [number, number, number, number];
-    cursorOptions: CursorOptions | null;
-    cursorPosition: {
+    getCursorOptions: () => CursorOptions | null;
+    getCursorPosition: () => {
         x: number;
         y: number;
     } | null;
@@ -38,6 +38,8 @@ export interface RenderLoopContext {
     selectionManager: SelectionManager;
     getHoveredSeriesId: () => string | null;
     pluginManager: PluginManagerImpl;
+    getLayout: () => import('../layout').LayoutOptions;
+    getLatex: () => any;
     updateSeriesBuffer: (s: Series) => void;
     getPlotArea: () => PlotArea;
     pixelToDataX: (px: number) => number;

package/dist/core/chart/ChartRenderer.d.ts

@@ -39,6 +39,8 @@ export interface RenderContext {
     pixelToDataY: (py: number) => number;
     selectionManager: SelectionManager;
     hoveredSeriesId: string | null;
+    layout: import('../layout').LayoutOptions;
+    latexAPI?: any;
 }
 /**
  * Prepare series data for WebGL rendering

package/dist/core/chart/ChartSetup.d.ts

@@ -1,6 +1,7 @@
 import { ChartOptions, AxisOptions } from '../../types';
 import { Scale } from '../../scales';
 import { ChartTheme } from '../../theme';
+import { LayoutOptions } from '../layout';
 
 export interface SetupResult {
     theme: ChartTheme;
@@ -19,6 +20,7 @@ export interface SetupResult {
     webglCanvas: HTMLCanvasElement;
     overlayCanvas: HTMLCanvasElement;
     overlayCtx: CanvasRenderingContext2D;
+    layout: LayoutOptions;
 }
 /**
  * Initialize chart configuration from options
@@ -31,7 +33,7 @@ export declare function createCanvas(type: "webgl" | "overlay"): HTMLCanvasEleme
 /**
  * Calculate the plot area based on container size and margins
  */
-export declare function getPlotArea(container: HTMLDivElement, yAxisOptionsMap: Map<string, AxisOptions>): {
+export declare function getPlotArea(container: HTMLDivElement, yAxisOptionsMap: Map<string, AxisOptions>, layout?: LayoutOptions): {
     x: number;
     y: number;
     width: number;

package/dist/core/chart/ChartUI.d.ts

@@ -11,6 +11,11 @@ export interface UIContext {
     showControls: boolean;
     toolbar?: import('../../types').ToolbarOptions;
     showLegend: boolean;
+    /** Legend behavior options */
+    legendOptions?: {
+        highlightOnHover?: boolean;
+        bringToFrontOnHover?: boolean;
+    };
     series: Map<string, Series>;
     autoScale: () => void;
     resetZoom: () => void;
@@ -25,8 +30,10 @@ export interface UIContext {
     onInteractionEnd?: () => void;
     onHoverStart?: () => void;
     onHoverEnd?: () => void;
-    onSeriesHoverStart?: (series: Series) => void;
-    onSeriesHoverEnd?: (series: Series) => void;
+    /** @param highlightColor - Whether to apply color highlighting */
+    onSeriesHoverStart?: (series: Series, highlightColor: boolean) => void;
+    /** @param highlightColor - Whether color highlighting was applied */
+    onSeriesHoverEnd?: (series: Series, highlightColor: boolean) => void;
     onToggleVisibility?: (series: Series) => void;
 }
 export declare function initControls(ctx: UIContext): ChartControls | null;

package/dist/core/chart/types.d.ts

@@ -97,6 +97,8 @@ export interface Chart {
     getAllYAxes(): AxisOptions[];
     /** Get the primary Y axis ID */
     getPrimaryYAxisId(): string;
+    /** Update unified layout configuration */
+    updateLayout(options: Partial<import('../layout').LayoutOptions>): void;
     /** Select data points programmatically */
     selectPoints(points: Array<{
         seriesId: string;

package/dist/core/layout/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Layout Module - Chart Component Positioning and Spacing
+ *
+ * Provides detailed control over:
+ * - Legend positioning and hover behavior
+ * - Crosshair/cursor value display modes
+ * - Toolbar positioning
+ * - Chart title configuration
+ * - Margins and padding
+ * - Axis layout spacing
+ */
+export * from './types';

package/dist/core/layout/types.d.ts

@@ -0,0 +1,165 @@
+/**
+ * Layout Configuration Types
+ *
+ * Provides detailed control over chart component positioning and spacing.
+ */
+/** Position presets for legend placement */
+export type LegendPositionPreset = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'top-center' | 'bottom-center';
+export interface LegendOptions {
+    /** Show the legend (default: from theme) */
+    visible?: boolean;
+    /** Position preset or custom coordinates */
+    position?: LegendPositionPreset | {
+        x: number;
+        y: number;
+    };
+    /** Width of the legend in pixels */
+    width?: number;
+    /**
+     * Highlight series color on hover in legend (default: false)
+     * When false, series still comes to foreground but color doesn't change
+     */
+    highlightOnHover?: boolean;
+    /**
+     * Bring series to foreground (z-index) on hover in legend (default: true)
+     */
+    bringToFrontOnHover?: boolean;
+    /** Draggable legend (default: true) */
+    draggable?: boolean;
+    /** Resizable legend (default: true) */
+    resizable?: boolean;
+}
+/** Mode for displaying crosshair coordinate values */
+export type CrosshairValueMode = 'disabled' | 'corner' | 'floating';
+/** Corner positions for crosshair value display */
+export type CornerPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+export interface CrosshairOptions {
+    /** Show crosshair lines (default: true) */
+    enabled?: boolean;
+    /** Show vertical line (default: true) */
+    showVertical?: boolean;
+    /** Show horizontal line (default: true) */
+    showHorizontal?: boolean;
+    /** Line color (default: from theme) */
+    color?: string;
+    /** Line style (default: 'dashed') */
+    lineStyle?: 'solid' | 'dashed' | 'dotted';
+    /** Line width in pixels (default: 1) */
+    lineWidth?: number;
+    /** Snap to nearest data point (default: false) */
+    snapToData?: boolean;
+    /**
+     * Display mode for X,Y coordinate values (default: 'disabled')
+     * - 'disabled': Never show coordinate values
+     * - 'corner': Show values in a fixed corner position
+     * - 'floating': Show values next to the cursor
+     */
+    valueDisplayMode?: CrosshairValueMode;
+    /**
+     * Corner position when valueDisplayMode is 'corner' (default: 'top-left')
+     */
+    cornerPosition?: CornerPosition;
+    /** Value display formatting options */
+    valueFormat?: {
+        /** X value precision (default: 4) */
+        xPrecision?: number;
+        /** Y value precision (default: 4) */
+        yPrecision?: number;
+        /** Use scientific notation for large/small values */
+        scientific?: boolean;
+    };
+}
+/** Position presets for toolbar placement */
+export type ToolbarPositionPreset = 'top-left' | 'top-right' | 'top-center' | 'bottom-left' | 'bottom-right' | 'bottom-center';
+export interface ToolbarPosition {
+    /** Horizontal position: distance from left edge in pixels or preset */
+    horizontal?: number | 'left' | 'center' | 'right';
+    /** Vertical position: distance from top edge in pixels or preset */
+    vertical?: number | 'top' | 'bottom';
+    /** Offset from calculated position */
+    offset?: {
+        x?: number;
+        y?: number;
+    };
+}
+export interface ChartTitleOptions {
+    /** Title text */
+    text?: string;
+    /** Title visibility */
+    visible?: boolean;
+    /** Font size in pixels */
+    fontSize?: number;
+    /** Font family */
+    fontFamily?: string;
+    /** Font weight */
+    fontWeight?: string | number;
+    /** Text color */
+    color?: string;
+    /** Title position */
+    position?: 'top' | 'bottom';
+    /** Alignment within position */
+    align?: 'left' | 'center' | 'right';
+    /** Padding around title */
+    padding?: number | {
+        top?: number;
+        bottom?: number;
+    };
+}
+export interface AxisLayoutOptions {
+    /** Distance between axis line and axis title in pixels */
+    titleGap?: number;
+    /** Distance between tick labels and axis line in pixels */
+    labelGap?: number;
+    /** Distance between tick marks and axis line in pixels */
+    tickGap?: number;
+    /** Padding between axis area and plot area in pixels */
+    axisPadding?: number;
+}
+export interface ChartMargins {
+    /** Top margin in pixels */
+    top?: number;
+    /** Right margin in pixels */
+    right?: number;
+    /** Bottom margin in pixels */
+    bottom?: number;
+    /** Left margin in pixels */
+    left?: number;
+}
+export interface PlotAreaPadding {
+    /** Padding inside the plot area - top */
+    top?: number;
+    /** Padding inside the plot area - right */
+    right?: number;
+    /** Padding inside the plot area - bottom */
+    bottom?: number;
+    /** Padding inside the plot area - left */
+    left?: number;
+}
+export interface LayoutOptions {
+    /** Chart title configuration */
+    title?: ChartTitleOptions;
+    /** Legend positioning and behavior */
+    legend?: LegendOptions;
+    /** Toolbar positioning */
+    toolbarPosition?: ToolbarPositionPreset | ToolbarPosition;
+    /** Crosshair/cursor configuration */
+    crosshair?: CrosshairOptions;
+    /** Chart margins (space between container and chart) */
+    margins?: ChartMargins;
+    /** Plot area padding (space inside the chart border) */
+    plotPadding?: PlotAreaPadding;
+    /** X-axis layout options */
+    xAxisLayout?: AxisLayoutOptions;
+    /** Y-axis layout options */
+    yAxisLayout?: AxisLayoutOptions;
+    /** Auto-adjust margins based on axis content (default: true) */
+    autoMargins?: boolean;
+}
+/**
+ * Default layout values
+ */
+export declare const DEFAULT_LAYOUT: Required<LayoutOptions>;
+/**
+ * Merge user layout options with defaults
+ */
+export declare function mergeLayoutOptions(userOptions?: Partial<LayoutOptions>): Required<LayoutOptions>;