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: better col header facade (#4549)

lumix12b30ffd6747
diff --git a/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts b/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts
index 278a30e1eb..b7d54f954d 100644
--- a/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts
+++ b/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts
@@ -160,9 +160,9 @@ export class ColumnHeaderLayout extends SheetExtension {
case 'center':
return cellBound.left + (cellBound.right - cellBound.left) / 2;
case 'right':
- return cellBound.right - MIDDLE_CELL_POS_MAGIC_NUMBER;
+ return cellBound.right - MIDDLE_CELL_POS_MAGIC_NUMBER * 3;
case 'left':
- return cellBound.left + MIDDLE_CELL_POS_MAGIC_NUMBER;
+ return cellBound.left + MIDDLE_CELL_POS_MAGIC_NUMBER * 3;
default: // center
return cellBound.left + (cellBound.right - cellBound.left) / 2;
}
diff --git a/packages/engine-render/src/components/sheets/interfaces.ts b/packages/engine-render/src/components/sheets/interfaces.ts
index e87ebba166..4ef3564df3 100644
--- a/packages/engine-render/src/components/sheets/interfaces.ts
+++ b/packages/engine-render/src/components/sheets/interfaces.ts
@@ -113,11 +113,14 @@ export interface IHeaderStyleCfg {
textAlign: CanvasTextAlign;
textBaseline: CanvasTextBaseline;
backgroundColor: string;
+ /**
+ * column header height
+ */
size?: number;
}
export type IAColumnCfgObj = IHeaderStyleCfg & { text: string };
-export type IAColumnCfg = undefined | null | string | Partial<IAColumnCfgObj>;
+export type IAColumnCfg = undefined | null | string | Partial<Omit<IAColumnCfgObj, 'size'>>;
export interface IRowStyleCfg {
fontFamily: string;
@@ -127,6 +130,10 @@ export interface IRowStyleCfg {
textAlign: CanvasTextAlign;
textBaseline: CanvasTextBaseline;
backgroundColor: string;
+ /**
+ * row header width
+ */
+ size?: number;
}
export type IARowCfgObj = IHeaderStyleCfg & { text: string };
diff --git a/packages/sheets-ui/src/commands/commands/headersize-changed.command.ts b/packages/sheets-ui/src/commands/commands/headersize-changed.command.ts
new file mode 100644
index 0000000000..a3a1c57fd7
--- /dev/null
+++ b/packages/sheets-ui/src/commands/commands/headersize-changed.command.ts
@@ -0,0 +1,86 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { ICommand } from '@univerjs/core';
+import type { SpreadsheetColumnHeader, SpreadsheetRowHeader } from '@univerjs/engine-render';
+
+import { CommandType } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { SHEET_VIEW_KEY } from '../../common/keys';
+import { SheetSkeletonManagerService } from '../../services/sheet-skeleton-manager.service';
+
+export interface ISetHeaderSizeParams {
+ size: number;
+ unitId: string;
+ subUnitId: string;
+}
+
+export const SetRowHeaderWidthCommand: ICommand<ISetHeaderSizeParams> = {
+ id: 'sheet.command.set-row-header-width',
+ type: CommandType.COMMAND,
+ handler: async (accessor, params) => {
+ if (!params) {
+ return false;
+ }
+
+ const renderManagerSrv = accessor.get(IRenderManagerService);
+ if (!renderManagerSrv) {
+ return false;
+ }
+ const { unitId, subUnitId, size } = params;
+ const render = renderManagerSrv.getRenderById(unitId);
+ if (render) {
+ const skm = renderManagerSrv.getRenderById(unitId)!.with(SheetSkeletonManagerService);
+ skm.setRowHeaderSize(render, subUnitId, size);
+
+ const { components } = render;
+ const renderComponent = components.get(SHEET_VIEW_KEY.ROW);
+ if (renderComponent) {
+ (renderComponent as SpreadsheetRowHeader).setCustomHeader({ headerStyle: { size } });
+ }
+ }
+
+ return true;
+ },
+};
+
+export const SetColumnHeaderHeightCommand: ICommand<ISetHeaderSizeParams> = {
+ id: 'sheet.command.set-col-header-height',
+ type: CommandType.COMMAND,
+ handler: async (accessor, params) => {
+ if (!params) {
+ return false;
+ }
+
+ const renderManagerSrv = accessor.get(IRenderManagerService);
+ if (!renderManagerSrv) {
+ return false;
+ }
+ const { unitId, subUnitId, size } = params;
+ const render = renderManagerSrv.getRenderById(unitId);
+ if (render) {
+ const skm = renderManagerSrv.getRenderById(unitId)!.with(SheetSkeletonManagerService);
+ skm.setColumnHeaderSize(render, subUnitId, size);
+ const { components } = render;
+ const renderComponent = components.get(SHEET_VIEW_KEY.COLUMN);
+ if (renderComponent) {
+ (renderComponent as SpreadsheetColumnHeader).setCustomHeader({ headerStyle: { size } });
+ }
+ }
+
+ return true;
+ },
+};
diff --git a/packages/sheets-ui/src/controllers/render-controllers/freeze.render-controller.ts b/packages/sheets-ui/src/controllers/render-controllers/freeze.render-controller.ts
index 3485611f28..7493e97211 100644
--- a/packages/sheets-ui/src/controllers/render-controllers/freeze.render-controller.ts
+++ b/packages/sheets-ui/src/controllers/render-controllers/freeze.render-controller.ts
@@ -69,9 +69,10 @@ import {
SheetsSelectionsService,
} from '@univerjs/sheets';
import { Subscription } from 'rxjs';
+import { SetColumnHeaderHeightCommand, SetRowHeaderWidthCommand } from '../../commands/commands/headersize-changed.command';
import { ScrollCommand } from '../../commands/commands/set-scroll.command';
-import { SetZoomRatioOperation } from '../../commands/operations/set-zoom-ratio.operation';
+import { SetZoomRatioOperation } from '../../commands/operations/set-zoom-ratio.operation';
import { SHEET_COMPONENT_HEADER_LAYER_INDEX } from '../../common/keys';
import { SheetScrollManagerService } from '../../services/scroll-manager.service';
import { SheetSkeletonManagerService } from '../../services/sheet-skeleton-manager.service';
@@ -237,7 +238,8 @@ export class HeaderFreezeRenderController extends Disposable implements IRenderM
this._rowFreezeHeaderRect = new Rect(FREEZE_ROW_HEADER_NAME, {
fill: this._freezeNormalHeaderColor, width: rowHeaderWidthAndMarginLeft,
- height: FREEZE_SIZE, left: 0, top: startY - FREEZE_OFFSET, zIndex: 3 });
+ height: FREEZE_SIZE, left: 0, top: startY - FREEZE_OFFSET, zIndex: 3,
+ });
let fill = this._freezeNormalHeaderColor;
if (freezeRow === -1 || freezeRow === 0) {
@@ -263,7 +265,8 @@ export class HeaderFreezeRenderController extends Disposable implements IRenderM
this._columnFreezeHeaderRect = new Rect(FREEZE_COLUMN_HEADER_NAME, {
fill: this._freezeNormalHeaderColor, width: FREEZE_SIZE, height: columnHeaderHeightAndMarginTop,
- left: startX - FREEZE_OFFSET, top: 0, zIndex: 3 });
+ left: startX - FREEZE_OFFSET, top: 0, zIndex: 3,
+ });
let fill = this._freezeNormalHeaderColor;
if (freezeColumn === -1 || freezeColumn === 0) {
@@ -1114,16 +1117,15 @@ export class HeaderFreezeRenderController extends Disposable implements IRenderM
this.disposeWithMe(
toDisposable(
this._sheetSkeletonManagerService.currentSkeleton$.subscribe((param) => {
- if (
- ![
- SetWorksheetActiveOperation.id,
- InsertRangeMoveDownCommand.id,
- InsertRangeMoveRightCommand.id,
- ].includes(param?.commandId || '')
- ) {
- return;
+ const allowedCommands = [
+ SetWorksheetActiveOperation.id,
+ InsertRangeMoveDownCommand.id,
+ InsertRangeMoveRightCommand.id,
+ ];
+
+ if (allowedCommands.includes(param?.commandId || '')) {
+ this._refreshCurrent();
}
- this._refreshCurrent();
})
)
);
@@ -1406,80 +1408,108 @@ export class HeaderFreezeRenderController extends Disposable implements IRenderM
);
}
+ /**
+ * Update freeze line position when some cmds cause sk change.
+ */
+ // TODO @lumixraku But there is a _zoomRefresh method? Duplicated?
private _commandExecutedListener() {
- const updateCommandList = [SetFrozenMutation.id, SetZoomRatioOperation.id];
-
this.disposeWithMe(
// eslint-disable-next-line complexity
this._commandService.onCommandExecuted((command: ICommandInfo) => {
- if (updateCommandList.includes(command.id)) {
- const lastFreeze = this._lastFreeze;
- const workbook = this._context.unit;
- const worksheet = workbook.getActiveSheet();
- const params = command.params as ISetFrozenMutationParams;
- const { unitId, subUnitId } = params;
- if (!(unitId === workbook.getUnitId() && subUnitId === worksheet?.getSheetId())) {
- return;
- }
-
- const freeze = worksheet.getConfig().freeze;
- this._lastFreeze = freeze;
- if (freeze == null) {
- return;
- }
-
- let resetScroll = ResetScrollType.NONE;
-
- const { startRow = -1, startColumn = -1, ySplit = 0, xSplit = 0 } = freeze;
- if (!lastFreeze || lastFreeze.startRow !== startRow || lastFreeze.ySplit !== ySplit) {
- resetScroll |= ResetScrollType.Y;
- }
- if (!lastFreeze || lastFreeze.startColumn !== startColumn || lastFreeze.xSplit !== xSplit) {
- resetScroll |= ResetScrollType.X;
- }
- if (params.resetScroll === false) {
- resetScroll = ResetScrollType.NONE;
- }
- this._refreshFreeze(startRow, startColumn, ySplit, xSplit, resetScroll);
- } else if (command.id === SetWorksheetRowHeightMutation.id) {
- const freeze = this._getFreeze();
- const isRefresh = freeze && (command.params as ISetWorksheetRowHeightMutationParams).ranges.some((i) => i.startRow < freeze.startRow);
- if (command.params && isRefresh) {
- this._refreshCurrent();
- }
- } else if (command.id === SetWorksheetColWidthMutation.id) {
- const freeze = this._getFreeze();
- if (command.params && freeze && (command.params as ISetWorksheetColWidthMutationParams).ranges.some(
- (i) => i.startColumn < freeze.startColumn
- )) {
- this._refreshCurrent();
- }
- } else if (command.id === SetWorksheetRowAutoHeightMutation.id) {
- const params = command.params as ISetWorksheetRowAutoHeightMutationParams;
- const freeze = this._getFreeze();
-
- if (freeze && freeze.startRow > -1 && params.rowsAutoHeightInfo.some((info) => info.row < freeze.startRow)) {
- const subscription = this._sheetSkeletonManagerService.currentSkeleton$.subscribe(() => {
- this._refreshCurrent();
- setTimeout(() => {
- subscription.unsubscribe();
- });
- });
- }
- } else if (command.id === SetColHiddenMutation.id || command.id === SetColVisibleMutation.id) {
- const params = command.params as ISetColHiddenMutationParams;
- const freeze = this._getFreeze();
- const ranges = params.ranges;
- if (freeze && freeze.startColumn > -1 && ranges.some((range) => range.startColumn < freeze.startColumn)) {
- this._refreshCurrent();
- }
- } else if (command.id === SetRowHiddenMutation.id || command.id === SetRowVisibleMutation.id) {
- const params = command.params as ISetRowHiddenMutationParams;
- const freeze = this._getFreeze();
- const ranges = params.ranges;
- if (freeze && freeze.startRow > -1 && ranges.some((range) => range.startRow < freeze.startRow)) {
+ switch (command.id) {
+ case SetFrozenMutation.id:
+ case SetZoomRatioOperation.id:
+ {
+ const lastFreeze = this._lastFreeze;
+ const workbook = this._context.unit;
+ const worksheet = workbook.getActiveSheet();
+ const params = command.params as ISetFrozenMutationParams;
+ const { unitId, subUnitId } = params;
+ if (!(unitId === workbook.getUnitId() && subUnitId === worksheet?.getSheetId())) {
+ return;
+ }
+
+ const freeze = worksheet.getConfig().freeze;
+ this._lastFreeze = freeze;
+ if (freeze == null) {
+ return;
+ }
+
+ let resetScroll = ResetScrollType.NONE;
+
+ const { startRow = -1, startColumn = -1, ySplit = 0, xSplit = 0 } = freeze;
+ if (!lastFreeze || lastFreeze.startRow !== startRow || lastFreeze.ySplit !== ySplit) {
+ resetScroll |= ResetScrollType.Y;
+ }
+ if (!lastFreeze || lastFreeze.startColumn !== startColumn || lastFreeze.xSplit !== xSplit) {
+ resetScroll |= ResetScrollType.X;
+ }
+ if (params.resetScroll === false) {
+ resetScroll = ResetScrollType.NONE;
+ }
+ this._refreshFreeze(startRow, startColumn, ySplit, xSplit, resetScroll);
+ }
+ break;
+
+ case SetWorksheetRowHeightMutation.id:
+ {
+ const freeze = this._getFreeze();
+ const isRefresh = freeze && (command.params as ISetWorksheetRowHeightMutationParams).ranges.some((i) => i.startRow < freeze.startRow);
+ if (command.params && isRefresh) {
+ this._refreshCurrent();
+ }
+ }
+ break;
+ case SetWorksheetColWidthMutation.id:
+ {
+ const freeze = this._getFreeze();
+ if (command.params && freeze && (command.params as ISetWorksheetColWidthMutationParams).ranges.some(
+ (i) => i.startColumn < freeze.startColumn
+ )) {
+ this._refreshCurrent();
+ }
+ }
+ break;
+ case SetWorksheetRowAutoHeightMutation.id:
+ {
+ const params = command.params as ISetWorksheetRowAutoHeightMutationParams;
+ const freeze = this._getFreeze();
+
+ if (freeze && freeze.startRow > -1 && params.rowsAutoHeightInfo.some((info) => info.row < freeze.startRow)) {
+ const subscription = this._sheetSkeletonManagerService.currentSkeleton$.subscribe(() => {
+ this._refreshCurrent();
+ setTimeout(() => {
+ subscription.unsubscribe();
+ });
+ });
+ }
+ }
+ break;
+ case SetColHiddenMutation.id:
+ case SetColVisibleMutation.id:
+ {
+ const params = command.params as ISetColHiddenMutationParams;
+ const freeze = this._getFreeze();
+ const ranges = params.ranges;
+ if (freeze && freeze.startColumn > -1 && ranges.some((range) => range.startColumn < freeze.startColumn)) {
+ this._refreshCurrent();
+ }
+ }
+ break;
+ case SetRowHiddenMutation.id:
+ case SetRowVisibleMutation.id:
+ {
+ const params = command.params as ISetRowHiddenMutationParams;
+ const freeze = this._getFreeze();
+ const ranges = params.ranges;
+ if (freeze && freeze.startRow > -1 && ranges.some((range) => range.startRow < freeze.startRow)) {
+ this._refreshCurrent();
+ }
+ }
+ break;
+ case SetRowHeaderWidthCommand.id:
+ case SetColumnHeaderHeightCommand.id:
this._refreshCurrent();
- }
}
})
);
@@ -1491,7 +1521,6 @@ export class HeaderFreezeRenderController extends Disposable implements IRenderM
return;
}
const { scene } = sheetObject;
-
scene.onTransformChange$.subscribeEvent((state) => {
if (state.type !== TRANSFORM_CHANGE_OBSERVABLE_TYPE.scale) {
return;
@@ -1582,8 +1611,7 @@ export class HeaderFreezeRenderController extends Disposable implements IRenderM
}
/**
- * 调整冻结 & 缩放都会进入
- * 但是窗口 resize 并不会进入
+ * Core function of _refreshCurrent
* @param startRow
* @param startColumn
* @param ySplit
diff --git a/packages/sheets-ui/src/controllers/render-controllers/sheet.render-controller.ts b/packages/sheets-ui/src/controllers/render-controllers/sheet.render-controller.ts
index c9d9f8acf5..c73b06b931 100644
--- a/packages/sheets-ui/src/controllers/render-controllers/sheet.render-controller.ts
+++ b/packages/sheets-ui/src/controllers/render-controllers/sheet.render-controller.ts
@@ -239,7 +239,6 @@ export class SheetRenderController extends RxDisposable implements IRenderModule
private _initViewports(scene: Scene, rowHeader: { width: number }, columnHeader: { height: number }) {
const bufferEdgeX = 100;
const bufferEdgeY = 100;
-
const viewMain = new Viewport(SHEET_VIEWPORT_KEY.VIEW_MAIN, scene, {
left: rowHeader.width,
top: columnHeader.height,
diff --git a/packages/sheets-ui/src/controllers/render-controllers/zoom.render-controller.ts b/packages/sheets-ui/src/controllers/render-controllers/zoom.render-controller.ts
index 7ca1bead4d..c335b1ebe8 100644
--- a/packages/sheets-ui/src/controllers/render-controllers/zoom.render-controller.ts
+++ b/packages/sheets-ui/src/controllers/render-controllers/zoom.render-controller.ts
@@ -22,6 +22,9 @@ import { IEditorBridgeService } from '../../services/editor-bridge.service';
import { SheetSkeletonManagerService } from '../../services/sheet-skeleton-manager.service';
import { getSheetObject } from '../utils/component-tools';
+/**
+ * Zoom render controller, registered in a render module.
+ */
export class SheetsZoomRenderController extends Disposable implements IRenderModule {
constructor(
private readonly _context: IRenderContext<Workbook>,
@@ -90,6 +93,7 @@ export class SheetsZoomRenderController extends Disposable implements IRenderMod
);
}
+ private _zoom: number;
private _initSkeletonListener() {
this.disposeWithMe(this._sheetSkeletonManagerService.currentSkeletonBefore$.subscribe((param) => {
if (param == null) {
@@ -101,7 +105,10 @@ export class SheetsZoomRenderController extends Disposable implements IRenderMod
if (!worksheet) return;
const zoomRatio = worksheet.getZoomRatio() || 1;
- this._updateViewZoom(zoomRatio);
+ if (this._zoom !== zoomRatio) {
+ this._updateViewZoom(zoomRatio);
+ }
+ this._zoom = zoomRatio;
}));
}
diff --git a/packages/sheets-ui/src/controllers/sheet-ui.controller.ts b/packages/sheets-ui/src/controllers/sheet-ui.controller.ts
index fa288ca6e9..bfda98bd81 100644
--- a/packages/sheets-ui/src/controllers/sheet-ui.controller.ts
+++ b/packages/sheets-ui/src/controllers/sheet-ui.controller.ts
@@ -38,6 +38,7 @@ import {
import { AutoClearContentCommand, AutoFillCommand } from '../commands/commands/auto-fill.command';
import { DeleteRangeMoveLeftConfirmCommand } from '../commands/commands/delete-range-move-left-confirm.command';
import { DeleteRangeMoveUpConfirmCommand } from '../commands/commands/delete-range-move-up-confirm.command';
+import { SetColumnHeaderHeightCommand, SetRowHeaderWidthCommand } from '../commands/commands/headersize-changed.command';
import { HideColConfirmCommand, HideRowConfirmCommand } from '../commands/commands/hide-row-col-confirm.command';
import {
ResetRangeTextColorCommand,
@@ -92,8 +93,8 @@ import { SetZoomRatioOperation } from '../commands/operations/set-zoom-ratio.ope
import { SheetPermissionOpenDialogOperation } from '../commands/operations/sheet-permission-open-dialog.operation';
import { SheetPermissionOpenPanelOperation } from '../commands/operations/sheet-permission-open-panel.operation';
import { SidebarDefinedNameOperation } from '../commands/operations/sidebar-defined-name.operation';
-import { BorderPanel } from '../components/border-panel/BorderPanel';
+import { BorderPanel } from '../components/border-panel/BorderPanel';
import { BORDER_PANEL_COMPONENT } from '../components/border-panel/interface';
import { COLOR_PICKER_COMPONENT, ColorPicker } from '../components/color-picker';
import {
@@ -275,6 +276,8 @@ export class SheetUIController extends Disposable {
SetRangeProtectionFromContextMenuCommand,
DeleteWorksheetProtectionFormSheetBarCommand,
SetWorksheetColAutoWidthCommand,
+ SetRowHeaderWidthCommand,
+ SetColumnHeaderHeightCommand,
].forEach((c) => {
this.disposeWithMe(this._commandService.registerCommand(c));
});
diff --git a/packages/sheets-ui/src/facade/f-univer.ts b/packages/sheets-ui/src/facade/f-univer.ts
index 1cb01d44ba..42f2e382a6 100644
--- a/packages/sheets-ui/src/facade/f-univer.ts
+++ b/packages/sheets-ui/src/facade/f-univer.ts
@@ -44,6 +44,7 @@ import { combineLatest, filter } from 'rxjs';
*/
export interface IFUniverSheetsUIMixin {
/**
+ * @deprecated use same API in FWorkSheet.
* Customize the column header of the spreadsheet.
* @param {IColumnsHeaderCfgParam} cfg The configuration of the column header.
* @example
@@ -52,7 +53,9 @@ export interface IFUniverSheetsUIMixin {
* ```
*/
customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void;
+
/**
+ * @deprecated use same API in FWorkSheet.
* Customize the row header of the spreadsheet.
* @param {IRowsHeaderCfgParam} cfg The configuration of the row header.
* @example
@@ -61,6 +64,7 @@ export interface IFUniverSheetsUIMixin {
* ```
*/
customizeRowHeader(cfg: IRowsHeaderCfgParam): void;
+
/**
* Register sheet row header render extensions.
* @param {string} unitId The unit id of the spreadsheet.
diff --git a/packages/sheets-ui/src/facade/f-worksheet.ts b/packages/sheets-ui/src/facade/f-worksheet.ts
index 3f6da64862..e5a79923fa 100644
--- a/packages/sheets-ui/src/facade/f-worksheet.ts
+++ b/packages/sheets-ui/src/facade/f-worksheet.ts
@@ -15,12 +15,12 @@
*/
import type { IDisposable, IRange, Nullable } from '@univerjs/core';
-import type { RenderManagerService, SpreadsheetSkeleton } from '@univerjs/engine-render';
+import type { IColumnsHeaderCfgParam, IRowsHeaderCfgParam, RenderComponentType, RenderManagerService, SpreadsheetColumnHeader, SpreadsheetRowHeader, SpreadsheetSkeleton } from '@univerjs/engine-render';
import type { IScrollState, IViewportScrollState } from '@univerjs/sheets-ui';
import { ICommandService, toDisposable } from '@univerjs/core';
import { IRenderManagerService, SHEET_VIEWPORT_KEY, sheetContentViewportKeys } from '@univerjs/engine-render';
-import { ChangeZoomRatioCommand, SetWorksheetColAutoWidthCommand, SheetScrollManagerService, SheetSkeletonManagerService, SheetsScrollRenderController } from '@univerjs/sheets-ui';
+import { ChangeZoomRatioCommand, SetColumnHeaderHeightCommand, SetRowHeaderWidthCommand, SetWorksheetColAutoWidthCommand, SHEET_VIEW_KEY, SheetScrollManagerService, SheetSkeletonManagerService, SheetsScrollRenderController } from '@univerjs/sheets-ui';
import { FWorksheet } from '@univerjs/sheets/facade';
/**
@@ -119,6 +119,80 @@ export interface IFWorksheetSkeletonMixin {
*/
setColumnAutoWidth(columnPosition: number, numColumn: number): FWorksheet;
+ /**
+ * Customize the column header of the spreadsheet.
+ * @param {IColumnsHeaderCfgParam} cfg The configuration of the column header.
+ * @example
+ * ```typescript
+ const fWorkbook = univerAPI.getActiveWorkbook();
+ const fWorksheet = fWorkbook.getActiveSheet();
+ fWorksheet.customizeColumnHeader({
+ headerStyle: {
+ fontColor: '#fff',
+ backgroundColor: '#4e69ee',
+ fontSize: 9
+ },
+ columnsCfg: {
+ 0: 'kuma II',
+ 3: {
+ text: 'Size',
+ textAlign: 'left', // CanvasTextAlign
+ fontColor: '#fff',
+ fontSize: 12,
+ borderColor: 'pink',
+ backgroundColor: 'pink',
+ },
+ 4: 'Wow'
+ }
+ });
+ * ```
+ */
+ customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void;
+
+ /**
+ * Customize the row header of the spreadsheet.
+ * @param {IRowsHeaderCfgParam} cfg The configuration of the row header.
+ * @example
+ * ```typescript
+ univerAPI.customizeRowHeader({
+ headerStyle: {
+ backgroundColor: 'pink',
+ fontSize: 12
+ },
+ rowsCfg: {
+ 0: 'MokaII',
+ 3: {
+ text: 'Size',
+ textAlign: 'left'
+ }
+ }
+ });
+ * ```
+ */
+ customizeRowHeader(cfg: IRowsHeaderCfgParam): void;
+
+ /**
+ * Set column height for column header.
+ * @param height
+ * @example
+ * ```ts
+ const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ sheet.setColumnHeaderHeight(100);
+ * ```
+ */
+ setColumnHeaderHeight(height: number): FWorksheet;
+
+ /**
+ * Set column height for column header.
+ * @param width
+ * @example
+ * ```ts
+ const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ sheet.setRowHeaderWidth(100);
+ * ```
+ */
+ setRowHeaderWidth(width: number): FWorksheet;
+
/**
* @deprecated use `univerAPI.addEvent(univerAPI.Event.Scroll, () => {})` instead
*/
@@ -258,6 +332,88 @@ export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSk
return this;
}
+
+ override customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void {
+ const activeSheet = this;
+ const unitId = this._fWorkbook.getId();
+ const renderManagerService = this._injector.get(IRenderManagerService);
+ const subUnitId = activeSheet.getSheetId();
+ const render = renderManagerService.getRenderById(unitId);
+ if (render && cfg.headerStyle?.size) {
+ const skm = render.with(SheetSkeletonManagerService);
+ skm.setColumnHeaderSize(render, subUnitId, cfg.headerStyle?.size);
+ activeSheet?.refreshCanvas();
+ }
+
+ const sheetColumn = this._getSheetRenderComponent(unitId, SHEET_VIEW_KEY.COLUMN) as SpreadsheetColumnHeader;
+ if (sheetColumn) {
+ sheetColumn.setCustomHeader(cfg);
+ activeSheet?.refreshCanvas();
+ }
+ }
+
+ override customizeRowHeader(cfg: IRowsHeaderCfgParam): void {
+ const unitId = this._fWorkbook.getId();
+ const sheetRow = this._getSheetRenderComponent(unitId, SHEET_VIEW_KEY.ROW) as SpreadsheetRowHeader;
+ sheetRow.setCustomHeader(cfg);
+ }
+
+ override setColumnHeaderHeight(height: number): FWorksheet {
+ const activeSheet = this;
+ const unitId = this._fWorkbook.getId();
+ const subUnitId = activeSheet.getSheetId();
+
+ this._commandService.executeCommand(SetColumnHeaderHeightCommand.id, {
+ unitId,
+ subUnitId,
+ size: height,
+ });
+
+ activeSheet?.refreshCanvas();
+ return this;
+ }
+
+ override setRowHeaderWidth(width: number): FWorksheet {
+ const activeSheet = this;
+ const unitId = this._fWorkbook.getId();
+ const subUnitId = activeSheet.getSheetId();
+
+ this._commandService.executeCommand(SetRowHeaderWidthCommand.id, {
+ unitId,
+ subUnitId,
+ size: width,
+ });
+
+ const sheetRow = this._getSheetRenderComponent(unitId, SHEET_VIEW_KEY.ROW) as SpreadsheetRowHeader;
+ if (sheetRow) {
+ sheetRow.setCustomHeader({ headerStyle: { size: width } });
+ }
+ activeSheet?.refreshCanvas();
+ return this;
+ }
+
+ /**
+ * Get sheet render component from render by unitId and view key.
+ * @private
+ * @param {string} unitId The unit id of the spreadsheet.
+ * @param {SHEET_VIEW_KEY} viewKey The view key of the spreadsheet.
+ * @returns {Nullable<RenderComponentType>} The render component.
+ */
+ private _getSheetRenderComponent(unitId: string, viewKey: SHEET_VIEW_KEY): Nullable<RenderComponentType> {
+ const renderManagerService = this._injector.get(IRenderManagerService);
+ const render = renderManagerService.getRenderById(unitId);
+ if (!render) {
+ throw new Error(`Render Unit with unitId ${unitId} not found`);
+ }
+
+ const { components } = render;
+ const renderComponent = components.get(viewKey);
+ if (!renderComponent) {
+ throw new Error('Render component not found');
+ }
+
+ return renderComponent;
+ }
}
FWorksheet.extend(FWorksheetSkeletonMixin);
diff --git a/packages/sheets-ui/src/index.ts b/packages/sheets-ui/src/index.ts
index da807745d2..ea2e62c135 100644
--- a/packages/sheets-ui/src/index.ts
+++ b/packages/sheets-ui/src/index.ts
@@ -170,6 +170,7 @@ export {
ChangeSheetProtectionFromSheetBarCommand,
DeleteWorksheetProtectionFormSheetBarCommand,
} from './commands/commands/worksheet-protection.command';
+export { SetColumnHeaderHeightCommand, SetRowHeaderWidthCommand } from './commands/commands/headersize-changed.command';
export { SetActivateCellEditOperation } from './commands/operations/activate-cell-edit.operation';
export { SetCellEditVisibleArrowOperation, SetCellEditVisibleOperation, SetCellEditVisibleWithF2Operation } from './commands/operations/cell-edit.operation';
diff --git a/packages/sheets-ui/src/services/sheet-skeleton-manager.service.ts b/packages/sheets-ui/src/services/sheet-skeleton-manager.service.ts
index 93f919b9a6..a5fe2625d8 100644
--- a/packages/sheets-ui/src/services/sheet-skeleton-manager.service.ts
+++ b/packages/sheets-ui/src/services/sheet-skeleton-manager.service.ts
@@ -20,6 +20,7 @@ import { Disposable, Inject, Injector } from '@univerjs/core';
import { SHEET_VIEWPORT_KEY, SpreadsheetSkeleton } from '@univerjs/engine-render';
import { SheetsSelectionsService } from '@univerjs/sheets';
import { BehaviorSubject } from 'rxjs';
+import { SetColumnHeaderHeightCommand, SetRowHeaderWidthCommand } from '../commands/commands/headersize-changed.command';
import { ISheetSelectionRenderService } from './selection/base-selection-render.service';
import { attachRangeWithCoord } from './selection/util';
@@ -230,32 +231,75 @@ export class SheetSkeletonManagerService extends Disposable implements IRenderMo
return spreadsheetSkeleton;
}
- setColumnHeaderSize(render: IRender, sheetId: string, size: number) {
+ setColumnHeaderSize(render: Nullable<IRender>, sheetId: string, size: number) {
+ if (!render) return;
const skeleton = this.getWorksheetSkeleton(sheetId)?.skeleton;
- if (skeleton) {
- skeleton.columnHeaderHeight = size;
- render.scene.getViewports()[0].top = size;
- render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_COLUMN_RIGHT)!.setViewportSize({
- height: size,
- });
- render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_COLUMN_LEFT)!.setViewportSize({
- height: size,
- });
- render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_ROW_BOTTOM)!.setViewportSize({
- top: size,
- });
- render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_ROW_TOP)!.setViewportSize({
- top: size,
- });
- render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_LEFT_TOP)!.setViewportSize({
- height: size,
- });
- const selectionService = render?.with(SheetsSelectionsService);
- const selectionRenderService = render?.with(ISheetSelectionRenderService);
- const currSelections = selectionService.getCurrentSelections();
- selectionRenderService.resetSelectionsByModelData(currSelections);
+ if (!skeleton) return;
- const sheetSkeletonManagerParam = this.getUnitSkeleton(render.unitId, sheetId);
+ skeleton.columnHeaderHeight = size;
+ render.scene.getViewports()[0].top = size;
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_COLUMN_RIGHT)!.setViewportSize({
+ height: size,
+ });
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_COLUMN_LEFT)!.setViewportSize({
+ height: size,
+ });
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_ROW_BOTTOM)!.setViewportSize({
+ top: size,
+ });
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_ROW_TOP)!.setViewportSize({
+ top: size,
+ });
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_LEFT_TOP)!.setViewportSize({
+ height: size,
+ });
+ const selectionService = render?.with(SheetsSelectionsService);
+ const selectionRenderService = render?.with(ISheetSelectionRenderService);
+ const currSelections = selectionService.getCurrentSelections();
+ selectionRenderService.resetSelectionsByModelData(currSelections);
+
+ const sheetSkeletonManagerParam = this.getUnitSkeleton(render.unitId, sheetId);
+ if (sheetSkeletonManagerParam) {
+ sheetSkeletonManagerParam.commandId = SetColumnHeaderHeightCommand.id;
+ this._currentSkeleton$.next(sheetSkeletonManagerParam);
+ }
+ }
+
+ setRowHeaderSize(render: Nullable<IRender>, sheetId: string, size: number) {
+ const skeleton = this.getWorksheetSkeleton(sheetId)?.skeleton;
+ if (!render) return;
+ if (!skeleton) return;
+ skeleton.rowHeaderWidth = size;
+ const originWidth = render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_LEFT_TOP)!.width || 46;
+ const deltaX = size - originWidth;
+
+ const originLeftOfViewMain = render.scene.getViewports()[0].left;
+ render.scene.getViewports()[0].left = originLeftOfViewMain + deltaX;
+
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_ROW_BOTTOM)!.setViewportSize({
+ width: size,
+ });
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_ROW_TOP)!.setViewportSize({
+ width: size,
+ });
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_COLUMN_LEFT)!.setViewportSize({
+ left: size,
+ });
+ const prevLeft = render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_COLUMN_RIGHT)!.left || 0;
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_COLUMN_RIGHT)!.setViewportSize({
+ left: prevLeft + deltaX,
+ });
+ render.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_LEFT_TOP)!.setViewportSize({
+ width: size,
+ });
+ const selectionService = render?.with(SheetsSelectionsService);
+ const selectionRenderService = render?.with(ISheetSelectionRenderService);
+ const currSelections = selectionService.getCurrentSelections();
+ selectionRenderService.resetSelectionsByModelData(currSelections);
+
+ const sheetSkeletonManagerParam = this.getCurrent();
+ if (sheetSkeletonManagerParam) {
+ sheetSkeletonManagerParam.commandId = SetRowHeaderWidthCommand.id;
this._currentSkeleton$.next(sheetSkeletonManagerParam);
}
}
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.ts
index f088f26b44..975b141e0f 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
@@ -174,6 +174,6 @@ export const InsertRangeMoveRightCommand: ICommand = {
return false;
},
- // all subsequent mutations should succeed inorder to make the whole process succeed
+ // all subsequent mutations should succeed in order to make the whole process succeed
// Promise.all([]).then(() => true),
};
diff --git a/packages/ui/src/views/components/popup/RectPopup.tsx b/packages/ui/src/views/components/popup/RectPopup.tsx
index 608d8b6229..0c0247b9f3 100644
--- a/packages/ui/src/views/components/popup/RectPopup.tsx
+++ b/packages/ui/src/views/components/popup/RectPopup.tsx
@@ -119,7 +119,7 @@ function RectPopup(props: IRectPopupProps) {
left: -9999,
});
const excludeRectsRef = excludeRects;
- const anchorRectRef = useRef<IAbsolutePosition>(undefined);
+ const anchorRectRef = useRef<IAbsolutePosition | undefined>(undefined);
useEffect(() => {
const anchorRectSub = anchorRect$.subscribe((anchorRect) => {