@univerjs/sheets 1.0.4 → 1.2.0

package/lib/es/facade.js

@@ -1,6 +1,6 @@
 import { BooleanNumber, CanceledError, DEFAULT_STYLES, Dimension, Direction, HorizontalAlign, IAuthzIoService, ICommandService, ILogService, IPermissionService, IResourceLoaderService, IUniverInstanceService, Inject, Injector, LocaleService, ObjectMatrix, RANGE_TYPE, Rectangle, RedoCommand, RichTextValue, TextStyleValue, Tools, UndoCommand, UniverInstanceType, VerticalAlign, WorksheetHiddenState, WrapStrategy, cellToRange, covertCellValue, covertCellValues, generateIntervalsByPoints, generateRandomId, getDisplayValueFromCell, getOriginCellValue, isNullCell, mergeWorksheetSnapshotWithDefault, toDisposable } from "@univerjs/core";
 import { FBase, FBaseInitialable, FEnum, FEventName, FUniver } from "@univerjs/core/facade";
-import { AddRangeProtectionMutation, AddWorksheetProtectionMutation, AppendRowCommand, AutoFillCommand, COMMAND_LISTENER_VALUE_CHANGE, CancelFrozenCommand, ClearSelectionAllCommand, ClearSelectionContentCommand, ClearSelectionFormatCommand, CopySheetCommand, DeleteRangeMoveLeftCommand, DeleteRangeMoveUpCommand, DeleteRangeProtectionMutation, DeleteWorksheetProtectionMutation, DeleteWorksheetRangeThemeStyleCommand, EditStateEnum, InsertColByRangeCommand, InsertRangeMoveDownCommand, InsertRangeMoveRightCommand, InsertRowByRangeCommand, InsertSheetCommand, MoveColsCommand, MoveRowsCommand, RangeProtectionPermissionDeleteProtectionPoint, RangeProtectionPermissionEditPoint, RangeProtectionPermissionManageCollaPoint, RangeProtectionPermissionViewPoint, RangeProtectionRuleModel, RangeThemeStyle, RegisterWorksheetRangeThemeStyleCommand, RemoveColByRangeCommand, RemoveDefinedNameCommand, RemoveRowByRangeCommand, RemoveSheetCommand, RemoveWorksheetMergeCommand, SCOPE_WORKBOOK_VALUE_DEFINED_NAME, SetBorderBasicCommand, SetColDataCommand, SetColHiddenCommand, SetColWidthCommand, SetDefinedNameCommand, SetFrozenCommand, SetGridlinesColorCommand, SetHorizontalTextAlignCommand, SetRangeCustomMetadataCommand, SetRangeProtectionMutation, SetRangeValuesCommand, SetRowDataCommand, SetRowHeightCommand, SetRowHiddenCommand, SetSelectionsOperation, SetShrinkToFitCommand, SetSpecificColsVisibleCommand, SetSpecificRowsVisibleCommand, SetStyleCommand, SetTabColorCommand, SetTabColorMutation, SetTextRotationCommand, SetTextWrapCommand, SetVerticalTextAlignCommand, SetWorkbookNameCommand, SetWorksheetActiveOperation, SetWorksheetColumnCountCommand, SetWorksheetDefaultStyleMutation, SetWorksheetHideCommand, SetWorksheetHideMutation, SetWorksheetNameCommand, SetWorksheetOrderCommand, SetWorksheetOrderMutation, SetWorksheetRangeThemeStyleCommand, SetWorksheetRowCountCommand, SetWorksheetRowIsAutoHeightCommand, SetWorksheetRowIsAutoHeightMutation, SetWorksheetShowCommand, SheetRangeThemeService, SheetSkeletonChangeType, SheetValueChangeType, SheetsFreezeSyncController, SheetsSelectionsService, SplitDelimiterEnum, SplitTextToColumnsCommand, ToggleGridlinesCommand, UnregisterWorksheetRangeThemeStyleCommand, ViewStateEnum, WorkbookCommentPermission, WorkbookCopyPermission, WorkbookCopySheetPermission, WorkbookCreateProtectPermission, WorkbookCreateSheetPermission, WorkbookDeleteColumnPermission, WorkbookDeleteRowPermission, WorkbookDeleteSheetPermission, WorkbookDuplicatePermission, WorkbookEditablePermission, WorkbookExportPermission, WorkbookHideSheetPermission, WorkbookInsertColumnPermission, WorkbookInsertRowPermission, WorkbookManageCollaboratorPermission, WorkbookMoveSheetPermission, WorkbookPrintPermission, WorkbookRecoverHistoryPermission, WorkbookRenameSheetPermission, WorkbookSharePermission, WorkbookViewHistoryPermission, WorkbookViewPermission, WorksheetCopyPermission, WorksheetDeleteColumnPermission, WorksheetDeleteProtectionPermission, WorksheetDeleteRowPermission, WorksheetEditExtraObjectPermission, WorksheetEditPermission, WorksheetFilterPermission, WorksheetInsertColumnPermission, WorksheetInsertHyperlinkPermission, WorksheetInsertRowPermission, WorksheetManageCollaboratorPermission, WorksheetPivotTablePermission, WorksheetProtectionPointModel, WorksheetProtectionRuleModel, WorksheetSelectProtectedCellsPermission, WorksheetSelectUnProtectedCellsPermission, WorksheetSetCellStylePermission, WorksheetSetCellValuePermission, WorksheetSetColumnStylePermission, WorksheetSetRowStylePermission, WorksheetSortPermission, WorksheetViewPermission, addMergeCellsUtil, copyRangeStyles, getAddMergeMutationRangeByType, getAllWorksheetPermissionPoint, getAllWorksheetPermissionPointByPointPanel, getNextPrimaryCell, getPrimaryForRange, getValueChangedEffectedRange, validateDefinedName } from "@univerjs/sheets";
+import { AddRangeProtectionMutation, AddWorksheetProtectionMutation, AppendRowCommand, AutoFillCommand, COMMAND_LISTENER_VALUE_CHANGE, CancelFrozenCommand, ClearSelectionAllCommand, ClearSelectionContentCommand, ClearSelectionFormatCommand, CopySheetCommand, DeleteRangeMoveLeftCommand, DeleteRangeMoveUpCommand, DeleteRangeProtectionMutation, DeleteWorksheetProtectionMutation, DeleteWorksheetRangeThemeStyleCommand, EditStateEnum, InsertColByRangeCommand, InsertRangeMoveDownCommand, InsertRangeMoveRightCommand, InsertRowByRangeCommand, InsertSheetCommand, MoveColsCommand, MoveRowsCommand, RangeProtectionPermissionDeleteProtectionPoint, RangeProtectionPermissionEditPoint, RangeProtectionPermissionManageCollaPoint, RangeProtectionPermissionViewPoint, RangeProtectionRuleModel, RangeThemeStyle, RegisterWorksheetRangeThemeStyleCommand, RemoveColByRangeCommand, RemoveDefinedNameCommand, RemoveRowByRangeCommand, RemoveSheetCommand, RemoveWorksheetMergeCommand, SCOPE_WORKBOOK_VALUE_DEFINED_NAME, SetBorderBasicCommand, SetColDataCommand, SetColHiddenCommand, SetColWidthCommand, SetDefinedNameCommand, SetFrozenCommand, SetGridlinesColorCommand, SetHorizontalTextAlignCommand, SetRangeCustomMetadataCommand, SetRangeProtectionMutation, SetRangeValuesCommand, SetRowDataCommand, SetRowHeightCommand, SetRowHiddenCommand, SetSelectionsOperation, SetShrinkToFitCommand, SetSpecificColsVisibleCommand, SetSpecificRowsVisibleCommand, SetStyleCommand, SetTabColorCommand, SetTabColorMutation, SetTextRotationCommand, SetTextWrapCommand, SetVerticalTextAlignCommand, SetWorkbookCalculationSettingsCommand, SetWorkbookNameCommand, SetWorksheetActiveOperation, SetWorksheetColumnCountCommand, SetWorksheetDefaultStyleMutation, SetWorksheetHideCommand, SetWorksheetHideMutation, SetWorksheetNameCommand, SetWorksheetOrderCommand, SetWorksheetOrderMutation, SetWorksheetRangeThemeStyleCommand, SetWorksheetRowCountCommand, SetWorksheetRowIsAutoHeightCommand, SetWorksheetRowIsAutoHeightMutation, SetWorksheetShowCommand, SheetRangeThemeService, SheetSkeletonChangeType, SheetValueChangeType, SheetsFreezeSyncController, SheetsSelectionsService, SplitDelimiterEnum, SplitTextToColumnsCommand, ToggleGridlinesCommand, UnregisterWorksheetRangeThemeStyleCommand, ViewStateEnum, WorkbookCommentPermission, WorkbookCopyPermission, WorkbookCopySheetPermission, WorkbookCreateProtectPermission, WorkbookCreateSheetPermission, WorkbookDeleteColumnPermission, WorkbookDeleteRowPermission, WorkbookDeleteSheetPermission, WorkbookDuplicatePermission, WorkbookEditablePermission, WorkbookExportPermission, WorkbookHideSheetPermission, WorkbookInsertColumnPermission, WorkbookInsertRowPermission, WorkbookManageCollaboratorPermission, WorkbookMoveSheetPermission, WorkbookPrintPermission, WorkbookRecoverHistoryPermission, WorkbookRenameSheetPermission, WorkbookSharePermission, WorkbookViewHistoryPermission, WorkbookViewPermission, WorksheetCopyPermission, WorksheetDeleteColumnPermission, WorksheetDeleteProtectionPermission, WorksheetDeleteRowPermission, WorksheetEditExtraObjectPermission, WorksheetEditPermission, WorksheetFilterPermission, WorksheetInsertColumnPermission, WorksheetInsertHyperlinkPermission, WorksheetInsertRowPermission, WorksheetManageCollaboratorPermission, WorksheetPivotTablePermission, WorksheetProtectionPointModel, WorksheetProtectionRuleModel, WorksheetSelectProtectedCellsPermission, WorksheetSelectUnProtectedCellsPermission, WorksheetSetCellStylePermission, WorksheetSetCellValuePermission, WorksheetSetColumnStylePermission, WorksheetSetRowStylePermission, WorksheetSortPermission, WorksheetViewPermission, addMergeCellsUtil, copyRangeStyles, getAddMergeMutationRangeByType, getAllWorksheetPermissionPoint, getAllWorksheetPermissionPointByPointPanel, getNextPrimaryCell, getPrimaryForRange, getValueChangedEffectedRange, validateDefinedName } from "@univerjs/sheets";
 import { FormulaDataModel, IDefinedNamesService, IFunctionService, ISuperTableService, deserializeRangeWithSheet, serializeRange, serializeRangeWithSheet } from "@univerjs/engine-formula";
 import { ObjectScope, UnitAction, UnitObject, UnitRole } from "@univerjs/protocol";
 
