@rm-graph/core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,556 @@
+import { C as ChartConfig, a as ChartInstance, T as ThemeConfig, S as SeriesData, b as ChartEventMap, L as LineChartConfig, D as DataPoint, B as BarChartConfig, A as AreaChartConfig, H as HeatmapChartConfig, c as Surface3DChartConfig } from './index-DWzDIVQ9.js';
+export { e as AnimationConfig, j as AxisConfig, l as ChartClickEvent, m as ChartHoverEvent, k as ChartType, G as GridLineConfig, n as LegendClickEvent, h as LegendConfig, o as PanEvent, P as PieChartConfig, R as RenderedEvent, d as ScatterChartConfig, t as ThemeManager, i as TitleConfig, f as TooltipConfig, g as TooltipData, X as XAxisConfig, Y as YAxisConfig, Z as ZoomEvent, q as darkTheme, u as getThemeManager, p as lightTheme, s as midnightTheme, r as modernTheme } from './index-DWzDIVQ9.js';
+import { SciChartSurface, SciChart3DSurface } from 'scichart';
+export { SciChartSurface } from 'scichart';
+
+type SciChartSurfaceType = Awaited<ReturnType<typeof SciChartSurface.create>>["sciChartSurface"];
+/**
+ * Abstract base class for all chart types
+ * Handles common functionality like initialization, theming, events, and cleanup
+ */
+declare abstract class BaseChart<TConfig extends ChartConfig> implements ChartInstance {
+    readonly id: string;
+    protected container: HTMLElement | null;
+    protected surface: SciChartSurfaceType | null;
+    protected config: TConfig;
+    protected theme: ThemeConfig;
+    protected isInitialized: boolean;
+    protected isDestroyed: boolean;
+    private eventHandlers;
+    private resizeObserver;
+    private debouncedResize;
+    constructor(config: TConfig);
+    /**
+     * Initialize the chart in the given container
+     */
+    init(container: HTMLElement | string): Promise<void>;
+    /**
+     * Setup container element
+     */
+    private setupContainer;
+    /**
+     * Configure SciChart library defaults
+     */
+    private configureSciChartDefaults;
+    /**
+     * Create the SciChart surface - implemented by subclasses
+     */
+    protected abstract createSurface(): Promise<void>;
+    /**
+     * Update the chart with new data
+     */
+    abstract setData(data: SeriesData[]): void;
+    /**
+     * Update chart options
+     */
+    setOptions(options: Partial<TConfig>): void;
+    /**
+     * Apply current theme to the chart
+     */
+    protected applyTheme(): void;
+    /**
+     * Update the chart (re-render with current config)
+     */
+    protected abstract update(): void;
+    /**
+     * Set up resize observer for responsive charts
+     */
+    private setupResizeObserver;
+    /**
+     * Handle container resize
+     */
+    private handleResize;
+    /**
+     * Manually resize the chart
+     */
+    resize(width?: number, height?: number): void;
+    /**
+     * Export chart as image
+     */
+    exportImage(format?: "png" | "jpeg" | "svg"): Promise<string>;
+    /**
+     * Add event listener
+     */
+    on<K extends keyof ChartEventMap>(event: K, handler: (e: ChartEventMap[K]) => void): void;
+    /**
+     * Remove event listener
+     */
+    off<K extends keyof ChartEventMap>(event: K, handler: (e: ChartEventMap[K]) => void): void;
+    /**
+     * Emit an event
+     */
+    protected emit<K extends keyof ChartEventMap>(event: K, data: ChartEventMap[K]): void;
+    /**
+     * Destroy the chart and clean up resources
+     */
+    destroy(): void;
+    /**
+     * Get current configuration
+     */
+    getConfig(): TConfig;
+    /**
+     * Get current theme
+     */
+    getTheme(): ThemeConfig;
+    /**
+     * Check if chart is initialized
+     */
+    isReady(): boolean;
+}
+
+/**
+ * Line Chart implementation using SciChart
+ */
+declare class LineChart extends BaseChart<LineChartConfig> {
+    private dataSeries;
+    private renderableSeries;
+    private wasmContext;
+    constructor(config: LineChartConfig);
+    /**
+     * Create the SciChart surface for line chart
+     */
+    protected createSurface(): Promise<void>;
+    /**
+     * Add series to the chart
+     */
+    private addSeries;
+    /**
+     * Set new data for the chart
+     */
+    setData(data: SeriesData[]): void;
+    /**
+     * Update specific series data
+     */
+    updateSeriesData(seriesName: string, data: DataPoint[] | number[]): void;
+    /**
+     * Append data to a series
+     */
+    appendData(seriesName: string, data: DataPoint | DataPoint[]): void;
+    /**
+     * Clear all series
+     */
+    private clearSeries;
+    /**
+     * Update chart
+     */
+    protected update(): void;
+    /**
+     * Apply theme to line chart
+     */
+    protected applyTheme(): void;
+    /**
+     * Destroy and clean up
+     */
+    destroy(): void;
+}
+/**
+ * Factory function to create a line chart
+ */
+declare function createLineChart(container: HTMLElement | string, config: LineChartConfig): Promise<LineChart>;
+
+/**
+ * Bar/Column Chart implementation using SciChart
+ */
+declare class BarChart extends BaseChart<BarChartConfig> {
+    private dataSeries;
+    private renderableSeries;
+    private wasmContext;
+    constructor(config: BarChartConfig);
+    /**
+     * Create the SciChart surface for bar chart
+     */
+    protected createSurface(): Promise<void>;
+    /**
+     * Add series to the chart
+     */
+    private addSeries;
+    /**
+     * Set new data for the chart
+     */
+    setData(data: SeriesData[]): void;
+    /**
+     * Update specific series data
+     */
+    updateSeriesData(seriesName: string, data: DataPoint[] | number[]): void;
+    /**
+     * Clear all series
+     */
+    private clearSeries;
+    /**
+     * Update chart
+     */
+    protected update(): void;
+    /**
+     * Destroy and clean up
+     */
+    destroy(): void;
+}
+/**
+ * Factory function to create a bar chart
+ */
+declare function createBarChart(container: HTMLElement | string, config: BarChartConfig): Promise<BarChart>;
+
+/**
+ * Area Chart implementation using SciChart
+ */
+declare class AreaChart extends BaseChart<AreaChartConfig> {
+    private dataSeries;
+    private renderableSeries;
+    private wasmContext;
+    constructor(config: AreaChartConfig);
+    /**
+     * Create the SciChart surface for area chart
+     */
+    protected createSurface(): Promise<void>;
+    /**
+     * Add series to the chart
+     */
+    private addSeries;
+    /**
+     * Set new data for the chart
+     */
+    setData(data: SeriesData[]): void;
+    /**
+     * Update specific series data
+     */
+    updateSeriesData(seriesName: string, data: DataPoint[] | number[]): void;
+    /**
+     * Clear all series
+     */
+    private clearSeries;
+    /**
+     * Update chart
+     */
+    protected update(): void;
+    /**
+     * Destroy and clean up
+     */
+    destroy(): void;
+}
+/**
+ * Factory function to create an area chart
+ */
+declare function createAreaChart(container: HTMLElement | string, config: AreaChartConfig): Promise<AreaChart>;
+
+/**
+ * Heatmap Chart implementation using SciChart
+ */
+declare class HeatmapChart extends BaseChart<HeatmapChartConfig> {
+    private heatmapDataSeries;
+    private heatmapSeries;
+    private wasmContext;
+    constructor(config: HeatmapChartConfig);
+    /**
+     * Create the SciChart surface for heatmap chart
+     */
+    protected createSurface(): Promise<void>;
+    /**
+     * Add heatmap data to the chart
+     */
+    private addHeatmapData;
+    /**
+     * Set new data for the chart (for heatmap, this updates zValues)
+     */
+    setData(_data: SeriesData[]): void;
+    /**
+     * Set new z-values for the heatmap
+     */
+    setZValues(zValues: number[][]): void;
+    /**
+     * Update specific cell values
+     */
+    updateCell(x: number, y: number, value: number): void;
+    /**
+     * Clear heatmap data
+     */
+    private clearHeatmap;
+    /**
+     * Update chart
+     */
+    protected update(): void;
+    /**
+     * Destroy and clean up
+     */
+    destroy(): void;
+}
+/**
+ * Factory function to create a heatmap chart
+ */
+declare function createHeatmapChart(container: HTMLElement | string, config: HeatmapChartConfig): Promise<HeatmapChart>;
+
+/**
+ * 3D Surface Chart implementation using SciChart
+ */
+declare class Surface3DChart {
+    readonly id: string;
+    private container;
+    private surface;
+    private wasmContext;
+    private config;
+    private dataSeries;
+    private meshSeries;
+    private isDestroyed;
+    constructor(config: Surface3DChartConfig);
+    /**
+     * Initialize the chart in the given container
+     */
+    init(container: HTMLElement | string): Promise<void>;
+    /**
+     * Create the SciChart 3D surface
+     */
+    private createSurface;
+    /**
+     * Add surface data to the chart
+     */
+    private addSurfaceData;
+    /**
+     * Set new Y values for the surface
+     */
+    setYValues(yValues: number[][]): void;
+    /**
+     * Set new data (alias for setYValues for consistency)
+     */
+    setData(_data: SeriesData[]): void;
+    /**
+     * Update chart options
+     */
+    setOptions(options: Partial<Surface3DChartConfig>): void;
+    /**
+     * Clear surface data
+     */
+    private clearSurface;
+    /**
+     * Destroy and clean up
+     */
+    destroy(): void;
+    /**
+     * Get current configuration
+     */
+    getConfig(): Surface3DChartConfig;
+    /**
+     * Check if chart is ready (initialized and not destroyed)
+     */
+    isReady(): boolean;
+}
+/**
+ * Factory function to create a 3D surface chart
+ */
+declare function createSurface3DChart(container: HTMLElement | string, config: Surface3DChartConfig): Promise<Surface3DChart>;
+
+/** Data point for 3D column chart [x, y, z] */
+type Column3DDataPoint = [number, number, number];
+/** Configuration for 3D Column Chart */
+interface Column3DChartConfig extends ChartConfig {
+    /** Array of [x, y, z] data points */
+    data: Column3DDataPoint[];
+    /** X axis title */
+    xAxisTitle?: string;
+    /** Y axis title */
+    yAxisTitle?: string;
+    /** Z axis title */
+    zAxisTitle?: string;
+    /** X axis visible range */
+    xRange?: {
+        min: number;
+        max: number;
+    };
+    /** Y axis visible range */
+    yRange?: {
+        min: number;
+        max: number;
+    };
+    /** Z axis visible range */
+    zRange?: {
+        min: number;
+        max: number;
+    };
+    /** Bar fill color */
+    barFill?: string;
+    /** Bar stroke color */
+    barStroke?: string;
+    /** Bar opacity (0-1) */
+    barOpacity?: number;
+    /** Bar width in X direction */
+    barWidthX?: number;
+    /** Bar width in Z direction */
+    barWidthZ?: number;
+    /** Camera position */
+    cameraPosition?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /** Camera target */
+    cameraTarget?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /** Show sine wave reference line on back plane */
+    showSineWave?: boolean;
+    /** Sine wave amplitude center */
+    sineWaveCenter?: number;
+    /** Sine wave amplitude range */
+    sineWaveAmplitude?: number;
+}
+/**
+ * 3D Column/Bar Chart implementation using SciChart
+ */
+declare class Column3DChart {
+    readonly id: string;
+    private container;
+    private surface;
+    private wasmContext;
+    private config;
+    private dataSeries;
+    private columnSeries;
+    private isDestroyed;
+    constructor(config: Column3DChartConfig);
+    /**
+     * Initialize the chart in the given container
+     */
+    init(container: HTMLElement | string): Promise<void>;
+    /**
+     * Create the SciChart 3D surface
+     */
+    private createSurface;
+    /**
+     * Add column data to the chart
+     */
+    private addColumnData;
+    /**
+     * Add sine wave reference line on back plane
+     */
+    private addSineWave;
+    /**
+     * Add tooltip modifier
+     */
+    private addTooltip;
+    /**
+     * Set new data for the chart
+     */
+    setData(data: Column3DDataPoint[]): void;
+    /**
+     * Update camera position
+     */
+    setCameraPosition(position: {
+        x: number;
+        y: number;
+        z: number;
+    }, target?: {
+        x: number;
+        y: number;
+        z: number;
+    }): void;
+    /**
+     * Update chart options
+     */
+    setOptions(options: Partial<Column3DChartConfig>): void;
+    /**
+     * Get the SciChart surface for advanced operations
+     */
+    getSurface(): SciChart3DSurface | null;
+    /**
+     * Destroy and clean up
+     */
+    destroy(): void;
+    /**
+     * Get current configuration
+     */
+    getConfig(): Column3DChartConfig;
+    /**
+     * Check if chart is ready (initialized and not destroyed)
+     */
+    isReady(): boolean;
+}
+/**
+ * Factory function to create a 3D column chart
+ */
+declare function createColumn3DChart(container: HTMLElement | string, config: Column3DChartConfig): Promise<Column3DChart>;
+
+/**
+ * Generate a unique ID
+ */
+declare function generateId(prefix?: string): string;
+/**
+ * Parse size value (handles both string and number)
+ */
+declare function parseSize(value: string | number | undefined, fallback: number): number;
+/**
+ * Normalize data points to standard format
+ */
+declare function normalizeDataPoints(data: DataPoint[] | number[]): DataPoint[];
+/**
+ * Extract x values from data points
+ */
+declare function extractXValues(data: DataPoint[]): number[];
+/**
+ * Extract y values from data points
+ */
+declare function extractYValues(data: DataPoint[]): number[];
+/**
+ * Deep merge objects
+ */
+declare function deepMerge<T extends Record<string, unknown>>(target: T, source: Partial<T>): T;
+/**
+ * Debounce function
+ */
+declare function debounce<T extends (...args: unknown[]) => void>(fn: T, delay: number): (...args: Parameters<T>) => void;
+/**
+ * Throttle function
+ */
+declare function throttle<T extends (...args: unknown[]) => void>(fn: T, limit: number): (...args: Parameters<T>) => void;
+/**
+ * Calculate min and max from data series
+ */
+declare function calculateDataRange(series: SeriesData[]): {
+    xMin: number;
+    xMax: number;
+    yMin: number;
+    yMax: number;
+};
+/**
+ * Format number for display
+ */
+declare function formatNumber(value: number, precision?: number): string;
+/**
+ * Clamp a value between min and max
+ */
+declare function clamp(value: number, min: number, max: number): number;
+/**
+ * Linear interpolation
+ */
+declare function lerp(start: number, end: number, t: number): number;
+/**
+ * Convert hex color to rgba
+ */
+declare function hexToRgba(hex: string, alpha?: number): string;
+
+/**
+ * SciChart UI - A customizable charting library built on SciChart
+ *
+ * @packageDocumentation
+ */
+
+declare const VERSION = "0.1.0";
+
+/**
+ * Configure SciChart WebAssembly location
+ * Call this before creating any charts if you need to customize the WASM location
+ *
+ * @example
+ * ```ts
+ * import { configureSciChart } from '@scichart-ui/core';
+ *
+ * configureSciChart({
+ *   wasmUrl: '/path/to/scichart2d.wasm',
+ *   dataUrl: '/path/to/scichart2d.data'
+ * });
+ * ```
+ */
+declare function configureSciChart(options: {
+    wasmUrl?: string;
+    dataUrl?: string;
+}): void;
+
+export { AreaChart, AreaChartConfig, BarChart, BarChartConfig, BaseChart, ChartConfig, ChartEventMap, ChartInstance, Column3DChart, type Column3DChartConfig, type Column3DDataPoint, DataPoint, HeatmapChart, HeatmapChartConfig, LineChart, LineChartConfig, SeriesData, Surface3DChart, Surface3DChartConfig, ThemeConfig, VERSION, calculateDataRange, clamp, configureSciChart, createAreaChart, createBarChart, createColumn3DChart, createHeatmapChart, createLineChart, createSurface3DChart, debounce, deepMerge, extractXValues, extractYValues, formatNumber, generateId, hexToRgba, lerp, normalizeDataPoints, parseSize, throttle };