@univerjs/sheets 1.0.4 → 1.2.0

package/lib/types/commands/commands/set-workbook-calculation-settings.command.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 { ISetWorkbookCalculationSettingsMutationParams } from '../mutations/set-workbook-calculation-settings.mutation';
+export declare const SetWorkbookCalculationSettingsCommand: ICommand<ISetWorkbookCalculationSettingsMutationParams>;

package/lib/types/commands/mutations/set-workbook-calculation-settings.mutation.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 { IMutation, IWorkbookCalculationSettings } from '@univerjs/core';
+export interface ISetWorkbookCalculationSettingsMutationParams {
+    unitId: string;
+    settings: IWorkbookCalculationSettings;
+}
+export declare const SetWorkbookCalculationSettingsMutation: IMutation<ISetWorkbookCalculationSettingsMutationParams>;

package/lib/types/config/config.d.ts

@@ -47,6 +47,14 @@ export interface IUniverSheetsConfig {
      * default false, auto height works for merged cells
      */
     autoHeightForMergedCells?: boolean;
+    /**
+     * Extra space in pixels between lines of cell text, including rich text and cell editors.
+     * Applies at initialization to all workbooks in this Univer instance. Existing row heights
+     * are unchanged until auto-resized; fixed-height cells may clip additional text.
+     * Must be finite and non-negative.
+     * @default 0
+     */
+    textLineGap?: number;
     /**
      * Whether synchronize the frozen state to other users in real-time collaboration.
      * @default true

package/lib/types/controllers/auto-fill.controller.d.ts

@@ -31,6 +31,9 @@ export declare class AutoFillController extends Disposable {
     private _getCopyData;
     private _getEmptyCopyDataPiece;
     private _getMergeApplyData;
+    private _getFillCells;
+    private _prepareFillData;
+    private _getRemoveMergeMutations;
     private _fillData;
     private _shouldDisableSeries;
     private _getPreferredApplyType;

package/lib/types/controllers/permission/sheet-permission-check.controller.d.ts

@@ -15,10 +15,11 @@
  */
 import type { IPermissionTypes, IRange } from '@univerjs/core';
 import { Disposable, DisposableCollection, ICommandService, IPermissionService, IUniverInstanceService, LocaleService } from '@univerjs/core';
-import { IDefinedNamesService, LexerTreeBuilder } from '@univerjs/engine-formula';
+import { FormulaDataModel, IDefinedNamesService, IFunctionService, LexerTreeBuilder } from '@univerjs/engine-formula';
 import { RangeProtectionRuleModel } from '../../models/range-protection-rule.model';
-import { WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission';
-import { SheetsSelectionsService } from '../../services/selections';
+import { IAutoFillService } from '../../services/auto-fill/auto-fill.service';
+import { WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission/worksheet-permission-rule.model';
+import { SheetsSelectionsService } from '../../services/selections/selection.service';
 export declare class SheetPermissionCheckController extends Disposable {
     private readonly _commandService;
     private readonly _univerInstanceService;
@@ -29,10 +30,13 @@ export declare class SheetPermissionCheckController extends Disposable {
     private readonly _localeService;
     private readonly _lexerTreeBuilder;
     private readonly _definedNamesService;
+    private readonly _autoFillService;
+    private readonly _formulaDataModel;
+    private readonly _functionService;
     disposableCollection: DisposableCollection;
     private _triggerPermissionUIEvent$;
     triggerPermissionUIEvent$: import("rxjs").Observable<string>;
-    constructor(_commandService: ICommandService, _univerInstanceService: IUniverInstanceService, _permissionService: IPermissionService, _selectionManagerService: SheetsSelectionsService, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _localeService: LocaleService, _lexerTreeBuilder: LexerTreeBuilder, _definedNamesService: IDefinedNamesService);
+    constructor(_commandService: ICommandService, _univerInstanceService: IUniverInstanceService, _permissionService: IPermissionService, _selectionManagerService: SheetsSelectionsService, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _localeService: LocaleService, _lexerTreeBuilder: LexerTreeBuilder, _definedNamesService: IDefinedNamesService, _autoFillService: IAutoFillService, _formulaDataModel: FormulaDataModel, _functionService: IFunctionService);
     private _initialize;
     private _commandExecutedListener;
     blockExecuteWithoutPermission(errorMsg: string): void;
@@ -40,6 +44,8 @@ export declare class SheetPermissionCheckController extends Disposable {
     permissionCheckWithRanges(permissionTypes: IPermissionTypes, selectionRanges?: IRange[], unitId?: string, subUnitId?: string): boolean;
     permissionCheckWithoutRange(permissionTypes: IPermissionTypes, unitId?: string, subUnitId?: string): boolean;
     private _permissionCheckWithFormula;
+    private _getFormulaReferenceWorkbook;
+    private _permissionCheckFormulaReferences;
     private _permissionCheckBySetRangeValue;
     private _permissionCheckByMoveRowsColsCommand;
     private _permissionCheckByMoveRangeCommand;

package/lib/types/facade/f-range.d.ts

@@ -1622,6 +1622,7 @@ export declare 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.
@@ -1642,7 +1643,7 @@ export declare 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
      *

package/lib/types/facade/f-workbook.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { CommandListener, CustomData, IDisposable, IRange, IStyleData, IWorkbookData, IWorksheetData, Workbook } from '@univerjs/core';
+import type { CommandListener, CustomData, IDisposable, IRange, IStyleData, IWorkbookCalculationSettings, IWorkbookData, IWorksheetData, Workbook } from '@univerjs/core';
 import type { ISetDefinedNameMutationParam } from '@univerjs/engine-formula';
 import type { IRangeThemeStyleJSON } from '@univerjs/sheets';
 import { ICommandService, ILogService, Injector, IPermissionService, IResourceLoaderService, IUniverInstanceService } from '@univerjs/core';
@@ -763,4 +763,34 @@ export declare class FWorkbook extends FBaseInitialable {
      * ```
      */
     removeStyles(styleKeys: string[]): void;
+    /**
+     * 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(): IWorkbookCalculationSettings;
+    /**
+     * 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: IWorkbookCalculationSettings): boolean;
 }

package/lib/types/index.d.ts

@@ -102,6 +102,7 @@ export type { ISetRowHiddenCommandParams, ISetSpecificRowsVisibleCommandParams,
 export { AFFECT_LAYOUT_STYLES, ResetBackgroundColorCommand, ResetTextColorCommand, SetBackgroundColorCommand, SetBoldCommand, SetFontFamilyCommand, SetFontSizeCommand, SetHorizontalTextAlignCommand, SetItalicCommand, SetOverlineCommand, SetShrinkToFitCommand, SetStrikeThroughCommand, SetStyleCommand, SetTextColorCommand, SetTextRotationCommand, SetTextWrapCommand, SetUnderlineCommand, SetVerticalTextAlignCommand, } from './commands/commands/set-style.command';
 export type { ISetColorCommandParams, ISetFontFamilyCommandParams, ISetFontSizeCommandParams, ISetHorizontalTextAlignCommandParams, ISetShrinkToFitCommandParams, ISetStyleCommandParams, ISetTextRotationCommandParams, ISetTextWrapCommandParams, ISetVerticalTextAlignCommandParams, IStyleTypeValue, } from './commands/commands/set-style.command';
 export { SetTabColorCommand } from './commands/commands/set-tab-color.command';
+export { SetWorkbookCalculationSettingsCommand } from './commands/commands/set-workbook-calculation-settings.command';
 export { SetWorkbookNameCommand } from './commands/commands/set-workbook-name.command';
 export type { ISetWorkbookNameCommandParams } from './commands/commands/set-workbook-name.command';
 export { SetWorksheetActivateCommand } from './commands/commands/set-worksheet-activate.command';
@@ -193,6 +194,8 @@ export { SetRowHiddenMutation, SetRowVisibleMutation } from './commands/mutation
 export type { ISetRowHiddenMutationParams, ISetRowVisibleMutationParams, } from './commands/mutations/set-row-visible.mutation';
 export { SetTabColorMutation } from './commands/mutations/set-tab-color.mutation';
 export type { ISetTabColorMutationParams } from './commands/mutations/set-tab-color.mutation';
+export { SetWorkbookCalculationSettingsMutation } from './commands/mutations/set-workbook-calculation-settings.mutation';
+export type { ISetWorkbookCalculationSettingsMutationParams } from './commands/mutations/set-workbook-calculation-settings.mutation';
 export { SetWorkbookNameMutation } from './commands/mutations/set-workbook-name.mutation';
 export type { ISetWorkbookNameMutationParams } from './commands/mutations/set-workbook-name.mutation';
 export { SetWorksheetColWidthMutation, SetWorksheetColWidthMutationFactory, } from './commands/mutations/set-worksheet-col-width.mutation';

package/lib/types/services/auto-fill/auto-fill.service.d.ts

@@ -15,8 +15,8 @@
  */
 import type { IDisposable, IRange, Nullable } from '@univerjs/core';
 import type { Observable } from 'rxjs';
-import type { IAutoFillLocation, IAutoFillRule, ISheetAutoFillHook } from './type';
 import { Direction, Disposable, ICommandService, Injector, IUndoRedoService, IUniverInstanceService } from '@univerjs/core';
+import type { IAutoFillLocation, IAutoFillRule, ISheetAutoFillHook } from './type';
 import { AUTO_FILL_APPLY_TYPE } from './type';
 export interface IAutoFillService {
     applyType$: Observable<AUTO_FILL_APPLY_TYPE>;
@@ -34,7 +34,7 @@ export interface IAutoFillService {
     setFillingStyle(isFillingStyle: boolean): void;
     registerRule(rule: IAutoFillRule): void;
     getAllHooks(): ISheetAutoFillHook[];
-    getActiveHooks(): ISheetAutoFillHook[];
+    getActiveHooks(applyType?: AUTO_FILL_APPLY_TYPE): ISheetAutoFillHook[];
     addHook(hook: ISheetAutoFillHook): IDisposable;
     fillData(applyType: AUTO_FILL_APPLY_TYPE): boolean;
     triggerAutoFill(unitId: string, subUnitId: string, source: IRange, target: IRange, manualApplyType?: AUTO_FILL_APPLY_TYPE): Promise<boolean>;
@@ -71,7 +71,7 @@ export declare class AutoFillService extends Disposable implements IAutoFillServ
     registerRule(rule: IAutoFillRule): void;
     getRules(): IAutoFillRule[];
     getAllHooks(): ISheetAutoFillHook[];
-    getActiveHooks(): ISheetAutoFillHook[];
+    getActiveHooks(applyType?: AUTO_FILL_APPLY_TYPE): ISheetAutoFillHook[];
     get applyType(): AUTO_FILL_APPLY_TYPE;
     set applyType(type: AUTO_FILL_APPLY_TYPE);
     get menu(): IApplyMenuItem[];

package/lib/types/services/auto-fill/type.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { Direction, IAccessor, ICellData, IMutationInfo, IObjectMatrixPrimitiveType, Nullable } from '@univerjs/core';
-import type { IDiscreteRange } from '../../basics';
+import type { IDiscreteRange } from '../../basics/interfaces/selection-config';
 export declare enum AUTO_FILL_APPLY_TYPE {
     COPY = "COPY",
     SERIES = "SERIES",
@@ -50,11 +50,18 @@ export interface ISheetAutoFillHook {
     bindUnit?: string;
     disable?: (location: IAutoFillLocation, direction: Direction, applyType: AUTO_FILL_APPLY_TYPE) => boolean;
     onBeforeFillData?(location: IAutoFillLocation, direction: Direction): AUTO_FILL_APPLY_TYPE | void;
+    /** Prepare and validate without mutations; the returned callback captures undo data after reverting a previous fill. */
+    onPrepareFillData?(location: IAutoFillLocation, direction: Direction, applyType: AUTO_FILL_APPLY_TYPE): () => {
+        undos: IMutationInfo[];
+        redos: IMutationInfo[];
+    };
     onFillData?(location: IAutoFillLocation, direction: Direction, applyType: AUTO_FILL_APPLY_TYPE): {
         undos: IMutationInfo[];
         redos: IMutationInfo[];
     };
     onAfterFillData?(location: IAutoFillLocation, direction: Direction, applyType: AUTO_FILL_APPLY_TYPE): boolean | void;
+    /** Validate proposed values before reverting or applying any fill mutations. Throw to reject the entire fill. */
+    onValidateFillData?(location: IAutoFillLocation, direction: Direction, applyType: AUTO_FILL_APPLY_TYPE, cellValue: IObjectMatrixPrimitiveType<Nullable<ICellData>>): void;
     onBeforeSubmit?: (location: IAutoFillLocation, direction: Direction, applyType: AUTO_FILL_APPLY_TYPE, cellValue: IObjectMatrixPrimitiveType<Nullable<ICellData>>) => void;
 }
 export type IAutoFillCopyDataInTypeIndexInfo = number[];

package/lib/types/services/permission/workbook-permission/util.d.ts

@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 import { UnitAction } from '@univerjs/protocol';
-import { WorkbookCommentPermission } from '../permission-point';
-export declare const getAllWorkbookPermissionPoint: () => (typeof WorkbookCommentPermission)[];
+import { WorkbookEditablePermission } from '../permission-point';
+export declare const getAllWorkbookPermissionPoint: () => (typeof WorkbookEditablePermission)[];
 export declare const defaultWorkbookPermissionPoints: UnitAction[];