Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.
TypeScript boardcollaborationdocdocxexceloffce365officepdfpptpptxpresentationsdksheetslidesspreadsheetuniverwordwordprocessorworkspacexlsx
fix(sheet): add cell custom field (#2021)
Dushusir53b904140ae8
diff --git a/packages/core/src/types/interfaces/i-cell-data.ts b/packages/core/src/types/interfaces/i-cell-data.tsindex e2d940f2a6..f1937d8223 100644--- a/packages/core/src/types/interfaces/i-cell-data.ts+++ b/packages/core/src/types/interfaces/i-cell-data.ts@@ -56,6 +56,11 @@ export interface ICellData {* Id of the formula.*/si?: Nullable<string>;++ /**+ * User stored custom fields+ */+ custom?: { [key: string]: any };}export interface ICellMarksStyle {diff --git a/packages/sheets-ui/src/locale/en-US.ts b/packages/sheets-ui/src/locale/en-US.tsindex 80a3a4d61b..d9e1d2915a 100644--- a/packages/sheets-ui/src/locale/en-US.ts+++ b/packages/sheets-ui/src/locale/en-US.ts@@ -428,6 +428,7 @@ const locale: typeof zhCN = {clipboard: {paste: {exceedMaxCells: 'The number of cells pasted exceeds the maximum number of cells',+ overlappingMergedCells: 'The paste area overlaps with merged cells',},shortCutNotify: {title: 'Kindly paste using keyboard shortcuts.',diff --git a/packages/sheets-ui/src/locale/zh-CN.ts b/packages/sheets-ui/src/locale/zh-CN.tsindex 23f6dc7326..725f5ac022 100644--- a/packages/sheets-ui/src/locale/zh-CN.ts+++ b/packages/sheets-ui/src/locale/zh-CN.ts@@ -426,6 +426,7 @@ const locale = {clipboard: {paste: {exceedMaxCells: '粘贴区域超出最大单元格数',+ overlappingMergedCells: '粘贴区域与合并单元格重叠',},shortCutNotify: {title: '请使用快捷键粘贴',diff --git a/packages/sheets-ui/src/services/clipboard/__tests__/clipboard-test-bed.ts b/packages/sheets-ui/src/services/clipboard/__tests__/clipboard-test-bed.tsindex f117fb042f..7af569c0c5 100644--- a/packages/sheets-ui/src/services/clipboard/__tests__/clipboard-test-bed.ts+++ b/packages/sheets-ui/src/services/clipboard/__tests__/clipboard-test-bed.ts@@ -15,7 +15,7 @@*/import type { IWorkbookData } from '@univerjs/core';-import { ILogService, IUniverInstanceService, LocaleType, LogLevel, Plugin, Univer, UniverInstanceType } from '@univerjs/core';+import { ILogService, IUniverInstanceService, LocaleService, LocaleType, LogLevel, Plugin, Univer, UniverInstanceType } from '@univerjs/core';import { IRenderManagerService, RenderManagerService } from '@univerjs/engine-render';import { SelectionManagerService, SheetInterceptorService } from '@univerjs/sheets';import {@@ -558,6 +558,9 @@ export function clipboardTestBed(workbookConfig?: IWorkbookData, dependencies?:injector.add([IFormulaCurrentConfigService, { useClass: FormulaCurrentConfigService }]);dependencies?.forEach((d) => injector.add(d));++ const localeService = injector.get(LocaleService);+ localeService.load({});}}diff --git a/packages/sheets-ui/src/services/clipboard/clipboard.service.ts b/packages/sheets-ui/src/services/clipboard/clipboard.service.tsindex 6f82db8b90..a453a88c8a 100644--- a/packages/sheets-ui/src/services/clipboard/clipboard.service.ts+++ b/packages/sheets-ui/src/services/clipboard/clipboard.service.ts@@ -411,7 +411,7 @@ export class SheetClipboardService extends Disposable implements ISheetClipboardif (mergeData) {const pastedRangeLapWithMergedCell = mergeData.some((merge) => Rectangle.intersects(pastedRange, merge) && !Rectangle.contains(pastedRange, merge));if (pastedRangeLapWithMergedCell) {- this._errorService.emit('The paste area overlaps with merged cells.');+ this._errorService.emit(this._localeService.t('clipboard.paste.overlappingMergedCells'));return false;}}@@ -477,7 +477,7 @@ export class SheetClipboardService extends Disposable implements ISheetClipboardif (mergeData) {const pastedRangeLapWithMergedCell = mergeData.some((merge) => Rectangle.intersects(pastedRange, merge) && !Rectangle.contains(pastedRange, merge));if (pastedRangeLapWithMergedCell) {- this._errorService.emit('The paste area overlaps with merged cells.');+ this._errorService.emit(this._localeService.t('clipboard.paste.overlappingMergedCells'));return false;}}@@ -827,8 +827,6 @@ export class SheetClipboardService extends Disposable implements ISheetClipboardrange.endRow = startRow + rowCount - 1;range.endColumn = startColumn + colCount - 1;} else if (endRow > mergedRange.endRow || endColumn > mergedRange.endColumn) {- // TODO@Dushusir: use dialog component- // alert("We can't do that to a merged cell ");return null;} else {cellMatrix.forValue((row, col, cell) => {diff --git a/packages/sheets/src/commands/commands/copy-worksheet.command.ts b/packages/sheets/src/commands/commands/copy-worksheet.command.tsindex 6f40be9304..b1cc4d3c63 100644--- a/packages/sheets/src/commands/commands/copy-worksheet.command.ts+++ b/packages/sheets/src/commands/commands/copy-worksheet.command.ts@@ -54,7 +54,7 @@ export const CopySheetCommand: ICommand = {const { workbook, worksheet, unitId } = target;const config = Tools.deepClone(worksheet.getConfig());- config.name += localeService.t('sheets.sheetCopy'); // TODO: 文字国际化+ config.name += localeService.t('sheets.tabs.sheetCopy');config.id = Tools.generateRandomId();const sheetIndex = workbook.getSheetIndex(worksheet);diff --git a/packages/sheets/src/commands/commands/insert-range-move-down.command.ts b/packages/sheets/src/commands/commands/insert-range-move-down.command.tsindex 5807e07b6f..773ca923f4 100644--- a/packages/sheets/src/commands/commands/insert-range-move-down.command.ts+++ b/packages/sheets/src/commands/commands/insert-range-move-down.command.ts@@ -19,10 +19,11 @@ import {BooleanNumber,CommandType,Dimension,+ ErrorService,ICommandService,- ILogService,IUndoRedoService,IUniverInstanceService,+ LocaleService,Range,sequenceExecute,} from '@univerjs/core';@@ -57,13 +58,13 @@ export const InsertRangeMoveDownCommand: ICommand = {const commandService = accessor.get(ICommandService);const undoRedoService = accessor.get(IUndoRedoService);const univerInstanceService = accessor.get(IUniverInstanceService);- const logService = accessor.get(ILogService);const selectionManagerService = accessor.get(SelectionManagerService);const sheetInterceptorService = accessor.get(SheetInterceptorService);+ const errorService = accessor.get(ErrorService);+ const localeService = accessor.get(LocaleService);if (selectionManagerService.isOverlapping()) {- // TODO@Dushusir: use Dialog after Dialog component completed- logService.error('Cannot use that command on overlapping selections.');+ errorService.emit(localeService.t('sheets.info.overlappingSelections'));return false;}diff --git a/packages/sheets/src/commands/commands/insert-range-move-right.command.ts b/packages/sheets/src/commands/commands/insert-range-move-right.command.tsindex af5462a495..ecebad9240 100644--- a/packages/sheets/src/commands/commands/insert-range-move-right.command.ts+++ b/packages/sheets/src/commands/commands/insert-range-move-right.command.ts@@ -19,10 +19,11 @@ import {BooleanNumber,CommandType,Dimension,+ ErrorService,ICommandService,- ILogService,IUndoRedoService,IUniverInstanceService,+ LocaleService,Range,sequenceExecute,} from '@univerjs/core';@@ -56,13 +57,13 @@ export const InsertRangeMoveRightCommand: ICommand = {const commandService = accessor.get(ICommandService);const undoRedoService = accessor.get(IUndoRedoService);const univerInstanceService = accessor.get(IUniverInstanceService);- const logService = accessor.get(ILogService);const selectionManagerService = accessor.get(SelectionManagerService);const sheetInterceptorService = accessor.get(SheetInterceptorService);+ const errorService = accessor.get(ErrorService);+ const localeService = accessor.get(LocaleService);if (selectionManagerService.isOverlapping()) {- // TODO@Dushusir: use Dialog after Dialog component completed- logService.error('Cannot use that command on overlapping selections.');+ errorService.emit(localeService.t('sheets.info.overlappingSelections'));return false;}diff --git a/packages/sheets/src/commands/commands/insert-sheet.command.ts b/packages/sheets/src/commands/commands/insert-sheet.command.tsindex ec4935a7a3..8a1da12ca8 100644--- a/packages/sheets/src/commands/commands/insert-sheet.command.ts+++ b/packages/sheets/src/commands/commands/insert-sheet.command.ts@@ -64,11 +64,11 @@ export const InsertSheetCommand: ICommand = {sheetConfig = params.sheet;} else {sheetConfig.id = Tools.generateRandomId();- sheetConfig.name = workbook.generateNewSheetName(`${localeService.t('sheets.sheet')}`);+ sheetConfig.name = workbook.generateNewSheetName(`${localeService.t('sheets.tabs.sheet')}`);}} else {sheetConfig.id = Tools.generateRandomId();- sheetConfig.name = workbook.generateNewSheetName(`${localeService.t('sheets.sheet')}`);+ sheetConfig.name = workbook.generateNewSheetName(`${localeService.t('sheets.tabs.sheet')}`);}// prepare do mutationsdiff --git a/packages/sheets/src/commands/commands/move-range.command.ts b/packages/sheets/src/commands/commands/move-range.command.tsindex 9e1e4448bf..f782cb459c 100644--- a/packages/sheets/src/commands/commands/move-range.command.ts+++ b/packages/sheets/src/commands/commands/move-range.command.ts@@ -22,6 +22,7 @@ import {ICommandService,IUndoRedoService,IUniverInstanceService,+ LocaleService,ObjectMatrix,Range,Rectangle,@@ -51,6 +52,7 @@ export const MoveRangeCommand: ICommand = {const undoRedoService = accessor.get(IUndoRedoService);const univerInstanceService = accessor.get(IUniverInstanceService);const errorService = accessor.get(ErrorService);+ const localeService = accessor.get(LocaleService);const target = getSheetCommandTarget(univerInstanceService);if (!target) return false;@@ -62,7 +64,7 @@ export const MoveRangeCommand: ICommand = {{ unitId, subUnitId, range: params.toRange });if (moveRangeMutations === null) {- errorService.emit('Across a merged cell.');+ errorService.emit(localeService.t('sheets.info.acrossMergedCell'));return false;}diff --git a/packages/sheets/src/commands/commands/move-rows-cols.command.ts b/packages/sheets/src/commands/commands/move-rows-cols.command.tsindex 3080c709ff..893be78d2f 100644--- a/packages/sheets/src/commands/commands/move-rows-cols.command.ts+++ b/packages/sheets/src/commands/commands/move-rows-cols.command.ts@@ -21,6 +21,7 @@ import {ICommandService,IUndoRedoService,IUniverInstanceService,+ LocaleService,RANGE_TYPE,Rectangle,sequenceExecute,@@ -86,17 +87,18 @@ export const MoveRowsCommand: ICommand<IMoveRowsCommandParams> = {const subUnitId = worksheet.getSheetId();const errorService = accessor.get(ErrorService);+ const localeService = accessor.get(LocaleService);// Forbid action when some parts of a merged cell are selected.const rangeToMove = filteredSelections[0].range;const beforePrimary = filteredSelections[0].primary;const alignedRange = alignToMergedCellsBorders(rangeToMove, worksheet, false);if (!Rectangle.equals(rangeToMove, alignedRange)) {- errorService.emit('Only part of a merged cell is selected.');+ errorService.emit(localeService.t('sheets.info.partOfCell'));return false;}if (rowAcrossMergedCell(toRow, worksheet)) {- errorService.emit('Across a merged cell.');+ errorService.emit(localeService.t('sheets.info.acrossMergedCell'));return false;}@@ -215,17 +217,18 @@ export const MoveColsCommand: ICommand<IMoveColsCommandParams> = {const subUnitId = worksheet.getSheetId();const errorService = accessor.get(ErrorService);+ const localeService = accessor.get(LocaleService);// Forbid action when some parts of a merged cell are selected.const rangeToMove = filteredSelections[0].range;const beforePrimary = filteredSelections[0].primary;const alignedRange = alignToMergedCellsBorders(rangeToMove, worksheet, false);if (!Rectangle.equals(rangeToMove, alignedRange)) {- errorService.emit('Only part of a merged cell is selected.');+ errorService.emit(localeService.t('sheets.info.partOfCell'));return false;}if (columnAcrossMergedCell(toCol, worksheet)) {- errorService.emit('Across a merged cell.');+ errorService.emit(localeService.t('sheets.info.acrossMergedCell'));return false;}diff --git a/packages/sheets/src/commands/commands/set-worksheet-hide.command.ts b/packages/sheets/src/commands/commands/set-worksheet-hide.command.tsindex 7fa43bd5a2..945302ed6e 100644--- a/packages/sheets/src/commands/commands/set-worksheet-hide.command.ts+++ b/packages/sheets/src/commands/commands/set-worksheet-hide.command.ts@@ -22,6 +22,7 @@ import {ICommandService,IUndoRedoService,IUniverInstanceService,+ LocaleService,} from '@univerjs/core';import type { IAccessor } from '@wendellhu/redi';@@ -41,6 +42,7 @@ export const SetWorksheetHideCommand: ICommand = {const commandService = accessor.get(ICommandService);const undoRedoService = accessor.get(IUndoRedoService);const errorService = accessor.get(ErrorService);+ const localeService = accessor.get(LocaleService);const target = getSheetCommandTarget(accessor.get(IUniverInstanceService), params);if (!target) return false;@@ -60,7 +62,7 @@ export const SetWorksheetHideCommand: ICommand = {const worksheets = workbook.getSheets();const visibleWorksheets = worksheets.filter((sheet) => sheet.getConfig().hidden === BooleanNumber.FALSE);if (visibleWorksheets.length === 1) {- errorService.emit('No visible sheet after you hide this.');+ errorService.emit(localeService.t('sheets.info.hideSheet'));return false;}diff --git a/packages/sheets/src/locale/en-US.ts b/packages/sheets/src/locale/en-US.tsindex 1ad276f404..7eb06fb9da 100644--- a/packages/sheets/src/locale/en-US.ts+++ b/packages/sheets/src/locale/en-US.ts@@ -18,8 +18,16 @@ import type zhCN from './zh-CN';const locale: typeof zhCN = {sheets: {- sheetCopy: '(Copy)',- sheet: 'Sheet',+ tabs: {+ sheetCopy: '(Copy)',+ sheet: 'Sheet',+ },+ info: {+ overlappingSelections: 'Cannot use that command on overlapping selections',+ acrossMergedCell: 'Across a merged cell',+ partOfCell: 'Only part of a merged cell is selected',+ hideSheet: 'No visible sheet after you hide this',+ },},};diff --git a/packages/sheets/src/locale/zh-CN.ts b/packages/sheets/src/locale/zh-CN.tsindex 7ec38492fa..213c9176b2 100644--- a/packages/sheets/src/locale/zh-CN.ts+++ b/packages/sheets/src/locale/zh-CN.ts@@ -16,8 +16,16 @@const locale = {sheets: {- sheetCopy: '(副本)',- sheet: '工作表',+ tabs: {+ sheetCopy: '(副本)',+ sheet: '工作表',+ },+ info: {+ overlappingSelections: '无法对重叠选区使用该命令',+ acrossMergedCell: '无法跨越合并单元格',+ partOfCell: '仅选择了合并单元格的一部分',+ hideSheet: '隐藏后无可见工作表',+ },},};