@univerjs/sheets 0.6.0 → 0.6.1

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

@@ -28,9 +28,10 @@ export declare class FSelection {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A10:B11');
+     * fRange.activate();
      * const fSelection = fWorksheet.getSelection();
-     * const activeRange = fSelection.getActiveRange();
-     * console.log(activeRange);
+     * console.log(fSelection.getActiveRange().getA1Notation()); // A10:B11
      * ```
      */
     getActiveRange(): FRange | null;
@@ -43,7 +44,9 @@ export declare class FSelection {
      * const fWorksheet = fWorkbook.getActiveSheet();
      * const fSelection = fWorksheet.getSelection();
      * const activeRangeList = fSelection.getActiveRangeList();
-     * console.log(activeRangeList);
+     * activeRangeList.forEach((range) => {
+     *   console.log(range.getA1Notation());
+     * });
      * ```
      */
     getActiveRangeList(): FRange[];
@@ -54,9 +57,13 @@ export declare class FSelection {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A10:B11');
+     * fRange.activate();
      * const fSelection = fWorksheet.getSelection();
      * const currentCell = fSelection.getCurrentCell();
+     * const { actualRow, actualColumn } = currentCell;
      * console.log(currentCell);
+     * console.log(`actualRow: ${actualRow}, actualColumn: ${actualColumn}`); // actualRow: 9, actualColumn: 0
      * ```
      */
     getCurrentCell(): Nullable<ISelectionCell>;
@@ -81,26 +88,44 @@ export declare class FSelection {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
-     * const fSelection = fWorksheet.getSelection();
-     * const cell = fWorksheet.getCell('A1');
-     * const newSelection = fSelection.updatePrimaryCell(cell);
-     * console.log(newSelection.getActiveRange().getA1Notation()); // A1
+     * const fRange = fWorksheet.getRange('A10:B11');
+     * fRange.activate();
+     * const cell = fWorksheet.getRange('B11');
+     *
+     * let fSelection = fWorksheet.getSelection();
+     * fSelection.updatePrimaryCell(cell);
+     * fSelection = fWorksheet.getSelection();
+     *
+     * const currentCell = fSelection.getCurrentCell();
+     * const { actualRow, actualColumn } = currentCell;
+     * console.log(currentCell);
+     * console.log(`actualRow: ${actualRow}, actualColumn: ${actualColumn}`); // actualRow: 10, actualColumn: 1
      * ```
      */
     updatePrimaryCell(cell: FRange): FSelection;
     /**
-     *Get the next primary cell in the specified direction. If the primary cell not exists in selections, return null.
+     * Get the next primary cell in the specified direction. If the primary cell not exists in selections, return null.
+     * The next primary cell in the specified direction is the next cell only within the current selection range.
+     * For example, if the current selection is A1:B2, and the primary cell is B1, the next cell in the right direction is A2 instead of C1.
      * @param {Direction} direction The direction to move the primary cell.The enum value is maybe one of the following: UP(0),RIGHT(1), DOWN(2), LEFT(3).
      * @returns {FRange | null} The next primary cell in the specified direction.
      * @example
      * ```ts
-     * // import { Direction } from '@univerjs/core';
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
-     * // make sure the active cell is A1 and selection is A1:C3
-     * const fSelection = fWorksheet.getSelection();
-     * const nextCell = fSelection.getNextDataRange(Direction.RIGHT);
+     * // make sure the active cell is A1 and selection is A1:B2
+     * const fRange = fWorksheet.getRange('A1:B2');
+     * fRange.activate();
+     *
+     * // get the next cell in the right direction, and update the primary cell to the next cell, now the active cell is B1
+     * let fSelection = fWorksheet.getSelection();
+     * const nextCell = fSelection.getNextDataRange(univerAPI.Enum.Direction.RIGHT);
      * console.log(nextCell?.getA1Notation()); // B1
+     * fSelection = fSelection.updatePrimaryCell(nextCell);
+     *
+     * // get the next cell in the right direction, the next cell is A2
+     * const nextCell2 = fSelection.getNextDataRange(univerAPI.Enum.Direction.RIGHT);
+     * console.log(nextCell2?.getA1Notation()); // A2
      * ```
      */
     getNextDataRange(direction: Direction): FRange | null;

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

@@ -19,12 +19,14 @@ export interface IFUniverSheetsMixin {
      * @returns {FWorkbook} FWorkbook API instance.
      * @example
      * ```ts
-     * univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' });
+     * const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' });
+     * console.log(fWorkbook);
      * ```
      *
      * Add you can make the workbook not as the active workbook by setting options:
      * ```ts
-     * univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' }, { makeCurrent: false });
+     * const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' }, { makeCurrent: false });
+     * console.log(fWorkbook);
      * ```
      */
     createWorkbook(data: Partial<IWorkbookData>, options?: ICreateUnitOptions): FWorkbook;
@@ -33,7 +35,8 @@ export interface IFUniverSheetsMixin {
      * @returns {FWorkbook | null} The currently focused Univer spreadsheet.
      * @example
      * ```ts
-     * univerAPI.getActiveWorkbook();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * console.log(fWorkbook);
      * ```
      */
     getActiveWorkbook(): FWorkbook | null;
@@ -45,6 +48,15 @@ export interface IFUniverSheetsMixin {
      * Get the spreadsheet API handler by the spreadsheet id.
      * @param {string} id The spreadsheet id.
      * @returns {FWorkbook | null} The spreadsheet API instance.
+     *
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getUniverSheet('Sheet1');
+     * console.log(fWorkbook);
+     *
+     * const fWorkbook = univerAPI.getWorkbook('Sheet1');
+     * console.log(fWorkbook);
+     * ```
      */
     getUniverSheet(id: string): FWorkbook | null;
     getWorkbook(id: string): FWorkbook | null;
@@ -62,7 +74,13 @@ export interface IFUniverSheetsMixin {
      * @returns {FDefinedNameBuilder} - The defined name builder.
      * @example
      * ```ts
-     * univerAPI.newDefinedName();
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const definedNameBuilder = univerAPI.newDefinedName()
+     *   .setRef('Sheet1!$A$1')
+     *   .setName('MyDefinedName')
+     *   .setComment('This is a comment');
+     * console.log(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder.build());
      * ```
      */
     newDefinedName(): FDefinedNameBuilder;
@@ -73,7 +91,12 @@ export interface IFUniverSheetsMixin {
      * @returns {Nullable<{ workbook: FWorkbook; worksheet: FWorksheet }>} - The target of the sheet.
      * @example
      * ```ts
-     * univerAPI.getSheetTarget('unitId', 'subUnitId');
+     * const unitId = 'workbook-01';
+     * const subUnitId = 'sheet-0001';
+     * const target = univerAPI.getSheetTarget(unitId, subUnitId);
+     * if (!target) return;
+     * const { workbook, worksheet } = target;
+     * console.log(workbook, worksheet);
      * ```
      */
     getSheetTarget(unitId: string, subUnitId: string): Nullable<{
@@ -86,10 +109,11 @@ export interface IFUniverSheetsMixin {
      * @returns {Nullable<{ workbook: FWorkbook; worksheet: FWorksheet }>} - The target of the sheet.
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.event.CommandExecuted, (commandInfo) => {
+     * univerAPI.addEvent(univerAPI.Event.CommandExecuted, (commandInfo) => {
      *   const target = univerAPI.getCommandSheetTarget(commandInfo);
      *   if (!target) return;
      *   const { workbook, worksheet } = target;
+     *   console.log(workbook, worksheet);
      * });
      * ```
      */
@@ -105,6 +129,7 @@ export interface IFUniverSheetsMixin {
      * const target = univerAPI.getActiveSheet();
      * if (!target) return;
      * const { workbook, worksheet } = target;
+     * console.log(workbook, worksheet);
      * ```
      */
     getActiveSheet(): Nullable<{
@@ -139,17 +164,11 @@ export declare class FUniverSheetsMixin extends FUniver implements IFUniverSheet
         workbook: FWorkbook;
         worksheet: FWorksheet;
     }>;
-    private _fireBeforeActiveSheetChange;
     private _fireActiveSheetChanged;
-    private _fireBeforeSheetDelete;
     private _fireSheetDeleted;
-    private _fireBeforeSheetMove;
     private _fireSheetMoved;
-    private _fireBeforeSheetNameChange;
     private _fireSheetNameChanged;
-    private _fireBeforeSheetTabColorChange;
     private _fireSheetTabColorChanged;
-    private _fireBeforeSheetHideChange;
     private _fireSheetHideChanged;
 }
 declare module '@univerjs/core/facade' {