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.

fix(sheets-drawing-ui): query runtime float doms (#7892)

wpxp12345659ad0caeb719
diff --git a/packages/sheets-drawing-ui/src/facade/__tests__/f-worksheet.spec.ts b/packages/sheets-drawing-ui/src/facade/__tests__/f-worksheet.spec.ts
index 82481221e2..f835a99279 100644
--- a/packages/sheets-drawing-ui/src/facade/__tests__/f-worksheet.spec.ts
+++ b/packages/sheets-drawing-ui/src/facade/__tests__/f-worksheet.spec.ts
@@ -48,18 +48,18 @@ import {
SetSheetDrawingCommand,
UniverSheetsDrawingPlugin,
} from '@univerjs/sheets-drawing';
-import {
- BatchSaveImagesService,
- IBatchSaveImagesService,
- SheetCanvasFloatDomManagerService,
-} from '@univerjs/sheets-drawing-ui';
import { ISheetSelectionRenderService, SheetSkeletonManagerService } from '@univerjs/sheets-ui';
import sheetsEnUS from '@univerjs/sheets/locale/en-US';
import { CanvasFloatDomService, ComponentManager } from '@univerjs/ui';
import { BehaviorSubject, Subject } from 'rxjs';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+import { BatchSaveImagesService, IBatchSaveImagesService } from '../../services/batch-save-images.service';
+import { SheetCanvasFloatDomManagerService } from '../../services/canvas-float-dom-manager.service';
import '@univerjs/sheets/facade';
-import '@univerjs/sheets-drawing-ui/facade';
+import '../f-event';
+import '../f-range';
+import '../f-univer';
+import '../f-worksheet';
const TEST_WORKBOOK_DATA: IWorkbookData = {
id: 'test',
@@ -533,6 +533,108 @@ describe('sheets-drawing-ui facade', () => {
expect(worksheet.getAllFloatDoms()).toEqual([]);
});
+ it('reads and removes range and column header float doms without persisting drawings', () => {
+ univer.dispose();
+ const testBed = createDrawingUITestBedWithRender();
+ univer = testBed.univer;
+ injector = testBed.injector;
+ univerAPI = FUniver.newAPI(injector);
+
+ const worksheet = univerAPI.getActiveWorkbook()!.getActiveSheet();
+ const sheetDrawingService = injector.get(ISheetDrawingService);
+ const rangeDom = worksheet.addFloatDomToRange(worksheet.getRange(1, 1, 1, 1), {
+ componentKey: 'RangeLoading',
+ data: { label: 'Loading range' },
+ allowTransform: false,
+ }, {})!;
+ const headerDom = worksheet.addFloatDomToColumnHeader(2, {
+ componentKey: 'HeaderAction',
+ data: { column: 2 },
+ }, { width: 80, height: 24, marginX: 0, marginY: 0 })!;
+
+ const expectedRange = expect.objectContaining({
+ id: rangeDom.id,
+ componentKey: 'RangeLoading',
+ data: { label: 'Loading range' },
+ allowTransform: false,
+ position: expect.objectContaining({
+ width: worksheet.getColumnWidth(1),
+ height: worksheet.getRowHeight(1),
+ }),
+ });
+ const expectedHeader = expect.objectContaining({
+ id: headerDom.id,
+ componentKey: 'HeaderAction',
+ data: { column: 2 },
+ allowTransform: true,
+ position: expect.objectContaining({ width: 80, height: 24 }),
+ });
+
+ expect(worksheet.getFloatDomById(rangeDom.id)).toEqual(expectedRange);
+ expect(worksheet.getFloatDomById(headerDom.id)).toEqual(expectedHeader);
+ expect(worksheet.getAllFloatDoms()).toEqual([expectedRange, expectedHeader]);
+ expect(sheetDrawingService.getDrawingByParam({
+ unitId: 'test',
+ subUnitId: 'sheet1',
+ drawingId: rangeDom.id,
+ })).toBeUndefined();
+ expect(sheetDrawingService.getDrawingByParam({
+ unitId: 'test',
+ subUnitId: 'sheet1',
+ drawingId: headerDom.id,
+ })).toBeUndefined();
+
+ rangeDom.dispose();
+ expect(worksheet.getFloatDomById(rangeDom.id)).toBeNull();
+ expect(worksheet.getAllFloatDoms()).toEqual([expectedHeader]);
+ worksheet.removeFloatDom(headerDom.id);
+ expect(worksheet.getFloatDomById(headerDom.id)).toBeNull();
+ expect(worksheet.getAllFloatDoms()).toEqual([]);
+ });
+
+ it('reads mixed float dom sources and current drawing attributes', async () => {
+ univer.dispose();
+ const testBed = createDrawingUITestBedWithRender();
+ univer = testBed.univer;
+ injector = testBed.injector;
+ univerAPI = FUniver.newAPI(injector);
+
+ const worksheet = univerAPI.getActiveWorkbook()!.getActiveSheet();
+ const positionDom = worksheet.addFloatDomToPosition({
+ componentKey: 'OrderCard',
+ initPosition: { startX: 20, startY: 30, endX: 140, endY: 90 },
+ data: { label: 'Draft' },
+ })!;
+ await Promise.resolve();
+
+ const rangeDom = worksheet.addFloatDomToRange(worksheet.getRange('A1:B2'), {
+ componentKey: 'RangeLoading',
+ }, {})!;
+ const headerDom = worksheet.addFloatDomToColumnHeader(2, {
+ componentKey: 'HeaderAction',
+ allowTransform: false,
+ }, { width: 80, height: 24, marginX: 0, marginY: 0 })!;
+
+ worksheet.updateFloatDom(positionDom.id, {
+ componentKey: 'ApprovedOrderCard',
+ data: { label: 'Approved' },
+ allowTransform: false,
+ });
+
+ const allDoms = worksheet.getAllFloatDoms();
+ expect(allDoms.map((dom) => dom.id)).toEqual([positionDom.id, rangeDom.id, headerDom.id]);
+ for (const dom of allDoms) {
+ expect(worksheet.getFloatDomById(dom.id)).toEqual(dom);
+ }
+ expect(allDoms[0]).toEqual(expect.objectContaining({
+ componentKey: 'ApprovedOrderCard',
+ data: { label: 'Approved' },
+ allowTransform: false,
+ }));
+ expect(allDoms[1]).toEqual(expect.objectContaining({ componentKey: 'RangeLoading', allowTransform: true }));
+ expect(allDoms[2]).toEqual(expect.objectContaining({ componentKey: 'HeaderAction', allowTransform: false }));
+ });
+
it('omits float doms without backing drawing params', async () => {
univer.dispose();
const testBed = createDrawingUITestBedWithRender();
@@ -556,6 +658,7 @@ describe('sheets-drawing-ui facade', () => {
delete drawingData['missing-card'];
expect(sheetDrawingService.getDrawingByParam({ unitId: 'test', subUnitId: 'sheet1', drawingId: 'missing-card' })).toBeUndefined();
+ expect(worksheet.getFloatDomById('missing-card')).toBeNull();
expect(worksheet.getAllFloatDoms().map((dom) => dom.id)).toEqual(['order-card']);
});
diff --git a/packages/sheets-drawing-ui/src/facade/f-worksheet.ts b/packages/sheets-drawing-ui/src/facade/f-worksheet.ts
index b96ef13ebb..b2f12d5aa4 100644
--- a/packages/sheets-drawing-ui/src/facade/f-worksheet.ts
+++ b/packages/sheets-drawing-ui/src/facade/f-worksheet.ts
@@ -21,7 +21,12 @@ import type { IFComponentKey } from '@univerjs/sheets-ui/facade';
import type { FRange } from '@univerjs/sheets/facade';
import type { ISaveCellImagesOptions } from './f-range';
import { SheetSkeletonService } from '@univerjs/sheets';
-import { ISheetDrawingService, SetSheetDrawingCommand, transformToAxisAlignPosition, transformToDrawingPosition } from '@univerjs/sheets-drawing';
+import {
+ ISheetDrawingService,
+ SetSheetDrawingCommand,
+ transformToAxisAlignPosition,
+ transformToDrawingPosition,
+} from '@univerjs/sheets-drawing';
import { FileNamePart, IBatchSaveImagesService, SheetCanvasFloatDomManagerService } from '@univerjs/sheets-drawing-ui';
import { transformComponentKey } from '@univerjs/sheets-ui/facade';
import { FWorksheet } from '@univerjs/sheets/facade';
@@ -424,19 +429,31 @@ export class FWorksheetDrawingUIMixin extends FWorksheet implements IFWorksheetD
override getFloatDomById(id: string): Nullable<IFCanvasFloatDomResult> {
const floatDomService = this._injector.get(SheetCanvasFloatDomManagerService);
const info = floatDomService.getFloatDomInfo(id);
- if (!info) return null;
+ return info ? this._getFloatDomResult(info) : null;
+ }
- const { unitId, subUnitId } = info;
- const { rect } = info;
- const state = rect.getState();
- const { left = 0, top = 0, width = 0, height = 0, flipX = false, flipY = false, angle = 0, skewX = 0, skewY = 0 } = state;
- const drawingParm = this._injector.get(ISheetDrawingService).getDrawingByParam({
- drawingId: info.id,
+ override getAllFloatDoms(): IFCanvasFloatDomResult[] {
+ const floatDomService = this._injector.get(SheetCanvasFloatDomManagerService);
+ const unitId = this._workbook.getUnitId();
+ const subUnitId = this._worksheet.getSheetId();
+
+ return floatDomService.getFloatDomsBySubUnitId(unitId, subUnitId)
+ .map((info) => this._getFloatDomResult(info))
+ .filter((dom): dom is IFCanvasFloatDomResult => dom != null);
+ }
+
+ private _getFloatDomResult(info: ICanvasFloatDomInfo): Nullable<IFCanvasFloatDomResult> {
+ const { unitId, subUnitId, id, rect, runtimeMetadata } = info;
+ const metadata = runtimeMetadata ?? (this._injector.get(ISheetDrawingService).getDrawingByParam({
+ drawingId: id,
unitId,
subUnitId,
- })! as ISheetFloatDom;
+ }) as ISheetFloatDom | undefined);
+ if (!metadata) {
+ return null;
+ }
- if (!drawingParm) return null;
+ const { left = 0, top = 0, width = 0, height = 0, flipX = false, flipY = false, angle = 0, skewX = 0, skewY = 0 } = rect.getState();
return {
position: {
@@ -450,52 +467,13 @@ export class FWorksheetDrawingUIMixin extends FWorksheet implements IFWorksheetD
skewX,
skewY,
},
- componentKey: drawingParm.componentKey,
- allowTransform: drawingParm.allowTransform,
- data: drawingParm.data,
- id: info.id,
+ componentKey: metadata.componentKey,
+ allowTransform: metadata.allowTransform,
+ data: metadata.data,
+ id,
};
}
- override getAllFloatDoms(): IFCanvasFloatDomResult[] {
- const floatDomService = this._injector.get(SheetCanvasFloatDomManagerService);
- const unitId = this._workbook.getUnitId();
- const subUnitId = this._worksheet.getSheetId();
-
- return Array.from(floatDomService.getFloatDomsBySubUnitId(unitId, subUnitId).values())
- .map((info): IFCanvasFloatDomResult | null => {
- const { rect } = info;
- const drawingParm = this._injector.get(ISheetDrawingService).getDrawingByParam({
- drawingId: info.id,
- unitId,
- subUnitId,
- })! as ISheetFloatDom;
-
- if (!drawingParm) return null;
-
- const { left, top, width, height, flipX, flipY, angle, skewX, skewY } = rect.getState();
-
- return {
- position: {
- left,
- top,
- width,
- height,
- flipX,
- flipY,
- angle,
- skewX,
- skewY,
- },
- componentKey: drawingParm.componentKey,
- allowTransform: drawingParm.allowTransform,
- data: drawingParm.data,
- id: info.id,
- };
- })
- .filter((dom): dom is IFCanvasFloatDomResult => dom != null);
- }
-
override updateFloatDom(id: string, config: Partial<Omit<IFCanvasFloatDomResult, 'id'>>): this {
const sheetSkeletonService = this._injector.get(SheetSkeletonService);
const floatDomService = this._injector.get(SheetCanvasFloatDomManagerService);
diff --git a/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts b/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts
index 44f5c2e54d..d99255010d 100644
--- a/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts
+++ b/packages/sheets-drawing-ui/src/services/canvas-float-dom-manager.service.ts
@@ -152,6 +152,8 @@ export interface ICanvasFloatDomInfo {
scrollDirectionResponse?: ScrollDirectionResponse; // update float dom pos by scrolling
domAnchor?: IDOMAnchor;
id: string;
+ /** Query attributes for float doms created without a backing drawing. */
+ runtimeMetadata?: Pick<ICanvasFloatDom, 'componentKey' | 'data' | 'allowTransform'>;
domId?: string; // Ensure unique id for dom element at runtime
floatDomConfig?: IFloatDom;
runtimeMounted?: boolean;
@@ -2010,6 +2012,7 @@ export class SheetCanvasFloatDomManagerService extends Disposable {
unitId,
subUnitId,
id: drawingId,
+ runtimeMetadata: { componentKey, data, allowTransform },
} as unknown as ICanvasFloatDomInfo;
const initedPosition = calcSheetFloatDomPosition(domRect, renderObject.renderUnit.scene, skeletonParam.skeleton, target.worksheet, floatDomInfo);
@@ -2253,6 +2256,7 @@ export class SheetCanvasFloatDomManagerService extends Disposable {
boundsOfViewArea,
domAnchor: domLayoutParam,
scrollDirectionResponse: ScrollDirectionResponse.HORIZONTAL,
+ runtimeMetadata: { componentKey, data, allowTransform },
} as unknown as ICanvasFloatDomInfo;
const initedPosition = calcSheetFloatDomPosition(domRect, renderObject.renderUnit.scene, skeleton.skeleton, target.worksheet, floatDomInfo);