@pixerate/editor-react 0.36.0 → 0.38.0

package/dist/chart/index.d.ts

@@ -1,7 +1,7 @@
 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';
+import { ChartToolProviderOptions, ChartController, ChartState, ChartSelection, ChartSpecPatch, ChartActionResult, ChartType, ChartCommandOptions, ChartControllerOptions, ChartScene, ChartPresence, ChartDirector, ChartTheme, ChartTextMeasure, ChartMark, DownloadChartPngOptions, ChartSparklineOptions, ChartValue, ChartStreamFormat } from '@pixerate/editor/chart';
 
 /** A `ChartController` created once for the component's lifetime. */
 declare function useChartController(options?: ChartControllerOptions): ChartController;
@@ -33,11 +33,16 @@ interface ChartCommandTarget {
  * `chart.setValues`, …) in `registry` while mounted.
  */
 declare function useChartCommands(registry: ChartCommandTarget | null | undefined, controller: ChartController, options?: ChartCommandOptions): void;
+/** `useChartToolProvider` options: `rasterize` defaults to a canvas rasterizer in the browser (`false` turns PNG off). */
+type ChartToolProviderHookOptions = Omit<ChartToolProviderOptions, 'rasterize'> & {
+    rasterize?: ChartToolProviderOptions['rasterize'] | false;
+};
 /**
  * Registers the chart's agent tools (`createChartToolProvider`) with a `ToolRegistry` while
- * mounted. Options are read when the controller or registry changes.
+ * mounted. Options are read when the controller or registry changes. In the browser,
+ * `render_chart { format: "png" }` works out of the box (`createChartRasterizer`).
  */
-declare function useChartToolProvider(registry: ToolRegistry | null | undefined, controller: ChartController, options?: ChartToolProviderOptions): void;
+declare function useChartToolProvider(registry: ToolRegistry | null | undefined, controller: ChartController, options?: ChartToolProviderHookOptions): 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
@@ -147,15 +152,17 @@ interface ChartEditorProps {
     showInspector?: boolean;
     /** The data grid under the chart (default `true`). */
     showDataGrid?: boolean;
-    /** Undo / redo and the selection readout (default `true`). */
+    /** Undo / redo, Download PNG and the selection readout (default `true`). */
     showToolbar?: boolean;
+    /** Size, theme, scale and file name for the toolbar's Download PNG (default 800 × 450, light theme). */
+    pngOptions?: DownloadChartPngOptions;
     /** Chart height in pixels (default 380). */
     height?: number;
     canvasProps?: Omit<ChartCanvasProps, 'controller' | 'height'>;
     className?: string;
 }
 /** 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;
+declare function ChartEditor({ controller, showInspector, showDataGrid, showToolbar, pngOptions, height, canvasProps, className }: ChartEditorProps): React__default.JSX.Element;
 
 interface ChartStreamingViewProps {
     /** Mermaid (xychart-beta, pie, radar-beta) or a JSON chart spec, as far as it has arrived. */
@@ -196,4 +203,4 @@ interface ChartSparklineProps extends Omit<ChartSparklineOptions, 'width' | 'hei
 /** 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 };
+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 ChartToolProviderHookOptions, type UseChartEditorResult, chartButtonClass, chartCellClass, chartIconButtonClass, chartInputClass, chartLabelClass, chartSectionClass, chartSegmentClass, renderChartMark, useChartCommands, useChartController, useChartDirector, useChartEditor, useChartState, useChartToolProvider };