ml-time-graph 1.0.0

package/dist/layout-Sc5UkC0r.d.ts

@@ -0,0 +1,246 @@
+import { p as DrawCommand, t as DrawGroup, $ as PointStyleType } from './scale-Cbr0KpPz.js';
+
+/** Output format type for the renderer (SVG string, Canvas, or nothing). */
+type RenderType = 'svg' | 'canvas' | 'none';
+
+/*!
+ * MLTimeGraph — Copyright (c) 2026 Michael Lechner
+ * MIT with Attribution: free use incl. commercial requires visible credit to
+ * "Michael Lechner". Commercial license (no attribution) on request. See LICENSE.
+ */
+
+/** Renderer-Output */
+interface RenderOutput {
+    type: RenderType;
+    content: string;
+}
+
+/*!
+ * MLTimeGraph — Copyright (c) 2026 Michael Lechner
+ * MIT with Attribution: free use incl. commercial requires visible credit to
+ * "Michael Lechner". Commercial license (no attribution) on request. See LICENSE.
+ */
+
+/**
+ * Abstract renderer — the chart logic never knows rendering details. It emits
+ * `DrawCommand[]`, a renderer turns those into output.
+ *
+ * The shipped {@link SVGRenderer} produces a DOM-free SVG string (works in the
+ * browser and on the server). For DOM-specific behaviour, extend SVGRenderer.
+ */
+declare abstract class Renderer {
+    abstract render(commands: DrawCommand[]): RenderOutput;
+}
+
+/*!
+ * MLTimeGraph — Copyright (c) 2026 Michael Lechner
+ * MIT with Attribution: free use incl. commercial requires visible credit to
+ * "Michael Lechner". Commercial license (no attribution) on request. See LICENSE.
+ */
+/**
+ * Central defaults for the entire library.
+ * Override individual values or mutate `theme` to restyle the chart globally.
+ */
+declare const theme: {
+    /** Default stroke color for series lines */
+    readonly stroke: "#4285f4";
+    /** Default line width in pixels */
+    readonly strokeWidth: 2;
+    /** Default point marker size (radius / half-width) */
+    readonly pointSize: 4;
+    /** Max data points before point markers are suppressed */
+    readonly pointThreshold: 100;
+    /** Default max time gap (ms) before the line breaks; 0 = off */
+    readonly gapThreshold: 0;
+    /** Default series type */
+    readonly fill: "none";
+    readonly hatch: null;
+    /** Default band fill color */
+    readonly bandFill: "#4285f4";
+    /** Default band opacity (when countOpacity is disabled) */
+    readonly bandOpacity: 0.6;
+    /** Default avg line color for bands */
+    readonly bandAvgLine: "#e53e3e";
+    /** Default min color for minmaxavg series */
+    readonly minColor: "#3b82f6";
+    /** Default max color for minmaxavg series */
+    readonly maxColor: "#ef4444";
+    /** Default avg color for minmaxavg series */
+    readonly avgColor: "#64748b";
+    /** Area fill alpha suffix (hex) for zoned areas — default 20% opacity */
+    readonly areaFillAlpha: "4285f433";
+    /** Default axis baseline color */
+    readonly axisColor: "#ccc";
+    /** Default tick mark color */
+    readonly tickColor: "#ddd";
+    /** Default axis label text color */
+    readonly textColor: "#777";
+    /** Default axis text size (axis labels, tick labels) */
+    readonly textSize: 11;
+    /** Axis label (rotated title next to axis) fill color */
+    readonly axisLabelColor: "#444";
+    /** Axis label font size */
+    readonly axisLabelSize: 12;
+    /** Default grid line stroke */
+    readonly gridStroke: "#e2e8f0";
+    /** Default grid line stroke width */
+    readonly gridStrokeWidth: 1;
+    /** Default grid opacity */
+    readonly gridOpacity: 1;
+    /** Legend swatch stroke */
+    readonly legendStroke: "#ccc";
+    /** Legend text fill */
+    readonly legendText: "#333";
+    /** Legend font size */
+    readonly legendFont: 11;
+    /** Default annotation color */
+    readonly annotationColor: "#334155";
+    /** Default annotation line width */
+    readonly annotationWidth: 1.5;
+    /** Default annotation arrow head size */
+    readonly annotationHead: 9;
+    /** Default annotation point radius */
+    readonly annotationRadius: 4;
+    /** Default annotation text font size */
+    readonly annotationFontSize: 11;
+    /** Default threshold line color */
+    readonly thresholdColor: "#666";
+    /** Default threshold line style */
+    readonly thresholdLine: "dashed";
+    /** Default threshold fill opacity */
+    readonly thresholdFillOpacity: 0.12;
+    /** Default threshold label font size */
+    readonly thresholdFontSize: 10;
+    /** Default highlight fill color */
+    readonly highlightColor: "#fbbf24";
+    /** Default highlight box opacity */
+    readonly highlightOpacity: 0.2;
+    /** Default highlight label text color */
+    readonly highlightLabelColor: "#92400e";
+    /** Default marker color */
+    readonly markerColor: "#f59e0b";
+    /** Default marker point size (cross / circle radius) */
+    readonly markerSize: 5;
+    /** Gap region background fill */
+    readonly gapFill: "#fff";
+    /** Gap border stroke */
+    readonly gapStroke: "#ccc";
+    /** Gap border stroke width */
+    readonly gapStrokeWidth: 1;
+    /** Gap label text color */
+    readonly gapFontColor: "#999";
+    /** Gap label font size */
+    readonly gapFontSize: 10;
+    readonly gapFillOpacity: 0.15;
+    /** Tooltip box background */
+    readonly tooltipBg: "#fff";
+    /** Tooltip border */
+    readonly tooltipBorder: "#cbd5e1";
+    /** Tooltip text color */
+    readonly tooltipText: "#1e293b";
+    /** Tooltip value label color */
+    readonly tooltipValue: "#3b82f6";
+    /** Tooltip crosshair stroke */
+    readonly tooltipCrosshair: "#94a3b8";
+    /** Tooltip snap radius in pixels */
+    readonly tooltipSnapRadius: 20;
+    /** Stats overlay line color */
+    readonly statsLineColor: "#94a3b8";
+    /** Stats label color */
+    readonly statsLabelColor: "#64748b";
+    /** Minimap overview line stroke */
+    readonly minimapStroke: "#94a3b8";
+    /** Minimap background */
+    readonly minimapBg: "#f8f9fa";
+    /** Minimap brush (viewport) fill */
+    readonly minimapBrush: "#3b82f644";
+    /** Default colour palette for enum categories and multi-series. */
+    readonly palette: readonly ["#4285f4", "#ea4335", "#22c55e", "#fbbc05", "#9334ea", "#12b5e5", "#fb923c", "#6366f1"];
+};
+
+/*!
+ * MLTimeGraph — Copyright (c) 2026 Michael Lechner
+ * MIT with Attribution: free use incl. commercial requires visible credit to
+ * "Michael Lechner". Commercial license (no attribution) on request. See LICENSE.
+ */
+
+/** Single legend entry with series name and color swatch. */
+interface LegendItem {
+    name: string;
+    color: string;
+}
+/** Layout direction for legend items. */
+type LegendOrientation = 'vertical' | 'horizontal';
+/** Configuration for legend rendering including items, position, and orientation. */
+interface LegendConfig {
+    items: LegendItem[];
+    /** Top-left pixel position. */
+    x: number;
+    y: number;
+    /** Stack items vertically (default) or lay them in a row. */
+    orientation?: LegendOrientation;
+}
+/** Estimated pixel size of the legend box (for layout reservation). */
+declare function measureLegend(items: LegendItem[], orientation?: LegendOrientation): {
+    width: number;
+    height: number;
+};
+/** Render a legend (swatch + label per item) as a single group of commands. */
+declare function renderLegend(config: LegendConfig): DrawGroup;
+
+/** Vertical marker on the chart: point circle, full-height line, or label at a specific time. */
+interface Marker {
+    time: number;
+    value?: number;
+    label?: string;
+    color?: string;
+    pointStyle?: PointStyleType;
+    lineStyle?: 'full' | 'to-value' | 'to-top';
+    seriesIndex?: number;
+}
+
+/*!
+ * MLTimeGraph — Copyright (c) 2026 Michael Lechner
+ * MIT with Attribution: free use incl. commercial requires visible credit to
+ * "Michael Lechner". Commercial license (no attribution) on request. See LICENSE.
+ */
+/** Layout configuration: dimensions, margins, and padding for the chart. */
+interface LayoutConfig {
+    /** Total dimensions */
+    width: number;
+    height: number;
+    /** Margins (in pixels) */
+    margin: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+}
+/** Computed layout result with chart area dimensions and offsets. */
+interface LayoutResult {
+    /** Total width */
+    totalWidth: number;
+    /** Total height */
+    totalHeight: number;
+    /** Chart content area width (excluding margins) */
+    chartWidth: number;
+    /** Chart content area height (excluding margins) */
+    chartHeight: number;
+    /** Pixel X offset of chart area */
+    chartX: number;
+    /** Pixel Y offset of chart area */
+    chartY: number;
+    /** Margins used */
+    margin: LayoutConfig['margin'];
+}
+declare class Layout {
+    readonly _config: LayoutConfig;
+    constructor(config: LayoutConfig);
+    /** Calculate layout dimensions */
+    compute(): LayoutResult;
+    /** Default layout for standard charts */
+    static default(width?: number, height?: number): Layout;
+}
+
+export { Layout as L, type Marker as M, type RenderOutput as R, type LayoutConfig as a, type LayoutResult as b, type LegendConfig as c, type LegendItem as d, type LegendOrientation as e, Renderer as f, measureLegend as m, renderLegend as r, theme as t };