ooxml-excel-editor 1.3.3 → 1.11.0

package/dist/react/ExcelViewer.d.ts

@@ -1,6 +1,7 @@
 import { CSSProperties } from 'react';
 import { CellModel, CellStyleFn, CellStyleOverride, ImageAnchor, MergeRange, TransformModelFn, WorkbookModel } from '../core/model/types';
 import { EditableTarget } from '../core/edit/types';
+import { PasteBehavior } from '../core/edit/paste-behavior';
 import { FormulaEngineFactory } from '../core/formula/engine';
 import { CellChangePayload, DimChangePayload, DirtyChangePayload, ImageChangePayload, StructChangePayload } from '../core/edit/edit-controller';
 import { CellSnapshot } from '../core/model/snapshot';
@@ -14,7 +15,7 @@ import { ExcelSource } from '../core/loader';
 import { ImageExportOptions, PdfExportOptions, PrintOptions } from '../core/export';
 import { XlsxExportOptions } from '../core/export/xlsx-writer';
 import { Cell } from '../core/viewer/controller';
-import { ContextMenuBeforePayload, ContextMenuShowPayload, ContextMenuTransform, ExcelPlugin, MenuItem, PermissionDeniedPayload } from '../core/plugin';
+import { ContextMenuBeforePayload, ContextMenuShowPayload, ContextMenuTransform, ExcelPlugin, MenuItem, PermissionDeniedPayload, ViewerApi } from '../core/plugin';
 export interface ExcelViewerProps {
     src?: ExcelSource;
     /**
@@ -72,6 +73,17 @@ export interface ExcelViewerProps {
     plugins?: ExcelPlugin[];
     /** 编辑总开关:默认 false = 只读(行为不变)。开启后才能进入编辑(E0:闸门) */
     editable?: boolean;
+    /**
+     * 透视表功能开关:默认 false = 关闭。开启后(还需 `editable`)工具栏 `pivot-table` 入口可见、
+     * `createPivotTable`/`openPivotTableDialog` 等 API 生效、导出 .xlsx 回注真实 OOXML 透视表零件
+     * (overlay 模式同时保留原文件透视表)。
+     */
+    pivotTable?: boolean;
+    /**
+     * 条件格式编辑开关:默认 false = 关闭(只读渲染)。开启后(还需 `editable`)工具栏 `conditional-format`
+     * 入口可见、`openConditionalFormatDialog`/`addConditionalRule` 等 API 生效、导出 .xlsx 回写条件格式。
+     */
+    conditionalFormat?: boolean;
     /** 按格只读判定:返回 true = 只读(cell 为空格时传 null) */
     cellReadOnly?: (cell: CellModel | null, pos: {
         row: number;
@@ -102,12 +114,16 @@ export interface ExcelViewerProps {
     recalc?: boolean;
     /** 自定义/自研公式引擎工厂(可换引擎);不给则用默认 HyperFormula(需 npm i hyperformula) */
     formulaEngine?: FormulaEngineFactory;
+    /** 粘贴行为(默认 = 覆盖式 1:1)。控制 Ctrl+V / 右键粘贴时源各方面如何落目标;也可 viewer.setPasteBehavior 运行时改 */
+    pasteBehavior?: Partial<PasteBehavior>;
+    /** 粘贴撞只读格的内置提醒:'dialog'(默认,弹窗列出哪些格只读)/ 'toast'(气泡)/ 'none'(只发事件) */
+    readOnlyPrompt?: 'dialog' | 'toast' | 'none';
     /**
      * 操作工具栏配置 (跟 Vue 3/Vue 2 同 API):
-     * - `true`/不传(默认): 显示默认两项 ['find', 'filter']
+     * - `true`/不传(默认): 显示默认三项 ['find', 'filter', 'sort']
      * - `false`: 隐藏整条工具栏
      * - 数组: 显式控制项与顺序 (内置 id 或自定义 ToolbarItem)
-     * - 内置 id: find / filter / clear-filter / copy / wrap-text / template / image-tools /
+     * - 内置 id: find / filter / sort / clear-filter / copy / wrap-text / template / image-tools /
      *   freeze / export / zoom / 'separator' (或 '|')
      */
     toolbar?: boolean | Array<string | import('../core/plugin').ToolbarItem>;
@@ -160,6 +176,9 @@ export interface ExcelViewerHandle {
     setActiveSheet: (i: number) => void;
     getSelection: () => MergeRange | null;
     setSelection: (range: MergeRange) => void;
+    scrollToCell: (row: number, col: number, opts?: {
+        select?: boolean;
+    }) => boolean;
     rectOf: (row: number, col: number) => {
         x: number;
         y: number;
@@ -176,6 +195,21 @@ export interface ExcelViewerHandle {
     isCellEditable: (row: number, col: number) => boolean;
     setEditableTargets: (targets: EditableTarget | EditableTarget[] | undefined) => void;
     getEditableTargets: () => EditableTarget | EditableTarget[] | undefined;
+    sortActiveColumn: (dir: 'asc' | 'desc') => boolean;
+    createPivotTable: ViewerApi['createPivotTable'];
+    createPivotTableFromSelection: ViewerApi['createPivotTableFromSelection'];
+    openPivotTableDialog: ViewerApi['openPivotTableDialog'];
+    getConditionalRules: ViewerApi['getConditionalRules'];
+    addConditionalRule: ViewerApi['addConditionalRule'];
+    updateConditionalRule: ViewerApi['updateConditionalRule'];
+    removeConditionalRule: ViewerApi['removeConditionalRule'];
+    setConditionalRules: ViewerApi['setConditionalRules'];
+    openConditionalFormatDialog: ViewerApi['openConditionalFormatDialog'];
+    setSelectionNumberFormat: ViewerApi['setSelectionNumberFormat'];
+    openNumberFormatDialog: ViewerApi['openNumberFormatDialog'];
+    getCellComment: ViewerApi['getCellComment'];
+    setCellComment: ViewerApi['setCellComment'];
+    openCommentEditor: ViewerApi['openCommentEditor'];
     editCell: (row: number, col: number, value: CellValue) => boolean;
     editRange: (range: MergeRange, values: CellValue[][]) => boolean;
     clearRange: (range: MergeRange) => boolean;
@@ -195,7 +229,10 @@ export interface ExcelViewerHandle {
     pasteRichHtml: (html: string, at?: {
         row: number;
         col: number;
-    }) => boolean;
+    }, behaviorOverride?: Partial<PasteBehavior> | null) => boolean;
+    getPasteBehavior: () => PasteBehavior;
+    setPasteBehavior: (cfg: Partial<PasteBehavior> | null) => void;
+    openPasteConfigDialog: () => boolean;
     pasteImageBlob: (blob: Blob, at?: {
         row: number;
         col: number;