@pixerate/editor-react 0.35.1 → 0.37.0

package/dist/chart/index.d.ts

@@ -1,5 +1,7 @@
-import { ChartController, ChartState, ChartSelection, ChartSpecPatch, ChartActionResult, ChartType, ChartCommandOptions, ChartControllerOptions, ChartTheme, ChartTextMeasure } from '@pixerate/editor/chart';
+import * as React from 'react';
 import React__default from 'react';
+import { ToolRegistry } from '@pixerate/editor/tools';
+import { ChartController, ChartState, ChartSelection, ChartSpecPatch, ChartActionResult, ChartType, ChartCommandOptions, ChartControllerOptions, ChartScene, ChartPresence, ChartDirector, ChartToolProviderOptions, ChartTheme, ChartTextMeasure, ChartMark, ChartSparklineOptions, ChartValue, ChartStreamFormat } from '@pixerate/editor/chart';
 
 /** A `ChartController` created once for the component's lifetime. */
 declare function useChartController(options?: ChartControllerOptions): ChartController;
@@ -31,6 +33,27 @@ interface ChartCommandTarget {
  * `chart.setValues`, …) in `registry` while mounted.
  */
 declare function useChartCommands(registry: ChartCommandTarget | null | undefined, controller: ChartController, options?: ChartCommandOptions): void;
+/**
+ * Registers the chart's agent tools (`createChartToolProvider`) with a `ToolRegistry` while
+ * mounted. Options are read when the controller or registry changes.
+ */
+declare function useChartToolProvider(registry: ToolRegistry | null | undefined, controller: ChartController, options?: ChartToolProviderOptions): void;
+/**
+ * A `ChartPresence` and `ChartDirector` for a chart: pass `presence` and `sceneRef` to
+ * `ChartCanvas`, and `director` to `useChartToolProvider` so agent edits are acted out with a
+ * cursor.
+ */
+declare function useChartDirector(controller: ChartController, options?: {
+    speed?: number;
+    size?: {
+        width: number;
+        height: number;
+    };
+}): {
+    sceneRef: React.RefObject<ChartScene | null>;
+    presence: ChartPresence;
+    director: ChartDirector;
+};
 
 declare const chartInputClass = "h-7 w-full min-w-0 rounded-md border border-input bg-background px-2 text-xs text-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-primary disabled:cursor-not-allowed disabled:opacity-50";
 declare const chartButtonClass = "inline-flex h-7 items-center justify-center gap-1 rounded-md border border-input bg-background px-2 text-xs text-foreground hover:bg-muted focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-primary disabled:pointer-events-none disabled:opacity-50";
@@ -56,13 +79,32 @@ interface ChartCanvasProps {
     measureText?: ChartTextMeasure;
     emptyMessage?: string;
     className?: string;
+    /** Agent cursors to draw over the chart (see `ChartDirector`). */
+    presence?: ChartPresence;
+    /** Receives the scene as drawn (e.g. for `ChartDirector`'s `scene`). */
+    sceneRef?: {
+        current: ChartScene | null;
+    };
 }
+/** SVG attributes for one mark (colours go in `style` so CSS variables work). */
+declare function renderChartMark(mark: ChartMark, fontFamily: string, interactive: boolean): React__default.ReactNode;
+/** Agent cursors and notes, drawn in scene coordinates inside the chart's SVG. */
+declare function ChartPresenceLayer({ presence }: {
+    presence: ChartPresence;
+}): React__default.JSX.Element;
+/** A laid-out scene as an SVG (no interaction): for read-only views, streaming and exports. */
+declare function ChartSceneSvg({ scene, label, className }: {
+    scene: ChartScene;
+    label?: string;
+    className?: string;
+}): React__default.JSX.Element;
 /**
  * Draws a chart controller's spec as SVG. Click a mark to select it, drag a bar or point to
- * change its value (one undo step), and with the chart focused use ← → ↑ ↓, Delete and
- * Escape (see `handleChartKey`).
+ * change its value (one undo step; Alt for fine steps, Shift to keep one axis on scatter
+ * charts, Ctrl / ⌘ to skip snapping, Escape to cancel), and with the chart focused use
+ * ← → ↑ ↓, Delete and Escape (see `handleChartKey`).
  */