@@ -23,7 +23,7 @@ import { ObjectScope, UnitAction, UnitObject, UnitRole } from "@univerjs/protoco
 const SHEETS_CUSTOM_FIELD_WARNING_MESSAGE = "[Facade]: The sheets custom field is not recommended for external use. Use it at your own risk.";
 
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/typeof.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
 	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -34,7 +34,7 @@ function _typeof(o) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPrimitive.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -47,14 +47,14 @@ function toPrimitive(t, r) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/toPropertyKey.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/defineProperty.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -65,7 +65,7 @@ function _defineProperty(e, r, t) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateParam.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/decorateParam.js
 function __decorateParam(paramIndex, decorator) {
 	return function(target, key) {
 		decorator(target, key, paramIndex);
@@ -73,7 +73,7 @@ function __decorateParam(paramIndex, decorator) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorate.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -6545,6 +6545,7 @@ let FRange = _FRange = class FRange extends FBaseInitialable {
 	* Returns a copy of the range expanded `Direction.UP` and `Direction.DOWN` if the specified dimension is `Dimension.ROWS`, or `Direction.NEXT` and `Direction.PREVIOUS` if the dimension is `Dimension.COLUMNS`.
 	* The expansion of the range is based on detecting data next to the range that is organized like a table.
 	* The expanded range covers all adjacent cells with data in them along the specified dimension including the table boundaries.
+	* Cells connected only diagonally do not cause the range to expand.
 	* If the original range is surrounded by empty cells along the specified dimension, the range itself is returned.
 	* @param {Dimension} [dimension] - The dimension along which to expand the range. If not provided, the range will be expanded in both dimensions.
 	* @returns {FRange} The range's data region or a range covering each column or each row spanned by the original range.
@@ -6565,7 +6566,7 @@ let FRange = _FRange = class FRange extends FBaseInitialable {
 	* fWorksheet.getRange('D3').setValue(100);
 	* fWorksheet.getRange('C4').setValue(100);
 	*
-	* // Get C3 data region along the rows dimension, the range will be C2:D4
+	* // Get C3 data region along the rows dimension, the range will be C2:C4
 	* const range = fWorksheet.getRange('C3').getDataRegion(univerAPI.Enum.Dimension.ROWS);
 	* console.log(range.getA1Notation()); // C2:C4
 	*
@@ -6579,41 +6580,43 @@ let FRange = _FRange = class FRange extends FBaseInitialable {
 	* ```
 	*/
 	getDataRegion(dimension) {
-		const { startRow, startColumn, endRow, endColumn } = this._range;
+		let { startRow, startColumn, endRow, endColumn } = this._range;
 		const maxRows = this._worksheet.getMaxRows();
 		const maxColumns = this._worksheet.getMaxColumns();
 		const cellMatrix = this._worksheet.getCellMatrix();
-		let newStartRow = startRow;
-		let newStartColumn = startColumn;
-		let newEndRow = endRow;
-		let newEndColumn = endColumn;
-		if (dimension !== Dimension.COLUMNS) {
-			let topRowHasValue = false;
-			let bottomRowHasValue = false;
-			for (let c = startColumn; c <= endColumn; c++) {
-				if (startRow > 0 && !isNullCell(cellMatrix.getValue(startRow - 1, c))) topRowHasValue = true;
-				if (endRow < maxRows - 1 && !isNullCell(cellMatrix.getValue(endRow + 1, c))) bottomRowHasValue = true;
-				if (topRowHasValue && bottomRowHasValue) break;
+		const rowHasData = (row) => {
+			for (let c = startColumn; c <= endColumn; c++) if (!isNullCell(cellMatrix.getValue(row, c))) return true;
+			return false;
+		};
+		const columnHasData = (column) => {
+			for (let r = startRow; r <= endRow; r++) if (!isNullCell(cellMatrix.getValue(r, column))) return true;
+			return false;
+		};
+		let expanded = true;
+		while (expanded) {
+			expanded = false;
+			while (dimension !== Dimension.COLUMNS && startRow > 0 && rowHasData(startRow - 1)) {
+				startRow--;
+				expanded = true;
 			}
-			if (topRowHasValue) newStartRow = startRow - 1;
-			if (bottomRowHasValue) newEndRow = endRow + 1;
-		}
-		if (dimension !== Dimension.ROWS) {
-			let leftColumnHasValue = false;
-			let rightColumnHasValue = false;
-			for (let r = startRow; r <= endRow; r++) {
-				if (startColumn > 0 && !isNullCell(cellMatrix.getValue(r, startColumn - 1))) leftColumnHasValue = true;
-				if (endColumn < maxColumns - 1 && !isNullCell(cellMatrix.getValue(r, endColumn + 1))) rightColumnHasValue = true;
-				if (leftColumnHasValue && rightColumnHasValue) break;
+			while (dimension !== Dimension.COLUMNS && endRow < maxRows - 1 && rowHasData(endRow + 1)) {
+				endRow++;
+				expanded = true;
+			}
+			while (dimension !== Dimension.ROWS && startColumn > 0 && columnHasData(startColumn - 1)) {
+				startColumn--;
+				expanded = true;
+			}
+			while (dimension !== Dimension.ROWS && endColumn < maxColumns - 1 && columnHasData(endColumn + 1)) {
+				endColumn++;
+				expanded = true;
 			}
-			if (leftColumnHasValue) newStartColumn = startColumn - 1;
-			if (rightColumnHasValue) newEndColumn = endColumn + 1;
 		}
 		return this._injector.createInstance(_FRange, this._workbook, this._worksheet, {
-			startRow: newStartRow,
-			startColumn: newStartColumn,
-			endRow: newEndRow,
-			endColumn: newEndColumn
+			startRow,
+			startColumn,
+			endRow,
+			endColumn
 		});
 	}
 	/**
@@ -8110,6 +8113,43 @@ let FWorkbook = class FWorkbook extends FBaseInitialable {
 	removeStyles(styleKeys) {
 		this._workbook.removeStyles(styleKeys);
 	}
+	/**
+	* Get the workbook's iterative calculation settings.
+	* Missing or invalid settings use the defaults: iteration disabled, 100 iterations and a maximum change of 0.001.
+	* @returns {IWorkbookCalculationSettings} A copy of the normalized workbook calculation settings.
+	* @example
+	* ```ts
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const settings = fWorkbook.getCalculationSettings();
+	* console.log(settings.iterativeCalculation, settings.maxIterations, settings.maxChange);
+	* ```
+	*/
+	getCalculationSettings() {
+		return this._workbook.getCalculationSettings();
+	}
+	/**
+	* Set iterative calculation settings for the entire workbook through an undoable command.
+	* @param {IWorkbookCalculationSettings} settings The complete calculation settings.
+	* Set `iterativeCalculation` to enable or disable iterative evaluation of circular references.
+	* `maxIterations` must be an integer from 1 to 32767, and `maxChange` must be a finite positive number.
+	* @returns {boolean} Whether the settings command succeeded. Returns false if the workbook cannot be edited or found.
+	* @example
+	* ```ts
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const success = fWorkbook.setCalculationSettings({
+	*     iterativeCalculation: true,
+	*     maxIterations: 100,
+	*     maxChange: 0.001,
+	* });
+	* console.log('Calculation settings updated:', success);
+	* ```
+	*/
+	setCalculationSettings(settings) {
+		return this._commandService.syncExecuteCommand(SetWorkbookCalculationSettingsCommand.id, {
+			unitId: this.id,
+			settings
+		});
+	}
 };
 FWorkbook = __decorate([
 	__decorateParam(1, Inject(Injector)),