@rowsncolumns/spreadsheet 10.3.1 → 10.4.0

package/dist/cjs/hooks/use-embeds-charts.d.ts

@@ -1,6 +1,10 @@
-import type { CellInterface, CellPosition, PosXYRequired } from "@rowsncolumns/grid";
+import type { CellInterface, CellPosition, Grid, PosXYRequired } from "@rowsncolumns/grid";
+import type { ElementType } from "react";
 import React from "react";
 import type { CanvasGridProps, SpreadsheetTheme } from "../components/canvas-grid/typings";
+import type { ChartClipboard } from "./use-chart-clipboard";
+import type { OverlayPosition } from "../types";
+import { type ContextMenuWrapperProps } from "./use-context-menu";
 export type OverlayBounds = {
     left?: number;
     right?: number;
@@ -14,6 +18,20 @@ export type CategorizedComponents<T> = {
     frozenColumn: T[];
     intersection: T[];
 };
+/**
+ * The cell an object's top-left corner actually sits in: its anchor cell
+ * walked forward by its pixel offsets. An `absoluteAnchor` imports as A1 plus
+ * a large offset, so the raw anchor says nothing about which pane the object
+ * is on screen in. The walk is bounded by `maxRow` / `maxColumn` (the frozen
+ * counts) — past them the answer is "body" regardless of the exact cell.
+ */
+export declare const resolveOverlayCell: (anchorCell: {
+    rowIndex: number;
+    columnIndex: number;
+}, offsetXPixels: number, offsetYPixels: number, getCellOffsetFromCoords: (cell: CellInterface) => Pick<CellPosition, "width" | "height"> | undefined, maxRow: number, maxColumn: number) => {
+    rowIndex: number;
+    columnIndex: number;
+};
 /**
  * Get placement of an item based on anchor cell position
  */
@@ -21,6 +39,17 @@ export declare const getOverlayPlacement: (anchorCell: {
     rowIndex: number;
     columnIndex: number;
 } | undefined, frozenRows: number, frozenColumns: number) => FrozenPanePlacement;
+/** Excel's default placement — an object with no explicit mode moves and sizes with cells. */
+export declare const isMoveAndSizePlacement: (overlay: Pick<OverlayPosition, "placement"> | undefined) => boolean;
+/**
+ * The props that lay a frame out from both anchors — only a `moveAndSize`
+ * object with a persisted second anchor; the others keep their pixel size.
+ */
+export declare const getOverlayToAnchorProps: (overlay: OverlayPosition) => {
+    toCell: CellInterface;
+    toOffsetXPixels: number;
+    toOffsetYPixels: number;
+} | undefined;
 export type UseEmbedsChartsProps = {
     /**
      * Charts to be displayed
@@ -96,6 +125,19 @@ export type UseEmbedsChartsProps = {
         scrollLeft: number;
         scrollTop: number;
     };
+    /**
+     * Viewport point → position relative to the grid container, where the
+     * right-click menu is anchored.
+     */
+    getRelativePositionFromOffset: React.ComponentRef<typeof Grid>["getRelativePositionFromOffset"];
+    /**
+     * Positions the right-click menu; the grid's cell menu uses the same one.
+     */
+    ContextMenuWrapper?: ElementType<ContextMenuWrapperProps>;
+    /**
+     * Return focus to the sheet once a menu action removed the object.
+     */
+    focusSheet(): void;
     /**
      * Get overlay bounds
      */
@@ -110,6 +152,22 @@ export type UseEmbedsChartsProps = {
      * User is trying to delete an embed
      */
     onDeleteChart: CanvasGridProps["onDeleteChart"];
+    /**
+     * Persist an edited chart; handed to the chart renderer for in-place
+     * operations (Switch Row/Column).
+     */
+    onUpdateChart?: CanvasGridProps["onUpdateChart"];
+    /**
+     * Persist an Arrange command (Bring Forward / Send Backward / Bring to
+     * Front / Send to Back) planned across the sheet's charts and embeds.
+     */
+    onChangeZOrder?: CanvasGridProps["onChangeZOrder"];
+    /**
+     * The grid's chart clipboard (`useChartClipboard`): Ctrl+C / Ctrl+X / Ctrl+V /
+     * Ctrl+D while a chart is focused and the Cut / Copy / Paste menu items —
+     * one implementation behind both.
+     */
+    chartClipboard?: ChartClipboard;
     /**
      * Fired when user moves a chart
      * @param anchorCell
@@ -184,10 +242,12 @@ export type UseEmbedsChartsProps = {
      */
     disabled: boolean;
 };
-export declare const useEmbedsCharts: ({ scale, charts, embeds, slicers, sheetId, frozenRows, frozenColumns, getCellOffsetFromCoords, getCellCoordsFromOffset, getAbsolutePositionFromOffset, getBounds, selectedColor, onMoveChart, onResizeChart, onMoveEmbed, onResizeEmbed, onDeleteChart, onDeleteEmbed, onRequestEditEmbed, onMoveSlicer, onResizeSlicer, onDeleteSlicer, onRequestEditSlicer, onFilterTable, onFilterPivot, tables, pivotTables, getFormattedValue, getChartComponent, getEmbedComponent, getSlicerComponent, readonly, theme, backgroundColor, disabled, }: UseEmbedsChartsProps) => {
+export declare const useEmbedsCharts: ({ scale, charts, embeds, slicers, sheetId, frozenRows, frozenColumns, getCellOffsetFromCoords, getCellCoordsFromOffset, getAbsolutePositionFromOffset, getRelativePositionFromOffset, ContextMenuWrapper, focusSheet, getBounds, selectedColor, onMoveChart, onResizeChart, chartClipboard, onMoveEmbed, onResizeEmbed, onDeleteChart, onUpdateChart, onChangeZOrder, onDeleteEmbed, onRequestEditEmbed, onMoveSlicer, onResizeSlicer, onDeleteSlicer, onRequestEditSlicer, onFilterTable, onFilterPivot, tables, pivotTables, getFormattedValue, getChartComponent, getEmbedComponent, getSlicerComponent, readonly, theme, backgroundColor, disabled, }: UseEmbedsChartsProps) => {
     chartComponents: CategorizedComponents<React.JSX.Element>;
-    embedComponents: React.JSX.Element[];
-    slicerComponents: React.JSX.Element[];
+    embedComponents: CategorizedComponents<React.JSX.Element>;
+    slicerComponents: CategorizedComponents<React.JSX.Element>;
+    contextMenuComponent: React.JSX.Element;
     onMouseDown: () => void;
+    requestChartContextMenu: (id: string | number, clientX: number, clientY: number, element: HTMLDivElement) => void;
 };
 //# sourceMappingURL=use-embeds-charts.d.ts.map

package/dist/cjs/hooks/use-embeds-charts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-embeds-charts.d.ts","sourceRoot":"","sources":["../../../hooks/use-embeds-charts.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAA+B,MAAM,OAAO,CAAC;AAGpD,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EACjB,MAAM,mCAAmC,CAAC;AAc3C,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B,MAAM,GACN,WAAW,GACX,cAAc,GACd,cAAc,CAAC;AAEnB,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI;IACrC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,SAAS,EAAE,CAAC,EAAE,CAAC;IACf,YAAY,EAAE,CAAC,EAAE,CAAC;IAClB,YAAY,EAAE,CAAC,EAAE,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAC9B,YAAY;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,EACjE,YAAY,MAAM,EAClB,eAAe,MAAM,KACpB,mBASF,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACxD;;OAEG;IACH,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACxD;;OAEG;IACH,kBAAkB,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;IAC1D;;;;;OAKG;IACH,6BAA6B,CAC3B,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,GACR,aAAa,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,uBAAuB,CACrB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAClC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;;OAGG;IACH,uBAAuB,CAAC,IAAI,EAAE,aAAa,GAAG,YAAY,GAAG,SAAS,CAAC;IACvE;;OAEG;IACH,iBAAiB,IAAI;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D;;OAEG;IACH,SAAS,IAAI,aAAa,CAAC;IAC3B;;;;OAIG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;;;;OAKG;IACH,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;IAC5C;;;;OAIG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,kBAAkB,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;IAC1D;;;;;OAKG;IACH,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;IAC5C;;OAEG;IACH,cAAc,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAClD;;OAEG;IACH,cAAc,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAClD;;OAEG;IACH,mBAAmB,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAC5D;;OAEG;IACH,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC;IAC9C;;OAEG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC;;OAEG;IACH,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;IAC5C;;OAEG;IACH,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACxD;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAoCF,eAAO,MAAM,eAAe,GAAI,6gBAoC7B,oBAAoB;;;;;CAsatB,CAAC"}
+{"version":3,"file":"use-embeds-charts.d.ts","sourceRoot":"","sources":["../../../hooks/use-embeds-charts.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,IAAI,EACJ,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,KAAiD,MAAM,OAAO,CAAC;AAOtE,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EACjB,MAAM,mCAAmC,CAAC;AAU3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAiB5D,OAAO,KAAK,EAAE,eAAe,EAAmB,MAAM,UAAU,CAAC;AAYjE,OAAO,EACL,KAAK,uBAAuB,EAE7B,MAAM,oBAAoB,CAAC;AAE5B,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B,MAAM,GACN,WAAW,GACX,cAAc,GACd,cAAc,CAAC;AAEnB,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI;IACrC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,SAAS,EAAE,CAAC,EAAE,CAAC;IACf,YAAY,EAAE,CAAC,EAAE,CAAC;IAClB,YAAY,EAAE,CAAC,EAAE,CAAC;CACnB,CAAC;AASF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,YAAY;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,EACrD,eAAe,MAAM,EACrB,eAAe,MAAM,EACrB,yBAAyB,CACvB,IAAI,EAAE,aAAa,KAChB,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG,SAAS,EACvD,QAAQ,MAAM,EACd,WAAW,MAAM;;;CAkBlB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAC9B,YAAY;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,EACjE,YAAY,MAAM,EAClB,eAAe,MAAM,KACpB,mBASF,CAAC;AAEF,8FAA8F;AAC9F,eAAO,MAAM,sBAAsB,GACjC,SAAS,IAAI,CAAC,eAAe,EAAE,WAAW,CAAC,GAAG,SAAS,YACG,CAAC;AAE7D;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,SAAS,eAAe;;;;aAOjD,CAAC;AAEhB,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACxD;;OAEG;IACH,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACxD;;OAEG;IACH,kBAAkB,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;IAC1D;;;;;OAKG;IACH,6BAA6B,CAC3B,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,GACR,aAAa,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,uBAAuB,CACrB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAClC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;;OAGG;IACH,uBAAuB,CAAC,IAAI,EAAE,aAAa,GAAG,YAAY,GAAG,SAAS,CAAC;IACvE;;OAEG;IACH,iBAAiB,IAAI;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D;;;OAGG;IACH,6BAA6B,EAAE,KAAK,CAAC,YAAY,CAC/C,OAAO,IAAI,CACZ,CAAC,+BAA+B,CAAC,CAAC;IACnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,WAAW,CAAC,uBAAuB,CAAC,CAAC;IAC1D;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IACnB;;OAEG;IACH,SAAS,IAAI,aAAa,CAAC;IAC3B;;;;OAIG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;;OAGG;IACH,aAAa,CAAC,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IACjD;;;OAGG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;IACnD;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;;;OAKG;IACH,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;IAC5C;;;;OAIG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,kBAAkB,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;IAC1D;;;;;OAKG;IACH,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;IAC5C;;OAEG;IACH,cAAc,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAClD;;OAEG;IACH,cAAc,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAClD;;OAEG;IACH,mBAAmB,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAC5D;;OAEG;IACH,YAAY,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC;IAC9C;;OAEG;IACH,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IAClC;;OAEG;IACH,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;IAC5C;;OAEG;IACH,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACxD;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAoCF,eAAO,MAAM,eAAe,GAAI,2nBA0C7B,oBAAoB;;;;;;kCA+Mb,MAAM,GAAG,MAAM,WACV,MAAM,WACN,MAAM,WACN,cAAc;CAorB5B,CAAC"}