-declare function ChartCanvas({ controller, width, height, responsive, theme, editable, measureText, emptyMessage, className }: ChartCanvasProps): React__default.JSX.Element;
+declare function ChartCanvas({ controller, width, height, responsive, theme, editable, measureText, emptyMessage, className, presence, sceneRef }: ChartCanvasProps): React__default.JSX.Element;
 
 type CommitInputProps = {
     value: string;
@@ -92,7 +134,7 @@ interface ChartInspectorProps {
     sections?: readonly ChartInspectorSection[];
     className?: string;
 }
-type ChartInspectorSection = 'type' | 'titles' | 'options' | 'legend' | 'axes' | 'series';
+type ChartInspectorSection = 'type' | 'style' | 'titles' | 'options' | 'legend' | 'axes' | 'series';
 /**
  * Settings for a chart controller: type, titles, stacking and line options, legend, both
  * axes and the selected series. Every change is one undo step.
@@ -115,4 +157,43 @@ interface ChartEditorProps {
 /** Toolbar, chart, settings sidebar and data grid for a `ChartController`. */
 declare function ChartEditor({ controller, showInspector, showDataGrid, showToolbar, height, canvasProps, className }: ChartEditorProps): React__default.JSX.Element;
 
-export { ChartCanvas, type ChartCanvasProps, type ChartCommandTarget, ChartCommitInput, ChartDataGrid, type ChartDataGridProps, ChartEditor, type ChartEditorProps, ChartInspector, type ChartInspectorProps, type ChartInspectorSection, type UseChartEditorResult, chartButtonClass, chartCellClass, chartIconButtonClass, chartInputClass, chartLabelClass, chartSectionClass, chartSegmentClass, useChartCommands, useChartController, useChartEditor, useChartState };
+interface ChartStreamingViewProps {
+    /** Mermaid (xychart-beta, pie, radar-beta) or a JSON chart spec, as far as it has arrived. */
+    source: string;
+    /** Nothing more will arrive: the final chart is drawn at once and problems are reported. */
+    complete?: boolean;
+    format?: ChartStreamFormat;
+    width?: number;
+    height?: number;
+    theme?: Partial<ChartTheme>;
+    /** How often a new layout is adopted while streaming (ms, default 300). */
+    adoptInterval?: number;
+    /** Tween length between layouts (ms, default 450; 0 to switch at once). */
+    tween?: number;
+    /** Shown before anything can be drawn. */
+    placeholder?: React__default.ReactNode;
+    /** Called with the parse problems once `complete`. */
+    onIssues?: (issues: {
+        message: string;
+        line?: number;
+    }[]) => void;
+    className?: string;
+}
+/**
+ * Draws a chart whose source is still arriving (e.g. from a model): series appear as their
+ * values come in, the value axis only grows so it does not jump, and each new layout tweens
+ * from the last. Read-only; load the final spec into a `ChartController` to edit it.
+ */
+declare function ChartStreamingView({ source, complete, format, width, height, theme, adoptInterval, tween, placeholder, onIssues, className }: ChartStreamingViewProps): React__default.JSX.Element;
+interface ChartSparklineProps extends Omit<ChartSparklineOptions, 'width' | 'height'> {
+    values: readonly ChartValue[];
+    width?: number;
+    height?: number;
+    /** Accessible label (default: first and last value). */
+    label?: string;
+    className?: string;
+}
+/** A word-sized chart: line, column or win/loss. */
+declare function ChartSparkline({ values, width, height, label, className, ...options }: ChartSparklineProps): React__default.JSX.Element;
+
+export { ChartCanvas, type ChartCanvasProps, type ChartCommandTarget, ChartCommitInput, ChartDataGrid, type ChartDataGridProps, ChartEditor, type ChartEditorProps, ChartInspector, type ChartInspectorProps, type ChartInspectorSection, ChartPresenceLayer, ChartSceneSvg, ChartSparkline, type ChartSparklineProps, ChartStreamingView, type ChartStreamingViewProps, type UseChartEditorResult, chartButtonClass, chartCellClass, chartIconButtonClass, chartInputClass, chartLabelClass, chartSectionClass, chartSegmentClass, renderChartMark, useChartCommands, useChartController, useChartDirector, useChartEditor, useChartState, useChartToolProvider };