@graphysdk/react-renderer 1.9.0-beta.1792062305376 → 1.9.0-beta.1792135965871

package/dist/editable.d.ts

@@ -2,6 +2,8 @@ import { AxisKey } from '@graphysdk/viz-engine';
 import { Command } from '@graphysdk/viz-engine';
 import { ComponentType } from 'react';
 import { CoordSystem } from '@graphysdk/viz-engine';
+import { CoordType } from '@graphysdk/viz-engine';
+import { DataLabelPlacementResolver } from '@graphysdk/viz-engine';
 import { DispatchOptions } from '@graphysdk/viz-engine';
 import { Edge } from '@graphysdk/viz-engine';
 import { EdgeSizes } from '@graphysdk/viz-engine';
@@ -16,6 +18,8 @@ import { JSX } from 'react/jsx-runtime';
 import { LegendPosition } from '@graphysdk/viz-engine';
 import { LineType } from '@graphysdk/viz-engine';
 import { MainAxis } from '@graphysdk/viz-engine';
+import { ObservationsTarget } from '@graphysdk/viz-engine';
+import { PositionAdjustment } from '@graphysdk/viz-engine';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
 import { Rect } from '@graphysdk/viz-engine';
@@ -627,7 +631,7 @@ declare type DotNotation<T> = T extends object ? {
  * </GraphProvider>
  * ```
  */
-export declare const EditableGraphRenderer: ({ slots, mode, palettePresets, ...rest }: EditableGraphRendererProps) => JSX.Element;
+export declare const EditableGraphRenderer: ({ slots, mode, palettePresets, editMenus, ...rest }: EditableGraphRendererProps) => JSX.Element;
 
 /** Props for {@link EditableGraphRenderer}: the renderer's own, plus what only the editor reads. */
 export declare interface EditableGraphRendererProps extends GraphRendererProps {
@@ -636,6 +640,33 @@ export declare interface EditableGraphRendererProps extends GraphRendererProps {
      * color scale's `range`, so the spec keeps its colors whatever the host offers later. With none, no row.
      */
     palettePresets?: PalettePresets;
+    /**
+     * A host's edit menus, searched before Graphy's. `null` removes that menu, and a missing entry leaves Graphy's.
+     */
+    editMenus?: EditMenus;
+}
+
+/** Whether the edit menu draws a row for a target, asked before it is hovered or selected; left out, it always does. */
+declare interface EditMenuRows<Target> {
+    hasRows?: (target: Target, inputs: EditMenuRowsInputs) => boolean;
+}
+
+/** What an edit menu reads to say whether it has rows: the scene, and the placement strategies plugins extend. */
+declare interface EditMenuRowsInputs {
+    scene: Scene;
+    dataLabelPlacement: DataLabelPlacementResolver;
+}
+
+/** The edit menus Graphy or a host registers, where `null` answers with none and `undefined` reads as left out. */
+export declare interface EditMenus {
+    /** Edit menus for observations drawn one way, keyed by their layer's geom, the chart's coord and the position. */
+    layers?: Readonly<Record<string, LayerEditMenus | undefined>>;
+    /** Edit menus for observations however they are drawn, keyed by their layer's geom, a built-in or a custom one. */
+    geoms?: Readonly<Record<string, ObservationsEditMenu | null | undefined>>;
+    legend?: TargetEditMenu<'legend'> | null;
+    axis?: TargetEditMenu<'axis'> | null;
+    grid?: TargetEditMenu<'grid'> | null;
+    graph?: TargetEditMenu<'graph'> | null;
 }
 
 /**
@@ -1000,6 +1031,11 @@ declare interface GridSlotProps {
     panelRect: GraphLayout['panel'];
 }
 
+/** The edit targets a press on a guide takes: the legend, an axis, the grid lines of an axis. */
+declare type GuideEditTarget = Extract<EditTarget, {
+    kind: 'legend' | 'axis' | 'grid';
+}>;
+
 /**
  * Props for the Header slot, overridable via `slots.Header` on `GraphRenderer`. Title editing in
  * `editable` mode is internal to this default — it hands off to the editor `/editable` supplies —
@@ -1081,6 +1117,9 @@ declare interface IntroAnimationOptions {
 /** Without an IntersectionObserver, as in a test environment, `inView` plays on mount. */
 declare type IntroTrigger = 'mount' | 'inView';
 
+/** One geom's edit menus, keyed by the chart's coord and then by the layer's position. */
+declare type LayerEditMenus = Partial<Record<CoordType, Partial<Record<PositionAdjustment, ObservationsEditMenu | null>>>>;
+
 /** Where the legend sits relative to the chart, and how it names its series. */
 export declare const LegendSection: ({ positions, title, layout, preview }: LegendSectionProps) => JSX.Element | null;
 
@@ -1166,6 +1205,9 @@ export declare interface NumberFieldControlProps extends ContinuousControlProps<
  */
 export declare const NumberFormatSection: ({ title, layout, preview }: OverridableSectionProps) => JSX.Element | null;
 
+/** The rows the overlay menu draws under its title for a selection of observations. */
+declare type ObservationsEditMenu = ComponentType<ResolvedObservations> & EditMenuRows<ObservationsTarget>;
+
 /**
  * What a host may override per section, spread by every section onto its `Section`, so the same
  * section can be mounted at two layouts without being forked to get them.
@@ -1289,6 +1331,12 @@ declare interface ResizeObserverState {
 /** A {@link ControlRegistry} with every member filled in, as sections consume it. */
 export declare type ResolvedControlRegistry = Required<ControlRegistry>;
 
+/** What the overlay menu hands the edit menu of a selection of observations. */
+declare interface ResolvedObservations {
+    /** The selected observations' edit target, which the edit menu's rows hand to their commands. */
+    target: ObservationsTarget;
+}
+
 /**
  * One labeled setting, wiring its own control: the row publishes its ids and each control takes the
  * half it can carry. The label reaches it with `htmlFor` rather than wrapping it, because a wrapping
@@ -1500,6 +1548,15 @@ export declare interface SwitchControlProps extends ControlBaseProps {
     onChange: (isChecked: boolean) => void;
 }
 
+/** The rows the overlay menu draws under its title for a guide or the chart, handed its edit target. */
+declare type TargetEditMenu<Kind extends GuideEditTarget['kind'] | 'graph'> = ComponentType<{
+    target: Extract<EditTarget, {
+        kind: Kind;
+    }>;
+}> & EditMenuRows<Extract<EditTarget, {
+    kind: Kind;
+}>>;
+
 declare type TextDirection = 'ltr' | 'rtl';
 
 /**