@univerjs/sheets-ui 0.6.1 → 0.6.2

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

@@ -8,25 +8,34 @@ import { FWorksheet } from '@univerjs/sheets/facade';
 export interface IFWorksheetSkeletonMixin {
     /**
      * Refresh the canvas.
+     * @returns {FWorksheet} The FWorksheet instance for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * fWorksheet.refreshCanvas();
+     * ```
      */
     refreshCanvas(): FWorksheet;
     /**
      * Set zoom ratio of the worksheet.
-     * @param {number} zoomRatio The zoom ratio to set.It should be in the range of 10 to 400.
-     * @returns True if the command was successful, false otherwise.
+     * @param {number} zoomRatio The zoom ratio to set.It should be in the range of 0.1 to 4.0.
+     * @returns {FWorksheet} The FWorksheet instance for chaining.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
-     * fWorksheet.zoom(200);
+     *
+     * // Set zoom ratio to 200%
+     * fWorksheet.zoom(2);
      * const zoomRatio = fWorksheet.getZoom();
-     * console.log(zoomRatio); // 200
+     * console.log(zoomRatio); // 2
      * ```
      */
     zoom(zoomRatio: number): FWorksheet;
     /**
      * Get the zoom ratio of the worksheet.
-     * @returns The zoom ratio of the worksheet.
+     * @returns {number} The zoom ratio of the worksheet.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -40,10 +49,12 @@ export interface IFWorksheetSkeletonMixin {
      * Return visible range, sum view range of 4 viewports.
      * @returns {IRange} - visible range
      * @example
-     * ``` ts
+     * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
      * const visibleRange = fWorksheet.getVisibleRange();
+     * console.log(visibleRange);
+     * console.log(fWorksheet.getRange(visibleRange).getA1Notation());
      * ```
      */
     getVisibleRange(): IRange;
@@ -52,10 +63,17 @@ export interface IFWorksheetSkeletonMixin {
      * Based on the limitations of viewport and the number of rows and columns, you can only scroll to the maximum scrollable range.
      * @param {number} row - Cell row index
      * @param {number} column - Cell column index
-     * @returns {FWorksheet} - Current worksheet
+     * @returns {FWorksheet} - The FWorksheet instance for chaining.
      * @example
-     * ``` ts
-     * univerAPI.getActiveWorkbook().getActiveSheet().scrollToCell(1, 1);
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Scroll to cell D10
+     * const fRange = fWorksheet.getRange('D10');
+     * const row = fRange.getRow();
+     * const column = fRange.getColumn();
+     * fWorksheet.scrollToCell(row, column);
      * ```
      */
     scrollToCell(row: number, column: number): FWorksheet;
@@ -63,8 +81,20 @@ export interface IFWorksheetSkeletonMixin {
      * Get scroll state of current sheet.
      * @returns {IScrollState} curr scroll state
      * @example
-     * ``` ts
-     * univerAPI.getActiveWorkbook().getActiveSheet().getScrollState()
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Scroll to cell D10
+     * const fRange = fWorksheet.getRange('D10');
+     * const row = fRange.getRow();
+     * const column = fRange.getColumn();
+     * fWorksheet.scrollToCell(row, column);
+     *
+     * // Get scroll state
+     * const scrollState = fWorksheet.getScrollState();
+     * const { offsetX, offsetY, sheetViewStartColumn, sheetViewStartRow } = scrollState;
+     * console.log(scrollState); // sheetViewStartRow: 9, sheetViewStartColumn: 3, offsetX: 0, offsetY: 0
      * ```
      */
     getScrollState(): IScrollState;
@@ -81,17 +111,61 @@ export interface IFWorksheetSkeletonMixin {
      */
     getSkeleton(): Nullable<SpreadsheetSkeleton>;
     /**
-     * Set the given column width to fix-content.
-     * @param {number} columnPosition - Column position
-     * @param {number} numColumn - Number of columns
+     * Sets the width of the given column to fit its contents.
+     * @param {number} columnPosition - The position of the given column to resize. index starts at 0.
+     * @returns {FWorksheet} - The FWorksheet instance for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Set the long text value in cell A1
+     * const fRange = fWorksheet.getRange('A1');
+     * fRange.setValue('Whenever it is a damp, drizzly November in my soul...');
+     *
+     * // Set the column A to a width which fits the text
+     * fWorksheet.autoResizeColumn(0);
+     * ```
+     */
+    autoResizeColumn(columnPosition: number): FWorksheet;
+    /**
+     * Sets the width of all columns starting at the given column position to fit their contents.
+     * @param {number} startColumn - The position of the first column to resize. index starts at 0.
+     * @param {number} numColumns - The number of columns to auto-resize.
+     * @returns {FWorksheet} - The FWorksheet instance for chaining.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
-     * fWorksheet.setColumnAutoWidth(0, 3);
+     *
+     * // Set the A:C columns to a width that fits their text.
+     * fWorksheet.autoResizeColumns(0, 3);
      * ```
      */
+    autoResizeColumns(startColumn: number, numColumns: number): FWorksheet;
+    /**
+     * Sets the width of all columns starting at the given column position to fit their contents.
+     * @deprecated use `autoResizeColumns` instead
+     * @param {number} columnPosition - The position of the first column to resize. index starts at 0.
+     * @param {number} numColumn - The number of columns to auto-resize.
+     * @returns {FWorksheet} - The FWorksheet instance for chaining.
+     */
     setColumnAutoWidth(columnPosition: number, numColumn: number): FWorksheet;
+    /**
+     * Sets the height of all rows starting at the given row position to fit their contents.
+     * @param {number} startRow - The position of the first row to resize. index starts at 0.
+     * @param {number} numRows - The number of rows to auto-resize.
+     * @returns {FWorksheet} - The FWorksheet instance for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     *
+     * // Set the first 3 rows to a height that fits their text.
+     * fWorksheet.autoResizeRows(0, 3);
+     * ```
+     */
+    autoResizeRows(startRow: number, numRows: number): FWorksheet;
     /**
      * Customize the column header of the spreadsheet.
      * @param {IColumnsHeaderCfgParam} cfg The configuration of the column header.
@@ -144,26 +218,30 @@ export interface IFWorksheetSkeletonMixin {
     customizeRowHeader(cfg: IRowsHeaderCfgParam): void;
     /**
      * Set column height for column header.
-     * @param height
+     * @param {number} height - The height to set.
+     * @returns {FWorksheet} - The FWorksheet instance for chaining.
      * @example
      * ```ts
-        const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
-        sheet.setColumnHeaderHeight(100);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * fWorksheet.setColumnHeaderHeight(100);
      * ```
      */
     setColumnHeaderHeight(height: number): FWorksheet;
     /**
      * Set column height for column header.
-     * @param width
+     * @param {number} width - The width to set.
+     * @returns {FWorksheet} - The FWorksheet instance for chaining.
      * @example
      * ```ts
-        const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
-        sheet.setRowHeaderWidth(100);
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * fWorksheet.setRowHeaderWidth(100);
      * ```
      */
     setRowHeaderWidth(width: number): FWorksheet;
     /**
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Scroll, () => {})` instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Scroll, (params) => {})` instead
      */
     onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable;
 }
@@ -176,7 +254,10 @@ export declare class FWorksheetSkeletonMixin extends FWorksheet implements IFWor
     getScrollState(): IScrollState;
     onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable;
     getSkeleton(): Nullable<SpreadsheetSkeleton>;
+    autoResizeColumn(columnPosition: number): FWorksheet;
+    autoResizeColumns(startColumn: number, numColumns: number): FWorksheet;
     setColumnAutoWidth(columnPosition: number, numColumn: number): FWorksheet;
+    autoResizeRows(startRow: number, numRows: number): FWorksheet;
     customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void;
     customizeRowHeader(cfg: IRowsHeaderCfgParam): void;
     setColumnHeaderHeight(height: number): FWorksheet;

package/lib/types/index.d.ts

@@ -57,7 +57,7 @@ export { HoverRenderController } from './controllers/hover-render.controller';
 export { DragRenderController } from './controllers/drag-render.controller';
 export { EMBEDDING_FORMULA_EDITOR_COMPONENT_KEY, RANGE_SELECTOR_COMPONENT_KEY, SHEET_VIEW_KEY } from './common/keys';
 export type { IDiscreteRange } from './controllers/utils/range-tools';
-export { discreteRangeToRange, rangeToDiscreteRange, virtualizeDiscreteRanges } from './controllers/utils/range-tools';
+export { discreteRangeToRange, virtualizeDiscreteRanges } from './controllers/utils/range-tools';
 export { AFFECT_LAYOUT_STYLES, AutoHeightController } from './controllers/auto-height.controller';
 export { AutoWidthController } from './controllers/auto-width.controller';
 export { FormulaEditorController } from './controllers/editor/formula-editor.controller';

package/lib/types/locale/zh-CN.d.ts

@@ -20,11 +20,6 @@ declare const locale: {
         undo: string;
         redo: string;
         formatPainter: string;
-        currencyFormat: string;
-        percentageFormat: string;
-        numberDecrease: string;
-        numberIncrease: string;
-        moreFormats: string;
         font: string;
         fontSize: string;
         bold: string;
@@ -38,11 +33,6 @@ declare const locale: {
             right: string;
         };
         resetColor: string;
-        customColor: string;
-        alternatingColors: string;
-        confirmColor: string;
-        cancelColor: string;
-        collapse: string;
         fillColor: {
             main: string;
             right: string;
@@ -71,137 +61,9 @@ declare const locale: {
             main: string;
             right: string;
         };
-        freezeTopRow: string;
-        sortAndFilter: string;
-        findAndReplace: string;
-        sum: string;
-        autoSum: string;
-        moreFunction: string;
-        conditionalFormatting: string;
-        comment: string;
-        pivotTable: string;
-        chart: string;
-        screenshot: string;
-        splitColumn: string;
-        insertImage: string;
-        insertLink: string;
-        dataValidation: string;
-        protection: string;
-        clearText: string;
-        noColorSelectedText: string;
-        toolMore: string;
-        toolLess: string;
-        toolClose: string;
-        toolMoreTip: string;
-        moreOptions: string;
-        cellFormat: string;
-        print: string;
-        borderMethod: {
-            top: string;
-            bottom: string;
-            left: string;
-            right: string;
-        };
         more: string;
-        hideGridlines: string;
-        showGridlines: string;
         toggleGridlines: string;
     };
-    defaultFmt: {
-        Automatic: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Number: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Percent: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        PlainText: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Scientific: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Accounting: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Thousand: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Currency: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Digit: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Date: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Time: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        Time24H: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        DateTime: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        DateTime24H: {
-            text: string;
-            value: string;
-            example: string;
-        };
-        CustomFormats: {
-            text: string;
-            value: string;
-            example: string;
-        };
-    };
-    format: {
-        moreCurrency: string;
-        moreDateTime: string;
-        moreNumber: string;
-        titleCurrency: string;
-        decimalPlaces: string;
-        titleDateTime: string;
-        titleNumber: string;
-    };
-    print: {
-        normalBtn: string;
-        layoutBtn: string;
-        pageBtn: string;
-        menuItemPrint: string;
-        menuItemAreas: string;
-        menuItemRows: string;
-        menuItemColumns: string;
-    };
     align: {
         left: string;
         center: string;
@@ -314,7 +176,6 @@ declare const locale: {
     };
     rightClick: {
         copy: string;
-        copyAs: string;
         cut: string;
         paste: string;
         pasteSpecial: string;
@@ -346,11 +207,6 @@ declare const locale: {
         hideSelectedColumn: string;
         showHideColumn: string;
         columnWidth: string;
-        to: string;
-        left: string;
-        right: string;
-        top: string;
-        bottom: string;
         moveLeft: string;
         moveUp: string;
         moveRight: string;
@@ -358,42 +214,11 @@ declare const locale: {
         add: string;
         row: string;
         column: string;
-        width: string;
-        height: string;
-        number: string;
         confirm: string;
-        orderAZ: string;
-        orderZA: string;
         clearSelection: string;
         clearContent: string;
         clearFormat: string;
         clearAll: string;
-        matrix: string;
-        sortSelection: string;
-        filterSelection: string;
-        chartGeneration: string;
-        firstLineTitle: string;
-        untitled: string;
-        array1: string;
-        array2: string;
-        array3: string;
-        diagonal: string;
-        antiDiagonal: string;
-        diagonalOffset: string;
-        offset: string;
-        boolean: string;
-        flip: string;
-        upAndDown: string;
-        leftAndRight: string;
-        clockwise: string;
-        counterclockwise: string;
-        transpose: string;
-        matrixCalculation: string;
-        plus: string;
-        minus: string;
-        multiply: string;
-        divided: string;
-        power: string;
         root: string;
         log: string;
         delete0: string;
@@ -406,7 +231,6 @@ declare const locale: {
         freezeCol: string;
         freezeRow: string;
         cancelFreeze: string;
-        zenEditor: string;
         deleteAllRowsAlert: string;
         deleteAllColumnsAlert: string;
         hideAllRowsAlert: string;

package/lib/types/services/clipboard/clipboard.service.d.ts

@@ -74,7 +74,7 @@ export declare class SheetClipboardService extends Disposable implements ISheetC
     getPasteMenuVisible(): boolean;
     getPasteOptionsCache(): IPasteOptionCache | null;
     copyContentCache(): CopyContentCache;
-    generateCopyContent(workbookId: string, worksheetId: string, range: IRange): Nullable<ICopyContent>;
+    generateCopyContent(workbookId: string, worksheetId: string, range: IRange, copyType?: COPY_TYPE): Nullable<ICopyContent>;
     copy(copyType?: COPY_TYPE): Promise<boolean>;
     cut(): Promise<boolean>;
     paste(item: ClipboardItem, pasteType?: "default-paste"): Promise<boolean>;

package/lib/types/services/selection/base-selection-render.service.d.ts

@@ -1,9 +1,9 @@
 import { ICellInfo, ICellWithCoord, IContextService, IDisposable, IFreeze, IInterceptor, Injector, IRange, IRangeWithCoord, IStyleSheet, Nullable, Disposable, InterceptorManager, RANGE_TYPE, ThemeService } from '@univerjs/core';
 import { IMouseEvent, IPointerEvent, IRenderModule, Scene, SpreadsheetSkeleton, Viewport, ScrollTimer, ScrollTimerType } from '@univerjs/engine-render';
+import { ISelectionStyle, ISelectionWithCoord, ISelectionWithStyle } from '@univerjs/sheets';
 import { IShortcutService } from '@univerjs/ui';
 import { Observable, Subscription, BehaviorSubject, Subject } from 'rxjs';
 import { SheetSkeletonManagerService } from '../sheet-skeleton-manager.service';
-import { ISelectionStyle, ISelectionWithCoord, ISelectionWithStyle } from '@univerjs/sheets';
 import { SelectionControl } from './selection-control';
 export interface IControlFillConfig {
     oldRange: IRange;

package/lib/types/services/selection/selection-render-model.d.ts

@@ -33,10 +33,6 @@ export declare class SelectionRenderModel implements IRangeWithCoord {
      * @deprecated, Duplicate with `Rectangle`
      */
     isEqual(rangeWithCoord: IRangeWithCoord): boolean;
-    /**
-     * @deprecated, Duplicate with `Rectangle`
-     */
-    isInclude(rangeWithCoord: IRangeWithCoord): boolean;
     highlightToSelection(): Nullable<IRangeWithCoord>;
     getRange(): IRangeWithCoord;
     getCell(): Nullable<ICellWithCoord>;

package/lib/types/views/{operate-container → auto-fill-popup-menu}/AutoFillPopupMenu.d.ts

@@ -6,7 +6,7 @@ export interface IAnchorPoint {
 }
 export interface IAutoFillPopupMenuItem {
     label: string;
-    value?: APPLY_TYPE;
+    value: APPLY_TYPE;
     index: number;
     disable: boolean;
 }

package/lib/types/views/permission/panel-detail/PermissionDetailMainPart.d.ts

@@ -1,15 +1,11 @@
 import { IRange } from '@univerjs/core';
-import { default as React } from 'react';
 interface IPermissionDetailMainPartProps {
     permissionId: string;
     ranges: IRange[];
     onRangesChange: (ranges: IRange[], err?: string) => void;
-    isFocusRangeSelector: boolean;
     rangesErrMsg?: string;
     desc?: string;
     onDescChange: (desc: string) => void;
-    rangeSelectorRef: React.MutableRefObject<any>;
-    onFocus: () => void;
 }
 export declare const PermissionDetailMainPart: (props: IPermissionDetailMainPartProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/lib/types/views/sheet-bar/sheet-bar-menu/SheetBarMenu.d.ts

@@ -6,8 +6,4 @@ export interface ISheetBarMenuItem {
     index?: string;
     sheetId?: string;
 }
-export interface ISheetBarMenuProps {
-    style?: React.CSSProperties;
-    onClick?: (e?: MouseEvent) => void;
-}
-export declare function SheetBarMenu(props: ISheetBarMenuProps): import("react/jsx-runtime").JSX.Element;
+export declare function SheetBarMenu(): import("react/jsx-runtime").JSX.Element;

package/lib/types/views/sheet-container/SheetContainer.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export declare const SHEET_FOOTER_BAR_HEIGHT = 36;
 export declare function RenderSheetFooter(): import("react/jsx-runtime").JSX.Element | null;
 export declare function RenderSheetHeader(): import("react/jsx-runtime").JSX.Element | null;
 /**