@visactor/vtable-sheet 1.22.13-alpha.0 → 1.23.0

package/cjs/ts-types/spreadsheet-events.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/ts-types/spreadsheet-events.ts"],"names":[],"mappings":";;;AAoEA,IAAY,oBAgEX;AAhED,WAAY,oBAAoB;IAG9B,2EAAmD,CAAA;IAEnD,uEAA+C,CAAA;IAE/C,uDAA+B,CAAA;IAE/B,iFAAyD,CAAA;IAEzD,uDAA+B,CAAA;IAE/B,2DAAmC,CAAA;IAInC,mDAA2B,CAAA;IAI3B,+DAAuC,CAAA;IAEvC,uEAA+C,CAAA;IAE/C,mEAA2C,CAAA;IAI3C,mDAA2B,CAAA;IAE3B,uDAA+B,CAAA;IAE/B,uDAA+B,CAAA;IAE/B,2DAAmC,CAAA;IAEnC,+DAAuC,CAAA;IAEvC,mDAA2B,CAAA;IAE3B,6EAAqD,CAAA;IAIrD,qDAA6B,CAAA;IAE7B,6DAAqC,CAAA;IAErC,qDAA6B,CAAA;IAE7B,qDAA6B,CAAA;IAE7B,6DAAqC,CAAA;IAErC,qDAA6B,CAAA;IAI7B,uFAA+D,CAAA;IAE/D,mGAA2E,CAAA;IAE3E,+FAAuE,CAAA;AACzE,CAAC,EAhEW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAgE/B;AAUY,QAAA,qBAAqB,GAAG;IACnC,yBAAyB;IACzB,uBAAuB;IACvB,eAAe;IACf,4BAA4B;IAC5B,eAAe;IACf,iBAAiB;IACjB,aAAa;IACb,aAAa;IACb,eAAe;CACP,CAAC;AAGE,QAAA,uBAAuB,GAAG;IACrC,mBAAmB;IACnB,uBAAuB;IACvB,qBAAqB;IACrB,aAAa;IACb,eAAe;IACf,eAAe;IACf,iBAAiB;IACjB,mBAAmB;IACnB,aAAa;IACb,0BAA0B;IAC1B,cAAc;IACd,kBAAkB;IAClB,cAAc;IACd,cAAc;IACd,kBAAkB;IAClB,cAAc;IACd,+BAA+B;IAC/B,qCAAqC;IACrC,mCAAmC;CAC3B,CAAC","file":"spreadsheet-events.js","sourcesContent":["/**\n * 电子表格事件类型定义\n *\n * 统一事件架构：\n * 所有事件通过统一的 VTableSheetEventType 枚举定义\n * 用户只需使用 on() 和 off() 方法，无需区分事件层级\n * 事件命名使用下划线格式，移除不必要的前缀区分\n */\n\nimport type { CellCoord, CellRange, CellValue } from './base';\n\n/**\n * 排序信息接口\n */\nexport interface SortInfo {\n  /** 排序字段 */\n  field: string;\n  /** 排序方向 */\n  order: 'asc' | 'desc';\n  /** 排序的列索引 */\n  col: number;\n}\n\n/**\n * 筛选信息接口\n */\nexport interface FilterInfo {\n  /** 筛选的列 */\n  col: number;\n  /** 筛选条件 */\n  conditions: FilterCondition[];\n}\n\n/**\n * 筛选条件\n */\nexport interface FilterCondition {\n  /** 条件类型 */\n  type: 'equals' | 'contains' | 'greater_than' | 'less_than' | 'between';\n  /** 条件值 */\n  value: string | number | [number, number];\n}\n\n/**\n * 范围接口\n */\nexport interface Range {\n  /** 起始行 */\n  startRow: number;\n  /** 结束行 */\n  endRow: number;\n  /** 起始列 */\n  startCol: number;\n  /** 结束列 */\n  endCol: number;\n}\n\n/**\n * 统一的 VTableSheet 事件类型枚举\n * 包含所有工作表和电子表格级别的事件\n *\n * 命名规范：\n * - 使用下划线命名法 (snake_case)\n * - 按功能模块分组\n * - 避免冗余前缀，保持简洁\n *\n * 注意：新增事件时，请同步更新以下常量定义\n */\nexport enum VTableSheetEventType {\n  // ===== 公式相关事件 =====\n  /** 公式计算开始 */\n  FORMULA_CALCULATE_START = 'formula_calculate_start',\n  /** 公式计算结束 */\n  FORMULA_CALCULATE_END = 'formula_calculate_end',\n  /** 公式计算错误 */\n  FORMULA_ERROR = 'formula_error',\n  /** 公式依赖关系改变 */\n  FORMULA_DEPENDENCY_CHANGED = 'formula_dependency_changed',\n  /** 单元格公式添加 */\n  FORMULA_ADDED = 'formula_added',\n  /** 单元格公式移除 */\n  FORMULA_REMOVED = 'formula_removed',\n\n  // ===== 数据操作事件 =====\n  /** 数据加载完成 */\n  DATA_LOADED = 'data_loaded',\n\n  // ===== 电子表格生命周期 =====\n  /** 电子表格初始化完成 */\n  SPREADSHEET_READY = 'spreadsheet_ready',\n  /** 电子表格销毁 */\n  SPREADSHEET_DESTROYED = 'spreadsheet_destroyed',\n  /** 电子表格大小改变 */\n  SPREADSHEET_RESIZED = 'spreadsheet_resized',\n\n  // ===== Sheet 管理事件 =====\n  /** 添加新 Sheet */\n  SHEET_ADDED = 'sheet_added',\n  /** 删除 Sheet */\n  SHEET_REMOVED = 'sheet_removed',\n  /** 重命名 Sheet */\n  SHEET_RENAMED = 'sheet_renamed',\n  /** 激活 Sheet（切换 Sheet） */\n  SHEET_ACTIVATED = 'sheet_activated',\n  /** Sheet 停用 */\n  SHEET_DEACTIVATED = 'sheet_deactivated',\n  /** Sheet 顺序移动 */\n  SHEET_MOVED = 'sheet_moved',\n  /** Sheet 显示/隐藏 */\n  SHEET_VISIBILITY_CHANGED = 'sheet_visibility_changed',\n\n  // ===== 导入导出事件 =====\n  /** 开始导入 */\n  IMPORT_START = 'import_start',\n  /** 导入完成 */\n  IMPORT_COMPLETED = 'import_completed',\n  /** 导入失败 */\n  IMPORT_ERROR = 'import_error',\n  /** 开始导出 */\n  EXPORT_START = 'export_start',\n  /** 导出完成 */\n  EXPORT_COMPLETED = 'export_completed',\n  /** 导出失败 */\n  EXPORT_ERROR = 'export_error',\n\n  // ===== 跨 Sheet 操作事件 =====\n  /** 跨 Sheet 引用更新 */\n  CROSS_SHEET_REFERENCE_UPDATED = 'cross_sheet_reference_updated',\n  /** 跨 Sheet 公式计算开始 */\n  CROSS_SHEET_FORMULA_CALCULATE_START = 'cross_sheet_formula_calculate_start',\n  /** 跨 Sheet 公式计算结束 */\n  CROSS_SHEET_FORMULA_CALCULATE_END = 'cross_sheet_formula_calculate_end'\n}\n\n/**\n * ============================================\n * 事件定义集中化管理\n * 新增事件时只需要修改这里\n * ============================================\n */\n\n/** WorkSheet 层支持的事件类型列表 */\nexport const WORKSHEET_EVENT_TYPES = [\n  'formula_calculate_start',\n  'formula_calculate_end',\n  'formula_error',\n  'formula_dependency_changed',\n  'formula_added',\n  'formula_removed',\n  'data_loaded',\n  'data_sorted',\n  'data_filtered'\n] as const;\n\n/** SpreadSheet 层支持的事件类型列表 */\nexport const SPREADSHEET_EVENT_TYPES = [\n  'spreadsheet_ready',\n  'spreadsheet_destroyed',\n  'spreadsheet_resized',\n  'sheet_added',\n  'sheet_removed',\n  'sheet_renamed',\n  'sheet_activated',\n  'sheet_deactivated',\n  'sheet_moved',\n  'sheet_visibility_changed',\n  'import_start',\n  'import_completed',\n  'import_error',\n  'export_start',\n  'export_completed',\n  'export_error',\n  'cross_sheet_reference_updated',\n  'cross_sheet_formula_calculate_start',\n  'cross_sheet_formula_calculate_end'\n] as const;\n\n// /** 所有支持的事件类型 */\n// export const ALL_EVENT_TYPES = [...WORKSHEET_EVENT_TYPES, ...SPREADSHEET_EVENT_TYPES] as const;\n\n// /** 事件类型类型定义 */\n// export type WorkSheetEventType = (typeof WORKSHEET_EVENT_TYPES)[number];\n// export type SpreadSheetEventType = (typeof SPREADSHEET_EVENT_TYPES)[number];\n// export type AllEventType = (typeof ALL_EVENT_TYPES)[number];\n\n/**\n * ============================================\n * 统一事件数据接口\n * ============================================\n */\n\n/** 工作表激活事件数据 */\nexport interface SheetActivatedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** Sheet 标题 */\n  sheetTitle: string;\n  /** 之前激活的 Sheet Key */\n  previousSheetKey?: string;\n  /** 之前激活的 Sheet 标题 */\n  previousSheetTitle?: string;\n}\n\n/** 工作表尺寸改变事件数据 */\nexport interface SheetResizedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** Sheet 标题 */\n  sheetTitle: string;\n  /** 宽度 */\n  width: number;\n  /** 高度 */\n  height: number;\n}\n\n/** 公式计算事件数据 */\nexport interface FormulaCalculateEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 计算的公式数量 */\n  formulaCount?: number;\n  /** 耗时（毫秒） */\n  duration?: number;\n}\n\n/** 公式错误事件数据 */\nexport interface FormulaErrorEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 单元格位置 */\n  cell: CellCoord & { sheet: string };\n  /** 公式 */\n  formula: string;\n  /** 错误信息 */\n  error: string | Error;\n}\n\n/** 公式添加/移除事件数据 */\nexport interface FormulaChangeEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 单元格位置 */\n  cell: CellCoord;\n  /** 公式内容 */\n  formula?: string;\n}\n\n/** 公式依赖关系改变事件数据 */\nexport interface FormulaDependencyChangedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n}\n\n/** 数据排序事件数据 */\nexport interface DataSortedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 排序信息 */\n  sortInfo: SortInfo;\n}\n\n/** 数据筛选事件数据 */\nexport interface DataFilteredEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 筛选信息 */\n  filterInfo: FilterInfo;\n}\n\n/** 数据加载事件数据 */\nexport interface DataLoadedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 行数 */\n  rowCount: number;\n  /** 列数 */\n  colCount: number;\n}\n\n/** 工作表添加事件数据 */\nexport interface SheetAddedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** Sheet 标题 */\n  sheetTitle: string;\n  /** Sheet 索引 */\n  index: number;\n}\n\n/** 工作表移除事件数据 */\nexport interface SheetRemovedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** Sheet 标题 */\n  sheetTitle: string;\n  /** 原 Sheet 索引 */\n  index: number;\n}\n\n/** 工作表重命名事件数据 */\nexport interface SheetRenamedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 旧标题 */\n  oldTitle: string;\n  /** 新标题 */\n  newTitle: string;\n}\n\n/** 工作表移动事件数据 */\nexport interface SheetMovedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 旧索引 */\n  fromIndex: number;\n  /** 新索引 */\n  toIndex: number;\n}\n\n/** 工作表可见性改变事件数据 */\nexport interface SheetVisibilityChangedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 是否可见 */\n  visible: boolean;\n}\n\n/** 导入事件数据 */\nexport interface ImportEvent {\n  /** 导入的文件类型 */\n  fileType: 'xlsx' | 'xls' | 'csv';\n  /** 导入的 Sheet 数量 */\n  sheetCount?: number;\n  /** 错误信息（如果有） */\n  error?: string | Error;\n}\n\n/** 导出事件数据 */\nexport interface ExportEvent {\n  /** 导出的文件类型 */\n  fileType: 'xlsx' | 'csv';\n  /** 导出的 Sheet 数量 */\n  sheetCount?: number;\n  /** 是否导出所有 Sheet */\n  allSheets: boolean;\n  /** 错误信息（如果有） */\n  error?: string | Error;\n}\n\n/** 跨 Sheet 引用更新事件数据 */\nexport interface CrossSheetReferenceEvent {\n  /** 源 Sheet Key */\n  sourceSheetKey: string;\n  /** 目标 Sheet Keys */\n  targetSheetKeys: string[];\n  /** 影响的公式数量 */\n  affectedFormulaCount: number;\n}\n\n/** 范围数据变更事件数据 */\nexport interface RangeDataChangedEvent {\n  /** Sheet Key */\n  sheetKey: string;\n  /** 变更范围 */\n  range: CellRange;\n  /** 变更的单元格数据 */\n  changes: Array<{\n    row: number;\n    col: number;\n    oldValue: CellValue;\n    newValue: CellValue;\n  }>;\n}\n\n/**\n * SpreadSheet 事件映射\n */\nexport interface SpreadSheetEventMap {\n  spreadsheet_ready: undefined;\n  spreadsheet_destroyed: undefined;\n  spreadsheet_resized: { width: number; height: number };\n  sheet_added: SheetAddedEvent;\n  sheet_removed: SheetRemovedEvent;\n  sheet_renamed: SheetRenamedEvent;\n  sheet_activated: SheetActivatedEvent;\n  sheet_deactivated: SheetActivatedEvent;\n  sheet_moved: SheetMovedEvent;\n  sheet_visibility_changed: SheetVisibilityChangedEvent;\n  import_start: ImportEvent;\n  import_completed: ImportEvent;\n  import_error: ImportEvent;\n  export_start: ExportEvent;\n  export_completed: ExportEvent;\n  export_error: ExportEvent;\n  cross_sheet_reference_updated: CrossSheetReferenceEvent;\n  cross_sheet_formula_calculate_start: undefined;\n  cross_sheet_formula_calculate_end: undefined;\n}\n\n/**\n * WorkSheet 事件映射\n */\nexport interface WorkSheetEventMap {\n  formula_calculate_start: FormulaCalculateEvent;\n  formula_calculate_end: FormulaCalculateEvent;\n  formula_error: FormulaErrorEvent;\n  formula_dependency_changed: FormulaDependencyChangedEvent;\n  formula_added: FormulaChangeEvent;\n  formula_removed: FormulaChangeEvent;\n  data_loaded: DataLoadedEvent;\n  sheet_added: SheetAddedEvent;\n  sheet_removed: SheetRemovedEvent;\n  sheet_renamed: SheetRenamedEvent;\n  sheet_moved: SheetMovedEvent;\n  sheet_activated: SheetActivatedEvent;\n  sheet_deactivated: SheetActivatedEvent;\n  sheet_visibility_changed: SheetVisibilityChangedEvent;\n  import_start: ImportEvent;\n  import_completed: ImportEvent;\n  import_error: ImportEvent;\n  export_start: ExportEvent;\n  export_completed: ExportEvent;\n  export_error: ExportEvent;\n  cross_sheet_reference_updated: CrossSheetReferenceEvent;\n  cross_sheet_formula_calculate_start: undefined;\n  cross_sheet_formula_calculate_end: undefined;\n}\n"]}