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): click to get cell information, whether to merge and coordinates (#2362)

小马同学1300ebcbd47b
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 e5da2eaea7..1ddec1acdc 100644
--- a/packages/facade/src/apis/sheets/__tests__/f-range.spec.ts
+++ b/packages/facade/src/apis/sheets/__tests__/f-range.spec.ts
@@ -184,6 +184,37 @@ describe('Test FRange', () => {
expect(range?.getCellData()?.v).toBe(1);
});
+ it('Range getCell', () => {
+ const activeSheet = univerAPI.getActiveWorkbook()!.getActiveSheet();
+ const range = activeSheet?.getRange(2, 3);
+ const cell = range?.getCell()!;
+ expect(cell.actualColumn).toBe(3);
+ expect(cell.actualRow).toBe(2);
+ });
+
+ it('Range getCellRect', () => {
+ const activeSheet = univerAPI.getActiveWorkbook()!.getActiveSheet();
+ const range = activeSheet?.getRange(0, 0);
+ const cell = range?.getCell()!;
+ const rect = range?.getCellRect()!;
+ expect(rect.x).toBe(cell.startX);
+ expect(rect.y).toBe(cell.startY);
+ expect(rect.width).toBe(cell.endX - cell.startX);
+ expect(rect.height).toBe(cell.endY - cell.startY);
+ expect(rect.toJSON()).toContain(rect.height);
+ });
+
+ it('Range isMerged', () => {
+ const activeSheet = univerAPI.getActiveWorkbook()!.getActiveSheet()!;
+ const range = activeSheet!.getRange(2, 3);
+ const isMerged = range?.isMerged()!;
+ expect(isMerged).toBe(false);
+
+ const range2 = activeSheet!.getRange(2, 3, 3, 3)!;
+ const isMerged2 = range2.isMerged()!;
+ expect(isMerged2).toBe(false);
+ });
+
it('Range getCellStyleData', () => {
const activeSheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
activeSheet?.getRange(0, 0)?.setValue(1);
diff --git a/packages/facade/src/apis/sheets/f-range.ts b/packages/facade/src/apis/sheets/f-range.ts
index 6d8b597b26..1f38d592d9 100644
--- a/packages/facade/src/apis/sheets/f-range.ts
+++ b/packages/facade/src/apis/sheets/f-range.ts
@@ -19,7 +19,7 @@ import type {
ICellData,
IColorStyle,
IObjectMatrixPrimitiveType,
- IRange,
+ IRange, ISelectionCellWithCoord,
IStyleData,
ITextDecoration,
Workbook,
@@ -45,11 +45,11 @@ import { SetNumfmtCommand } from '@univerjs/sheets-numfmt';
import { FormulaDataModel } from '@univerjs/engine-formula';
import { Inject, Injector } from '@wendellhu/redi';
-import { ISheetClipboardService } from '@univerjs/sheets-ui';
+import { ISheetClipboardService, SheetSkeletonManagerService } from '@univerjs/sheets-ui';
import type { FHorizontalAlignment, FVerticalAlignment } from './utils';
-import {
- covertCellValue,
+import { covertCellValue,
covertCellValues,
+ isCellMerged,
transformCoreHorizontalAlignment,
transformCoreVerticalAlignment,
transformFacadeHorizontalAlignment,
@@ -67,7 +67,8 @@ export class FRange {
private readonly _range: IRange,
@Inject(Injector) private readonly _injector: Injector,
@ICommandService private readonly _commandService: ICommandService,
- @Inject(FormulaDataModel) private readonly _formulaDataModel: FormulaDataModel
+ @Inject(FormulaDataModel) private readonly _formulaDataModel: FormulaDataModel,
+ @Inject(SheetSkeletonManagerService) private _sheetSkeletonManagerService: SheetSkeletonManagerService
) {
// empty
}
@@ -96,6 +97,33 @@ export class FRange {
return this._worksheet.getCell(this._range.startRow, this._range.startColumn) ?? null;
}
+ /**
+ * Return this cell information, including whether it is merged and cell coordinates
+ * @returns The cell information
+ */
+ getCell(): ISelectionCellWithCoord {
+ const { skeleton } = this._sheetSkeletonManagerService.getUnitSkeleton(this._workbook.getUnitId(), this._worksheet.getSheetId())!;
+ return skeleton.getCellByIndex(this._range.startRow, this._range.startColumn);
+ }
+
+ /**
+ * Return range whether this range is merged
+ * @returns if true is merged
+ */
+ isMerged() {
+ return isCellMerged(this.getCell().mergeInfo, this._range);
+ }
+
+ /**
+ * Returns the coordinates of this cell,does not include units
+ * @returns coordinates of the cell, top, right, bottom, left
+ */
+ getCellRect(): DOMRect {
+ const { startX: x, startY: y, endX: x2, endY: y2 } = this.getCell();
+ const data = { x, y, width: x2 - x, height: y2 - y, top: y, left: x, bottom: y2, right: x2 };
+ return { ...data, toJSON: () => JSON.stringify(data) };
+ }
+
/**
* Return first cell style data in this range
* @returns The cell style data
diff --git a/packages/facade/src/apis/sheets/utils.ts b/packages/facade/src/apis/sheets/utils.ts
index a250c196a1..7f83c1aabb 100644
--- a/packages/facade/src/apis/sheets/utils.ts
+++ b/packages/facade/src/apis/sheets/utils.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { CellValue, ICellData, IObjectMatrixPrimitiveType, IRange, Nullable } from '@univerjs/core';
+import type { CellValue, ICellData, IObjectMatrixPrimitiveType, IRange, IRangeWithCoord, Nullable } from '@univerjs/core';
import {
HorizontalAlign,
isCellV,
@@ -136,3 +136,17 @@ export function covertCellValues(
return cellValue.getMatrix();
}
+
+export function isCellMerged(mergeInfo: IRangeWithCoord, range: IRange) {
+ if (!isSingleCell(mergeInfo, range)) {
+ return false;
+ }
+ return range.startColumn !== range.endColumn || range.startRow !== range.endRow;
+}
+
+export function isSingleCell(mergeInfo: IRangeWithCoord, range: IRange) {
+ return mergeInfo.startColumn === range.startColumn
+ && mergeInfo.endColumn === range.endColumn
+ && mergeInfo.startRow === range.startRow
+ && mergeInfo.endRow === range.endRow;
+}