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(drawing): drawing popup support custom menu (#4113)

VicKun1ec6dbe62a13
diff --git a/packages/sheets-drawing-ui/src/controllers/drawing-popup-menu.controller.ts b/packages/sheets-drawing-ui/src/controllers/drawing-popup-menu.controller.ts
index 3598f5d856..529ffefeaa 100644
--- a/packages/sheets-drawing-ui/src/controllers/drawing-popup-menu.controller.ts
+++ b/packages/sheets-drawing-ui/src/controllers/drawing-popup-menu.controller.ts
@@ -127,12 +127,13 @@ export class DrawingPopupMenuController extends RxDisposable {
}
singletonPopupDisposer?.dispose();
+ const menus = this._canvasPopManagerService.getFeatureMenu(unitId, subUnitId, drawingId, drawingType);
singletonPopupDisposer = this.disposeWithMe(this._canvasPopManagerService.attachPopupToObject(object, {
componentKey: COMPONENT_IMAGE_POPUP_MENU,
direction: 'horizontal',
offset: [2, 0],
extraProps: {
- menuItems: this._getImageMenuItems(unitId, subUnitId, drawingId, drawingType),
+ menuItems: menus || this._getImageMenuItems(unitId, subUnitId, drawingId, drawingType),
},
}));
diff --git a/packages/sheets-ui/src/services/canvas-pop-manager.service.ts b/packages/sheets-ui/src/services/canvas-pop-manager.service.ts
index 4322f20c68..e2b74cb793 100644
--- a/packages/sheets-ui/src/services/canvas-pop-manager.service.ts
+++ b/packages/sheets-ui/src/services/canvas-pop-manager.service.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { INeedCheckDisposable, IRange, Nullable, Workbook, Worksheet } from '@univerjs/core';
+import type { DrawingTypeEnum, ICommandInfo, INeedCheckDisposable, IRange, Nullable, Workbook, Worksheet } from '@univerjs/core';
import type { BaseObject, IBoundRectNoAngle, IRender, SpreadsheetSkeleton, Viewport } from '@univerjs/engine-render';
import type { ISetWorksheetRowAutoHeightMutationParams, ISheetLocationBase } from '@univerjs/sheets';
import type { IPopup } from '@univerjs/ui';
@@ -31,10 +31,21 @@ import { SheetSkeletonManagerService } from './sheet-skeleton-manager.service';
export interface ICanvasPopup extends Omit<IPopup, 'anchorRect' | 'anchorRect$' | 'unitId' | 'subUnitId' | 'canvasElement'> {
mask?: boolean;
- extraProps?: Record<string, any>;
+ extraProps?: Record<string, unknown>;
}
+interface IPopupMenuItem {
+ label: string;
+ index: number;
+ commandId: string;
+ commandParams: ICommandInfo['params'];
+ disable: boolean;
+}
+type getPopupMenuItemCallback = (unitId: string, subUnitId: string, drawingId: string, drawingType: DrawingTypeEnum) => IPopupMenuItem[];
+
export class SheetCanvasPopManagerService extends Disposable {
+ // the DrawingTypeEnum should refer from drawing package, here we just use type, so no need to import the drawing package
+ private _popupMenuFeatureMap = new Map<DrawingTypeEnum, getPopupMenuItemCallback>();
constructor(
@Inject(ICanvasPopupService) private readonly _globalPopupManagerService: ICanvasPopupService,
@IRenderManagerService private readonly _renderManagerService: IRenderManagerService,
@@ -45,6 +56,33 @@ export class SheetCanvasPopManagerService extends Disposable {
super();
}
+ /**
+ * Register a feature menu callback for a specific drawing type.such as image, chart, etc.
+ */
+ registerFeatureMenu(type: DrawingTypeEnum, getPopupMenuCallBack: getPopupMenuItemCallback) {
+ this._popupMenuFeatureMap.set(type, getPopupMenuCallBack);
+ }
+
+ /**
+ * Get the feature menu by drawing type, the function should be called when a drawing element need trigger popup menu, so the unitId, subUnitId, drawingId should be provided.
+ * @param {string} unitId the unit id
+ * @param {string} subUnitId the sub unit id
+ * @param {string} drawingId the drawing id
+ * @param {DrawingTypeEnum} drawingType the feature type
+ * @returns the feature menu if it exists, otherwise return undefined
+ */
+ getFeatureMenu(unitId: string, subUnitId: string, drawingId: string, drawingType: DrawingTypeEnum): Nullable<IPopupMenuItem[]> {
+ const callback = this._popupMenuFeatureMap.get(drawingType);
+ if (callback) {
+ return callback(unitId, subUnitId, drawingId, drawingType);
+ }
+ }
+
+ override dispose(): void {
+ super.dispose();
+ this._popupMenuFeatureMap.clear();
+ }
+
private _createHiddenRectObserver(params: { row: number; column: number; worksheet: Worksheet; skeleton: SpreadsheetSkeleton; currentRender: IRender }) {
const { row, column, worksheet, skeleton, currentRender } = params;
const calc = () => {