@rokkit/chart 1.7.0 → 1.8.1

package/dist/PlotState.svelte.d.ts

@@ -1,73 +1,41 @@
+/**
+ * The state a `PlotChart` publishes on the `'plot-state'` context — a COMPOSITION of job
+ * classes (`./state/`), each owning one concern and reading only the ones built before it:
+ *
+ *   config → geoms → frame → channels → orientation → interaction → scales → aesthetics → axes
+ *
+ * It derives nothing itself. Everything below the constructor is the contract geoms, axes, the
+ * legend and the tooltip read (`GEOM_CONTRACT` in SparkState.svelte.js is the geom-facing part),
+ * kept as one-line delegations so no consumer changed when the monolith was taken apart. New
+ * code can depend on a job directly — `plotState.scales`, `plotState.interactionState` — instead.
+ */
 export class PlotState {
     constructor(config?: {});
-    axisOrigin: undefined[];
-    orientation: string;
-    colorScaleType: any;
-    continuousColorScale: {
-        scale: (v: number) => string;
-        domain: [number, number];
-        type: "sequential";
-    } | {
-        scale: (v: number) => string;
-        domain: [number, number, number];
-        type: "diverging";
-    } | null;
-    xScale: any;
-    yScale: any;
-    colors: Map<unknown, {
-        fill: string;
-        stroke: string;
-    }>;
-    patterns: Map<unknown, string> | SvelteMap<any, any>;
-    symbols: Map<unknown, string> | SvelteMap<any, any>;
-    colorField: any;
-    fillField: any;
-    patternField: any;
-    symbolField: any;
-    geomTypes: SvelteSet<any>;
-    xAxisY: any;
-    yAxisX: any;
+    /** The plot's inputs — the only thing `update()` writes. */
+    config: PlotConfig;
+    /** The mounted geoms and the rows each draws. */
+    geoms: GeomRegistry;
+    /** The drawing area: size less margin. */
+    frame: PlotFrame;
+    /** Which field feeds each aesthetic. Suffixed: `channels` is the contract's raw map. */
+    channelState: ChannelState;
+    /** Which way the chart reads. Suffixed: `orientation` is the contract's string. */
+    orientationState: OrientationState;
+    /** Hover, selection, zoom. */
+    interactionState: InteractionState;
+    /** The x / y position scales. */
+    scales: ScaleState;
+    /** Palette, patterns, symbols, continuous colour. */
+    aesthetics: AestheticState;
+    /** Where the axes cross. */
+    axes: AxisState;
+    /** Re-apply inputs. Which omitted fields keep and which reset: `CONFIG_FIELDS`. */
     update(config: any): void;
-    registerGeom(config: any): string;
-    updateGeom(id: any, config: any): void;
-    unregisterGeom(id: any): void;
-    geomData(id: any): any[];
-    label(field: any): any;
-    format(field: any): any;
-    tooltip(): any;
-    geomComponent(type: any): any;
-    preset(): {
-        colors: any;
-        patterns: any;
-        symbols: any;
-    };
-    get data(): any[];
-    /** @returns {{ x?: string, y?: string, color?: string, fill?: string, pattern?: string, symbol?: string }} */
-    get channels(): {
-        x?: string;
-        y?: string;
-        color?: string;
-        fill?: string;
-        pattern?: string;
-        symbol?: string;
-    };
-    get isFlipped(): boolean;
-    get continuousCategory(): boolean;
-    place(u: any, v: any): {
-        x: any;
-        y: any;
-    };
-    get bandScale(): any;
-    get valueScale(): any;
-    get margin(): {
-        top: number;
-        right: number;
-        bottom: number;
-        left: number;
-    };
-    get innerWidth(): number;
-    get innerHeight(): number;
-    get mode(): string;
+    /** The rows — the same objects every identity geom is handed, so `indexOf(row)` works. */
+    get data(): import("./state/PlotConfig.svelte.js").Row[];
+    /** The caller's channel map, unmerged. `channelState.effective` is the merged one. */
+    get channels(): import("./state/PlotConfig.svelte.js").Channels;
+    get mode(): "light" | "dark";
     get chartPreset(): {
         colors: string[];
         shades: {
@@ -95,15 +63,85 @@ export class PlotState {
             ribbon: number;
             waterfall: number;
             rule: number;
+            hull: number;
+            contour: number;
             radar: number;
         };
         patterns: string[];
         symbols: string[];
     };
+    /** A continuous category axis (a bar race's tweened rank) rather than a band. */
+    get continuousCategory(): boolean;
+    set axisOrigin(value: [number | undefined, number | undefined]);
+    /** Pin the axis crossing directly — also reachable through `update({ axisOrigin })`. */
+    get axisOrigin(): [number | undefined, number | undefined];
+    label(field: any): string;
+    format(field: any): any;
+    tooltip(): any;
+    geomComponent(type: any): any;
+    preset(): {
+        colors: any;
+        patterns: any;
+        symbols: any;
+    };
+    registerGeom(config: any): string;
+    updateGeom(id: any, config: any): void;
+    unregisterGeom(id: any): void;
+    geomData(id: any): Object[];
+    /** The legend picks a swatch style from these. */
+    get geomTypes(): import("svelte/reactivity").SvelteSet<any>;
+    get margin(): Readonly<{
+        top: 20;
+        right: 20;
+        bottom: 40;
+        left: 50;
+    }> | import("./state/PlotConfig.svelte.js").Margin;
+    get innerWidth(): number;
+    get innerHeight(): number;
+    /** Null for a literal CSS colour — it maps to no field. */
+    get colorField(): any;
+    get fillField(): any;
+    get patternField(): any;
+    get symbolField(): any;
+    get orientation(): string;
+    /** Rendered horizontally: the band axis stands up the screen. Channels are unchanged. */
+    get isFlipped(): boolean;
+    /** Channel space to screen: `const { x, y } = plotState.place(xScale(d[x]), yScale(d[y]))`. */
+    place(u: any, v: any): {
+        x: any;
+        y: any;
+    };
+    get xScale(): any;
+    get yScale(): any;
+    /** The categorical scale, whichever screen axis it is on. */
+    get bandScale(): any;
+    /** The value scale, whichever screen axis it is on. */
+    get valueScale(): any;
+    get colors(): Map<unknown, {
+        fill: string;
+        stroke: string;
+    }> | Map<null, {
+        fill: any;
+        stroke: any;
+    }>;
+    get patterns(): Map<unknown, string> | import("svelte/reactivity").SvelteMap<any, any>;
+    get symbols(): Map<unknown, string> | import("svelte/reactivity").SvelteMap<any, any>;
+    get colorScaleType(): any;
+    get continuousColorScale(): {
+        scale: (v: number) => string;
+        domain: [number, number];
+        type: "sequential";
+    } | {
+        scale: (v: number) => string;
+        domain: [number, number, number];
+        type: "diverging";
+    } | null;
+    get xAxisY(): any;
+    get yAxisX(): any;
     get hovered(): null;
     get interactive(): boolean;
     get selectedRows(): any[];
-    setHovered(data: any): void;
+    setHovered(row: any): void;
     clearHovered(): void;
     isSelected(row: any): boolean;
     setSelected(rows: any): void;
@@ -111,7 +149,13 @@ export class PlotState {
     handleSelect(detail: any): void;
     applyZoom(transform: any): void;
     resetZoom(): void;
-    #private;
 }
-import { SvelteMap } from 'svelte/reactivity';
-import { SvelteSet } from 'svelte/reactivity';
+import { PlotConfig } from './state/PlotConfig.svelte.js';
+import { GeomRegistry } from './state/GeomRegistry.svelte.js';
+import { PlotFrame } from './state/PlotFrame.svelte.js';
+import { ChannelState } from './state/ChannelState.svelte.js';
+import { OrientationState } from './state/OrientationState.svelte.js';
+import { InteractionState } from './state/InteractionState.svelte.js';
+import { ScaleState } from './state/ScaleState.svelte.js';
+import { AestheticState } from './state/AestheticState.svelte.js';
+import { AxisState } from './state/AxisState.svelte.js';