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): hide rows cols should skip over already hidden ranges (#2517)

Wenzhao Hu1896852bf5ae
diff --git a/packages/sheets/src/commands/commands/__tests__/set-row-col-visible.command.spec.ts b/packages/sheets/src/commands/commands/__tests__/set-row-col-visible.command.spec.ts
index ba0c2fbae7..3d4d46e058 100644
--- a/packages/sheets/src/commands/commands/__tests__/set-row-col-visible.command.spec.ts
+++ b/packages/sheets/src/commands/commands/__tests__/set-row-col-visible.command.spec.ts
@@ -176,6 +176,34 @@ describe('Test row col hide/unhine commands', () => {
expect(getRowRawVisible(0)).toBeFalsy();
expect(getRowRawVisible(2)).toBeFalsy();
});
+
+ it('should skip over already hidden rows', async () => {
+ expect(getRowRawVisible(0)).toBeTruthy();
+
+ selectRow(2, 2);
+ await commandService.executeCommand(SetRowHiddenCommand.id);
+ expect(getRowRawVisible(2)).toBeFalsy();
+
+ selectRow(1, 4);
+ await commandService.executeCommand(SetRowHiddenCommand.id);
+ expect(getRowRawVisible(1)).toBeFalsy();
+ expect(getRowRawVisible(2)).toBeFalsy();
+ expect(getRowRawVisible(3)).toBeFalsy();
+
+ await commandService.executeCommand(UndoCommand.id);
+ expect(getRowRawVisible(1)).toBeTruthy();
+ expect(getRowRawVisible(2)).toBeFalsy();
+ expect(getRowRawVisible(3)).toBeTruthy();
+
+ selectRow(1, 2);
+ await commandService.executeCommand(SetRowHiddenCommand.id);
+ expect(getRowRawVisible(1)).toBeFalsy();
+ expect(getRowRawVisible(2)).toBeFalsy();
+
+ await commandService.executeCommand(UndoCommand.id);
+ expect(getRowRawVisible(1)).toBeTruthy();
+ expect(getRowRawVisible(2)).toBeFalsy();
+ });
});
describe('hide / unhide columns', () => {
@@ -207,5 +235,33 @@ describe('Test row col hide/unhine commands', () => {
expect(getColVisible(0)).toBeFalsy();
expect(getColVisible(2)).toBeFalsy();
});
+
+ it('should skip over already hidden cols', async () => {
+ expect(getColVisible(0)).toBeTruthy();
+
+ selectColumn(2, 2);
+ await commandService.executeCommand(SetColHiddenCommand.id);
+ expect(getColVisible(2)).toBeFalsy();
+
+ selectColumn(1, 4);
+ await commandService.executeCommand(SetColHiddenCommand.id);
+ expect(getColVisible(1)).toBeFalsy();
+ expect(getColVisible(2)).toBeFalsy();
+ expect(getColVisible(3)).toBeFalsy();
+
+ await commandService.executeCommand(UndoCommand.id);
+ expect(getColVisible(1)).toBeTruthy();
+ expect(getColVisible(2)).toBeFalsy();
+ expect(getColVisible(3)).toBeTruthy();
+
+ selectColumn(1, 2);
+ await commandService.executeCommand(SetColHiddenCommand.id);
+ expect(getColVisible(1)).toBeFalsy();
+ expect(getColVisible(2)).toBeFalsy();
+
+ await commandService.executeCommand(UndoCommand.id);
+ expect(getColVisible(1)).toBeTruthy();
+ expect(getColVisible(2)).toBeFalsy();
+ });
});
});
diff --git a/packages/sheets/src/commands/commands/set-col-visible.command.ts b/packages/sheets/src/commands/commands/set-col-visible.command.ts
index 1ee13072b8..99b9d64c3d 100644
--- a/packages/sheets/src/commands/commands/set-col-visible.command.ts
+++ b/packages/sheets/src/commands/commands/set-col-visible.command.ts
@@ -14,7 +14,8 @@
* limitations under the License.
*/
-import type { ICommand, IRange, Nullable, Workbook } from '@univerjs/core';
+import type { ICommand, IRange, Nullable,
+ Worksheet } from '@univerjs/core';
import {
CommandType,
ICommandService,
@@ -22,7 +23,6 @@ import {
IUniverInstanceService,
RANGE_TYPE,
sequenceExecute,
- UniverInstanceType,
} from '@univerjs/core';
import type { IAccessor } from '@wendellhu/redi';
@@ -38,6 +38,7 @@ import type { ISetSelectionsOperationParams } from '../operations/selection.oper
import { SetSelectionsOperation } from '../operations/selection.operation';
import { SheetInterceptorService } from '../../services/sheet-interceptor/sheet-interceptor.service';
import { getPrimaryForRange } from './utils/selection-utils';
+import { getSheetCommandTarget } from './utils/target-util';
export interface ISetSpecificColsVisibleCommandParams {
unitId: string;
@@ -49,26 +50,29 @@ export const SetSpecificColsVisibleCommand: ICommand<ISetSpecificColsVisibleComm
type: CommandType.COMMAND,
id: 'sheet.command.set-col-visible-on-cols',
handler: async (accessor, params: ISetSpecificColsVisibleCommandParams) => {
- const sheetInterceptorService = accessor.get(SheetInterceptorService);
const { unitId, subUnitId, ranges } = params;
- const worksheet = accessor
- .get(IUniverInstanceService)
- .getUniverSheetInstance(unitId)!
- .getSheetBySheetId(subUnitId)!;
+ const sheetInterceptorService = accessor.get(SheetInterceptorService);
+ const commandService = accessor.get(ICommandService);
+ const instanceService = accessor.get(IUniverInstanceService);
+ const target = getSheetCommandTarget(instanceService, { unitId, subUnitId });
+ if (!target) return false;
+
+ const { worksheet } = target;
const redoMutationParams: ISetColVisibleMutationParams = {
unitId,
subUnitId,
ranges,
};
- const undoMutationParams = SetColVisibleUndoMutationFactory(accessor, redoMutationParams);
const setSelectionOperationParams: ISetSelectionsOperationParams = {
unitId,
subUnitId,
pluginName: NORMAL_SELECTION_PLUGIN_NAME,
selections: ranges.map((r) => ({ range: r, primary: getPrimaryForRange(r, worksheet), style: null })),
};
+
+ const undoMutationParams = SetColVisibleUndoMutationFactory(accessor, redoMutationParams);
const undoSetSelectionsOperationParams: ISetSelectionsOperationParams = {
unitId,
subUnitId,
@@ -80,8 +84,6 @@ export const SetSpecificColsVisibleCommand: ICommand<ISetSpecificColsVisibleComm
})),
};
- const commandService = accessor.get(ICommandService);
-
const result = sequenceExecute([
{ id: SetColVisibleMutation.id, params: redoMutationParams },
{ id: SetSelectionsOperation.id, params: setSelectionOperationParams },
@@ -122,28 +124,19 @@ export const SetSelectedColsVisibleCommand: ICommand = {
id: 'sheet.command.set-selected-cols-visible',
handler: async (accessor: IAccessor) => {
const selectionManagerService = accessor.get(SelectionManagerService);
- const ranges = selectionManagerService
- .getSelections()
- ?.map((s) => s.range)
- .filter((r) => r.rangeType === RANGE_TYPE.COLUMN);
- if (!ranges?.length) {
- return false;
- }
+ const commandService = accessor.get(ICommandService);
- const univerInstanceService = accessor.get(IUniverInstanceService);
- const workbook = univerInstanceService.getCurrentUnitForType<Workbook>(UniverInstanceType.UNIVER_SHEET);
- if (!workbook) return false;
- const worksheet = workbook.getActiveSheet();
- if (!worksheet) return false;
+ const ranges = selectionManagerService.getSelections()?.map((s) => s.range).filter((r) => r.rangeType === RANGE_TYPE.COLUMN);
+ if (!ranges?.length) return false;
+
+ const target = getSheetCommandTarget(accessor.get(IUniverInstanceService));
+ if (!target) return false;
- const unitId = workbook.getUnitId();
- const subUnitId = worksheet.getSheetId();
+ const { worksheet, unitId, subUnitId } = target;
// `ranges` would not overlap each other, so `hiddenRanges` would not overlap each other either
const hiddenRanges = ranges.map((r) => worksheet.getHiddenCols(r.startColumn, r.endColumn)).flat();
- return accessor
- .get(ICommandService)
- .executeCommand<ISetSpecificColsVisibleCommandParams>(SetSpecificColsVisibleCommand.id, {
+ return commandService.executeCommand<ISetSpecificColsVisibleCommandParams>(SetSpecificColsVisibleCommand.id, {
unitId,
subUnitId,
ranges: hiddenRanges,
@@ -157,23 +150,20 @@ export const SetColHiddenCommand: ICommand = {
handler: async (accessor: IAccessor) => {
const selectionManagerService = accessor.get(SelectionManagerService);
const sheetInterceptorService = accessor.get(SheetInterceptorService);
+ const univerInstanceService = accessor.get(IUniverInstanceService);
+ const commandService = accessor.get(ICommandService);
- const ranges = selectionManagerService.getSelections()?.map((s) => s.range).filter((r) => r.rangeType === RANGE_TYPE.COLUMN);
- if (!ranges?.length) {
- return false;
- }
+ let ranges = selectionManagerService.getSelections()?.map((s) => s.range).filter((r) => r.rangeType === RANGE_TYPE.COLUMN);
+ if (!ranges?.length) return false;
- const univerInstanceService = accessor.get(IUniverInstanceService);
- const workbook = univerInstanceService.getCurrentUnitForType<Workbook>(UniverInstanceType.UNIVER_SHEET);
- if (!workbook) return false;
- const worksheet = workbook.getActiveSheet();
- if (!worksheet) return false;
-
- const unitId = workbook.getUnitId();
- const subUnitId = worksheet.getSheetId();
- const redoMutationParams: ISetColHiddenMutationParams = {
- unitId, subUnitId, ranges,
- };
+ const target = getSheetCommandTarget(univerInstanceService);
+ if (!target) return false;
+
+ const { worksheet, unitId, subUnitId } = target;
+
+ ranges = divideRangesByHiddenCols(target.worksheet, ranges);
+
+ const redoMutationParams: ISetColHiddenMutationParams = { unitId, subUnitId, ranges };
const setSelectionOperationParams: ISetSelectionsOperationParams = {
unitId, subUnitId, pluginName: NORMAL_SELECTION_PLUGIN_NAME,
selections: getSelectionsAfterHiding(ranges).map((range) => ({
@@ -182,6 +172,8 @@ export const SetColHiddenCommand: ICommand = {
style: null,
})),
};
+
+ const undoMutationParams = SetColHiddenUndoMutationFactory(accessor, redoMutationParams);
const undoSetSelectionsOperationParams: ISetSelectionsOperationParams = {
unitId, subUnitId, pluginName: NORMAL_SELECTION_PLUGIN_NAME,
selections: ranges.map((range) => ({
@@ -191,8 +183,6 @@ export const SetColHiddenCommand: ICommand = {
})),
};
- const commandService = accessor.get(ICommandService);
-
const result = sequenceExecute([
{ id: SetColHiddenMutation.id, params: redoMutationParams },
{ id: SetSelectionsOperation.id, params: setSelectionOperationParams },
@@ -207,7 +197,6 @@ export const SetColHiddenCommand: ICommand = {
if (result.result && interceptedResult.result) {
const undoRedoService = accessor.get(IUndoRedoService);
- const undoMutationParams = SetColHiddenUndoMutationFactory(accessor, redoMutationParams);
undoRedoService.pushUndoRedo({
unitID: unitId,
undoMutations: [
@@ -229,6 +218,33 @@ export const SetColHiddenCommand: ICommand = {
},
};
+export function divideRangesByHiddenCols(worksheet: Worksheet, ranges: IRange[]): IRange[] {
+ const endRow = worksheet.getRowCount() - 1;
+ const hiddenCols = worksheet.getHiddenCols();
+ const divided: IRange[] = [];
+
+ ranges.forEach((range) => {
+ const hiddenColsInSelection = hiddenCols.filter((c) => c.startColumn >= range.startColumn && c.endColumn <= range.endColumn);
+ if (hiddenColsInSelection.length) {
+ let startColumn = range.startColumn;
+ hiddenColsInSelection.forEach((hiddenRange) => {
+ if (hiddenRange.startColumn > startColumn) {
+ divided.push({ startColumn, endColumn: hiddenRange.startColumn - 1, startRow: 0, endRow });
+ startColumn = hiddenRange.endColumn + 1;
+ }
+ });
+
+ if (startColumn <= range.endColumn) {
+ divided.push({ startColumn, endColumn: range.endColumn, startRow: 0, endRow });
+ }
+ } else {
+ divided.push(range);
+ }
+ });
+
+ return divided;
+}
+
/**
* Get the selections after hiding cols.
* @param worksheet the worksheet the command invoked on
diff --git a/packages/sheets/src/commands/commands/set-row-visible.command.ts b/packages/sheets/src/commands/commands/set-row-visible.command.ts
index 3f4c0a074e..04eb2ccac2 100644
--- a/packages/sheets/src/commands/commands/set-row-visible.command.ts
+++ b/packages/sheets/src/commands/commands/set-row-visible.command.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { ICommand, IRange, Nullable, Workbook } from '@univerjs/core';
+import type { ICommand, IRange, Nullable, Worksheet } from '@univerjs/core';
import {
CommandType,
ICommandService,
@@ -22,7 +22,6 @@ import {
IUniverInstanceService,
RANGE_TYPE,
sequenceExecute,
- UniverInstanceType,
} from '@univerjs/core';
import type { IAccessor } from '@wendellhu/redi';
@@ -55,17 +54,11 @@ export const SetSpecificRowsVisibleCommand: ICommand<ISetSpecificRowsVisibleComm
const undoRedoService = accessor.get(IUndoRedoService);
const sheetInterceptorService = accessor.get(SheetInterceptorService);
- const worksheet = accessor
- .get(IUniverInstanceService)
- .getUniverSheetInstance(unitId)!
- .getSheetBySheetId(subUnitId)!;
+ const target = getSheetCommandTarget(accessor.get(IUniverInstanceService), { unitId, subUnitId });
+ if (!target) return false;
- const redoMutationParams: ISetRowVisibleMutationParams = {
- unitId,
- subUnitId,
- ranges,
- };
- const undoMutationParams = SetRowVisibleUndoMutationFactory(accessor, redoMutationParams);
+ const { worksheet } = target;
+ const redoMutationParams: ISetRowVisibleMutationParams = { unitId, subUnitId, ranges };
const setSelectionOperationParams: ISetSelectionsOperationParams = {
unitId,
subUnitId,
@@ -76,6 +69,8 @@ export const SetSpecificRowsVisibleCommand: ICommand<ISetSpecificRowsVisibleComm
style: null,
})),
};
+
+ const undoMutationParams = SetRowVisibleUndoMutationFactory(accessor, redoMutationParams);
const undoSetSelectionsOperationParams: ISetSelectionsOperationParams = {
unitId,
subUnitId,
@@ -129,26 +124,17 @@ export const SetSelectedRowsVisibleCommand: ICommand = {
handler: async (accessor: IAccessor) => {
const selectionManagerService = accessor.get(SelectionManagerService);
const univerInstanceService = accessor.get(IUniverInstanceService);
+ const commandService = accessor.get(ICommandService);
- const ranges = selectionManagerService
- .getSelections()
- ?.map((s) => s.range)
- .filter((r) => r.rangeType === RANGE_TYPE.ROW);
- if (!ranges?.length) {
- return false;
- }
+ const ranges = selectionManagerService.getSelections()?.map((s) => s.range).filter((r) => r.rangeType === RANGE_TYPE.ROW);
+ if (!ranges?.length) return false;
- const workbook = univerInstanceService.getCurrentUnitForType<Workbook>(UniverInstanceType.UNIVER_SHEET);
- if (!workbook) return false;
- const worksheet = workbook.getActiveSheet();
- if (!worksheet) return false;
+ const target = getSheetCommandTarget(univerInstanceService);
+ if (!target) return false;
- const unitId = workbook.getUnitId();
- const subUnitId = worksheet.getSheetId();
+ const { worksheet, unitId, subUnitId } = target;
const hiddenRanges = ranges.map((r) => worksheet.getHiddenRows(r.startRow, r.endRow)).flat();
- return accessor
- .get(ICommandService)
- .executeCommand<ISetSpecificRowsVisibleCommandParams>(SetSpecificRowsVisibleCommand.id, {
+ return commandService.executeCommand<ISetSpecificRowsVisibleCommandParams>(SetSpecificRowsVisibleCommand.id, {
unitId,
subUnitId,
ranges: hiddenRanges,
@@ -166,30 +152,29 @@ export const SetRowHiddenCommand: ICommand = {
const univerInstanceService = accessor.get(IUniverInstanceService);
const sheetInterceptorService = accessor.get(SheetInterceptorService);
- const ranges = selectionManagerService.getSelections()?.map((s) => s.range).filter((r) => r.rangeType === RANGE_TYPE.ROW);
-
- if (!ranges?.length) {
- return false;
- }
+ // Ranges should be divided by already hidden rows.
+ let ranges = selectionManagerService.getSelections()?.map((s) => s.range).filter((r) => r.rangeType === RANGE_TYPE.ROW);
+ if (!ranges?.length) return false;
const target = getSheetCommandTarget(univerInstanceService);
if (!target) return false;
- const { unitId, subUnitId, worksheet } = target;
+ ranges = divideRangesByHiddenRows(target.worksheet, ranges);
- const redoMutationParams: ISetRowHiddenMutationParams = {
+ const { unitId, subUnitId, worksheet } = target;
+ const redoMutationParams: ISetRowHiddenMutationParams = { unitId, subUnitId, ranges };
+ const setSelectionOperationParams: ISetSelectionsOperationParams = {
unitId,
subUnitId,
- ranges,
- };
- const setSelectionOperationParams: ISetSelectionsOperationParams = {
- unitId, subUnitId, pluginName: NORMAL_SELECTION_PLUGIN_NAME,
+ pluginName: NORMAL_SELECTION_PLUGIN_NAME,
selections: getSelectionsAfterHiding(ranges).map((range) => ({
range,
primary: getPrimaryForRange(range, worksheet),
style: null,
})),
};
+
+ const undoMutationParams = SetRowHiddenUndoMutationFactory(accessor, redoMutationParams);
const undoSetSelectionsOperationParams: ISetSelectionsOperationParams = {
unitId, subUnitId, pluginName: NORMAL_SELECTION_PLUGIN_NAME,
selections: ranges.map((range) => ({
@@ -199,25 +184,15 @@ export const SetRowHiddenCommand: ICommand = {
})),
};
- const undoMutationParams = SetRowHiddenUndoMutationFactory(accessor, redoMutationParams);
-
- const intercepted = sheetInterceptorService.onCommandExecute({
- id: SetRowHiddenCommand.id,
- params: redoMutationParams,
- });
-
- if (intercepted.preRedos && intercepted.preRedos.length > 0) {
- sequenceExecute([...intercepted.preRedos], commandService);
- }
-
- const result = sequenceExecute([
+ const intercepted = sheetInterceptorService.onCommandExecute({ id: SetRowHiddenCommand.id, params: redoMutationParams });
+ const execution = sequenceExecute([
+ ...(intercepted.preRedos ?? []),
{ id: SetRowHiddenMutation.id, params: redoMutationParams },
{ id: SetSelectionsOperation.id, params: setSelectionOperationParams },
+ ...intercepted.redos,
], commandService);
- const interceptedResult = sequenceExecute([...intercepted.redos], commandService);
-
- if (result.result && interceptedResult.result) {
+ if (execution.result) {
undoRedoService.pushUndoRedo({
unitID: unitId,
undoMutations: [
@@ -239,6 +214,34 @@ export const SetRowHiddenCommand: ICommand = {
},
};
+// TODO@wzhudev: this should be unit tested
+export function divideRangesByHiddenRows(worksheet: Worksheet, ranges: IRange[]): IRange[] {
+ const endCol = worksheet.getMaxColumns() - 1;
+ const hiddenRows = worksheet.getHiddenRows();
+ const divided: IRange[] = [];
+
+ ranges.forEach((range) => {
+ const hiddenRowsInThisRange = hiddenRows.filter((r) => r.startRow >= range.startRow && r.endRow <= range.endRow);
+ if (hiddenRowsInThisRange.length) {
+ let startRow = range.startRow;
+ hiddenRowsInThisRange.forEach((hiddenRange) => {
+ if (hiddenRange.startRow > startRow) {
+ divided.push({ startRow, endRow: hiddenRange.startRow - 1, startColumn: 0, endColumn: endCol });
+ startRow = hiddenRange.endRow + 1;
+ }
+ });
+
+ if (startRow <= range.endRow) {
+ divided.push({ startRow, endRow: range.endRow, startColumn: 0, endColumn: endCol });
+ }
+ } else {
+ divided.push(range);
+ }
+ });
+
+ return divided;
+}
+
function getSelectionsAfterHiding(ranges: IRange[]): IRange[] {
const merged = mergeSelections(ranges);
return merged.map((range) => {
@@ -253,6 +256,7 @@ function getSelectionsAfterHiding(ranges: IRange[]): IRange[] {
function mergeSelections(ranges: IRange[]): IRange[] {
const merged: IRange[] = [];
+
let current: Nullable<IRange>;
ranges
.sort((a, b) => a.startRow - b.startRow)
@@ -269,6 +273,7 @@ function mergeSelections(ranges: IRange[]): IRange[] {
current = range;
}
});
+
merged.push(current!);
return merged;
}