Skip to content

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.

feat(facade): add merge facade api (#3289)

ybzkyacd03e447d1e
diff --git a/packages/facade/src/apis/sheets/__tests__/f-range.spec.ts b/packages/facade/src/apis/sheets/__tests__/f-range.spec.ts
index cdc6e62e11..75e452f1e6 100644
--- a/packages/facade/src/apis/sheets/__tests__/f-range.spec.ts
+++ b/packages/facade/src/apis/sheets/__tests__/f-range.spec.ts
@@ -621,4 +621,34 @@ describe('Test FRange', () => {
});
// #endregion
+
+ // #region Merge cells
+ it('test Merge', async () => {
+ let hasError = false;
+ try {
+ const activeSheet = univerAPI.getActiveWorkbook()?.getActiveSheet()!;
+ let range = activeSheet.getRange(0, 2, 0, 2);
+ expect(activeSheet.getMergedRanges().length).toBe(0);
+ range = await range.merge();
+ expect(activeSheet.getMergedRanges().length).toBe(1);
+ range = range.breakApart();
+ expect(activeSheet.getMergedRanges().length).toBe(0);
+ range = await range.mergeAcross();
+ expect(activeSheet.getMergedRanges().length).toBe(3);
+ expect(activeSheet.getMergedRanges()[0].getRange()).toStrictEqual({ startRow: 0, endRow: 0, startColumn: 0, endColumn: 2 });
+ range = range.breakApart();
+ expect(activeSheet.getMergedRanges().length).toBe(0);
+ await range.mergeVertically();
+ expect(activeSheet.getMergedRanges().length).toBe(3);
+ expect(activeSheet.getMergedRanges()[0].getRange()).toStrictEqual({ startRow: 0, endRow: 2, startColumn: 0, endColumn: 0 });
+ const range2 = activeSheet.getRange(0, 2, 0, 0);
+ expect(range2.isPartOfMerge()).toBeTruthy();
+ const range3 = activeSheet.getRange(0, 5, 0, 5);
+ await range3.merge();
+ } catch (error) {
+ hasError = true;
+ }
+ expect(hasError).toBeTruthy();
+ });
+ //#endregion
});
diff --git a/packages/facade/src/apis/sheets/__tests__/f-worksheet.spec.ts b/packages/facade/src/apis/sheets/__tests__/f-worksheet.spec.ts
index 71a8d3f6e3..ca0c5296bc 100644
--- a/packages/facade/src/apis/sheets/__tests__/f-worksheet.spec.ts
+++ b/packages/facade/src/apis/sheets/__tests__/f-worksheet.spec.ts
@@ -16,7 +16,7 @@
import type { ICellData, Injector, IStyleData, Nullable, Workbook } from '@univerjs/core';
import { ICommandService, IUniverInstanceService, RANGE_TYPE, UniverInstanceType } from '@univerjs/core';
-import { InsertColCommand, InsertColMutation, InsertRowCommand, InsertRowMutation, MoveColsCommand, MoveColsMutation, MoveRowsCommand, MoveRowsMutation, RemoveColCommand, RemoveColMutation, RemoveRowCommand, RemoveRowMutation, SetColHiddenCommand, SetColHiddenMutation, SetColVisibleMutation, SetColWidthCommand, SetHorizontalTextAlignCommand, SetRangeValuesCommand, SetRangeValuesMutation, SetRowHeightCommand, SetRowHiddenCommand, SetRowHiddenMutation, SetRowVisibleMutation, SetSelectionsOperation, SetSpecificColsVisibleCommand, SetSpecificRowsVisibleCommand, SetStyleCommand, SetTextWrapCommand, SetVerticalTextAlignCommand, SetWorksheetColWidthMutation, SetWorksheetRowHeightMutation, SetWorksheetRowIsAutoHeightCommand, SetWorksheetRowIsAutoHeightMutation, SheetsSelectionsService } from '@univerjs/sheets';
+import { AddWorksheetMergeCommand, AddWorksheetMergeMutation, InsertColCommand, InsertColMutation, InsertRowCommand, InsertRowMutation, MoveColsCommand, MoveColsMutation, MoveRowsCommand, MoveRowsMutation, RemoveColCommand, RemoveColMutation, RemoveRowCommand, RemoveRowMutation, RemoveWorksheetMergeCommand, RemoveWorksheetMergeMutation, SetColHiddenCommand, SetColHiddenMutation, SetColVisibleMutation, SetColWidthCommand, SetHorizontalTextAlignCommand, SetRangeValuesCommand, SetRangeValuesMutation, SetRowHeightCommand, SetRowHiddenCommand, SetRowHiddenMutation, SetRowVisibleMutation, SetSelectionsOperation, SetSpecificColsVisibleCommand, SetSpecificRowsVisibleCommand, SetStyleCommand, SetTextWrapCommand, SetVerticalTextAlignCommand, SetWorksheetColWidthMutation, SetWorksheetRowHeightMutation, SetWorksheetRowIsAutoHeightCommand, SetWorksheetRowIsAutoHeightMutation, SheetsSelectionsService } from '@univerjs/sheets';
import { beforeEach, describe, expect, it } from 'vitest';
import type { FUniver } from '../../facade';
@@ -84,6 +84,12 @@ describe('Test FWorksheet', () => {
commandService.registerCommand(SetColWidthCommand);
commandService.registerCommand(SetWorksheetColWidthMutation);
+ // merge cells
+ commandService.registerCommand(AddWorksheetMergeCommand);
+ commandService.registerCommand(AddWorksheetMergeMutation);
+ commandService.registerCommand(RemoveWorksheetMergeCommand);
+ commandService.registerCommand(RemoveWorksheetMergeMutation);
+
getValueByPosition = (
startRow: number,
startColumn: number,
diff --git a/packages/facade/src/apis/sheets/f-range.ts b/packages/facade/src/apis/sheets/f-range.ts
index a1804acd2e..1cd9016c79 100644
--- a/packages/facade/src/apis/sheets/f-range.ts
+++ b/packages/facade/src/apis/sheets/f-range.ts
@@ -30,7 +30,7 @@ import type {
Workbook,
Worksheet,
} from '@univerjs/core';
-import { BooleanNumber, ICommandService, Inject, Injector, Tools, UserManagerService, WrapStrategy } from '@univerjs/core';
+import { BooleanNumber, Dimension, ICommandService, Inject, Injector, Rectangle, Tools, UserManagerService, WrapStrategy } from '@univerjs/core';
import type {
ISetHorizontalTextAlignCommandParams,
ISetStyleCommandParams,
@@ -39,6 +39,9 @@ import type {
IStyleTypeValue,
} from '@univerjs/sheets';
import {
+ addMergeCellsUtil,
+ getAddMergeMutationRangeByType,
+ RemoveWorksheetMergeCommand,
SetHorizontalTextAlignCommand,
SetRangeValuesCommand,
SetStyleCommand,
@@ -829,4 +832,66 @@ export class FRange {
return Promise.resolve(true);
}
+
+ //#region Merge cell
+
+ /**
+ * Merge cells in a range into one merged cell
+ * @returns This range, for chaining
+ */
+ async merge(): Promise<FRange> {
+ const unitId = this._workbook.getUnitId();
+ const subUnitId = this._worksheet.getSheetId();
+
+ await addMergeCellsUtil(this._injector, unitId, subUnitId, [this._range]);
+
+ return this;
+ }
+
+ /**
+ * Merges cells in a range horizontally.
+ * @returns This range, for chaining
+ */
+ async mergeAcross(): Promise<FRange> {
+ const ranges = getAddMergeMutationRangeByType([this._range], Dimension.ROWS);
+ const unitId = this._workbook.getUnitId();
+ const subUnitId = this._worksheet.getSheetId();
+
+ await addMergeCellsUtil(this._injector, unitId, subUnitId, ranges);
+
+ return this;
+ }
+
+ /**
+ * Merges cells in a range vertically.
+ * @returns This range, for chaining
+ */
+ async mergeVertically(): Promise<FRange> {
+ const ranges = getAddMergeMutationRangeByType([this._range], Dimension.COLUMNS);
+ const unitId = this._workbook.getUnitId();
+ const subUnitId = this._worksheet.getSheetId();
+
+ await addMergeCellsUtil(this._injector, unitId, subUnitId, ranges);
+
+ return this;
+ }
+
+ /**
+ * Returns true if cells in the current range overlap a merged cell.
+ * @returns {boolean} is overlap with a merged cell
+ */
+ isPartOfMerge(): boolean {
+ const mergeData = this._worksheet.getMergeData();
+ return mergeData.some((merge) => Rectangle.intersects(this._range, merge));
+ }
+
+ /**
+ * Unmerge cells in the range
+ * @returns This range, for chaining
+ */
+ breakApart(): FRange {
+ this._commandService.executeCommand(RemoveWorksheetMergeCommand.id, { ranges: [this._range] });
+ return this;
+ }
+ //#endregion
}
diff --git a/packages/facade/src/apis/sheets/f-worksheet.ts b/packages/facade/src/apis/sheets/f-worksheet.ts
index 4f3c5eae19..5f4fb471b8 100644
--- a/packages/facade/src/apis/sheets/f-worksheet.ts
+++ b/packages/facade/src/apis/sheets/f-worksheet.ts
@@ -112,10 +112,10 @@ export class FWorksheet {
return this._worksheet.getMaxRows();
}
- /**
- * get all data validation rules in current sheet
- * @returns all data validation rules
- */
+ /**
+ * get all data validation rules in current sheet
+ * @returns all data validation rules
+ */
getDataValidations(): FDataValidation[] {
const dataValidationModel = this._injector.get(DataValidationModel);
return dataValidationModel.getRules(this._workbook.getUnitId(), this._worksheet.getSheetId()).map((rule) => new FDataValidation(rule));
@@ -823,4 +823,17 @@ export class FWorksheet {
}
// #endregion
+
+ // #region merge cells
+
+ /**
+ * Get all merged cells in the current sheet
+ * @returns all merged cells
+ */
+ getMergedRanges(): FRange[] {
+ const snapshot = this._worksheet.getSnapshot();
+ return snapshot.mergeData.map((merge) => this._injector.createInstance(FRange, this._workbook, this._worksheet, merge));
+ }
+
+ // #endregion
}
diff --git a/packages/sheets/src/commands/commands/add-worksheet-merge.command.ts b/packages/sheets/src/commands/commands/add-worksheet-merge.command.ts
index b1db54bb17..18a7193e51 100644
--- a/packages/sheets/src/commands/commands/add-worksheet-merge.command.ts
+++ b/packages/sheets/src/commands/commands/add-worksheet-merge.command.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { IAccessor, ICellData, ICommand, IMutationInfo, IRange, Nullable, Workbook, Worksheet } from '@univerjs/core';
+import type { IAccessor, ICellData, ICommand, IMutationInfo, Injector, IRange, Nullable, Workbook, Worksheet } from '@univerjs/core';
import {
CommandType,
Dimension,
@@ -22,6 +22,7 @@ import {
IUndoRedoService,
IUniverInstanceService,
ObjectMatrix,
+ Rectangle,
sequenceExecute,
UniverInstanceType,
} from '@univerjs/core';
@@ -39,6 +40,7 @@ import {
} from '../mutations/remove-worksheet-merge.mutation';
import type { ISetRangeValuesMutationParams } from '../mutations/set-range-values.mutation';
import { SetRangeValuesMutation, SetRangeValuesUndoMutationFactory } from '../mutations/set-range-values.mutation';
+import { getSheetCommandTarget } from './utils/target-util';
export interface IAddMergeCommandParams {
value?: Dimension.ROWS | Dimension.COLUMNS;
@@ -262,3 +264,25 @@ export const AddWorksheetMergeHorizontalCommand: ICommand = {
} as IAddMergeCommandParams);
},
};
+
+export async function addMergeCellsUtil(injector: Injector, unitId: string, subUnitId: string, ranges: IRange[]) {
+ const univerInstanceService = injector.get(IUniverInstanceService);
+ const target = getSheetCommandTarget(univerInstanceService, { unitId, subUnitId });
+ if (!target) return;
+ const { worksheet } = target;
+ const mergeData = worksheet.getMergeData();
+ const overlap = mergeData.some((mergeRange) => {
+ return ranges.some((range) => {
+ return Rectangle.intersects(range, mergeRange);
+ });
+ });
+ if (overlap) {
+ throw new Error('The ranges to be merged overlap with the existing merged cells');
+ }
+ const commandService = injector.get(ICommandService);
+ await commandService.executeCommand(AddWorksheetMergeCommand.id, {
+ unitId,
+ subUnitId,
+ selections: ranges,
+ });
+}
diff --git a/packages/sheets/src/commands/commands/remove-worksheet-merge.command.ts b/packages/sheets/src/commands/commands/remove-worksheet-merge.command.ts
index e151ced9f7..8f20117cba 100644
--- a/packages/sheets/src/commands/commands/remove-worksheet-merge.command.ts
+++ b/packages/sheets/src/commands/commands/remove-worksheet-merge.command.ts
@@ -32,17 +32,21 @@ import type { ISetRangeValuesMutationParams } from '../mutations/set-range-value
import { SetRangeValuesMutation } from '../mutations/set-range-values.mutation';
import { getSheetCommandTarget } from './utils/target-util';
+interface IRemoveWorksheetMergeCommandParams {
+ ranges?: IRange[];
+}
+
export const RemoveWorksheetMergeCommand: ICommand = {
type: CommandType.COMMAND,
id: 'sheet.command.remove-worksheet-merge',
// eslint-disable-next-line max-lines-per-function
- handler: async (accessor: IAccessor) => {
+ handler: async (accessor: IAccessor, params: IRemoveWorksheetMergeCommandParams) => {
const selectionManagerService = accessor.get(SheetsSelectionsService);
const commandService = accessor.get(ICommandService);
const undoRedoService = accessor.get(IUndoRedoService);
const univerInstanceService = accessor.get(IUniverInstanceService);
- const selections = selectionManagerService.getCurrentSelections()?.map((s) => s.range);
+ const selections = params?.ranges || selectionManagerService.getCurrentSelections()?.map((s) => s.range);
if (!selections?.length) return false;
const target = getSheetCommandTarget(univerInstanceService);
diff --git a/packages/sheets/src/index.ts b/packages/sheets/src/index.ts
index ed3cd7adb1..0bab067d31 100644
--- a/packages/sheets/src/index.ts
+++ b/packages/sheets/src/index.ts
@@ -180,6 +180,7 @@ export {
AddWorksheetMergeAllCommand,
AddWorksheetMergeVerticalCommand,
AddWorksheetMergeHorizontalCommand,
+ addMergeCellsUtil,
} from './commands/commands/add-worksheet-merge.command';
export { ClearSelectionAllCommand } from './commands/commands/clear-selection-all.command';
export { ClearSelectionContentCommand } from './commands/commands/clear-selection-content.command';