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.

chore: better comments (#4377)

lumix2dd1c2c76a04
diff --git a/packages/sheets-ui/src/facade/f-workbook.ts b/packages/sheets-ui/src/facade/f-workbook.ts
index e118fde6a3..c3a3f0ba7a 100644
--- a/packages/sheets-ui/src/facade/f-workbook.ts
+++ b/packages/sheets-ui/src/facade/f-workbook.ts
@@ -90,6 +90,52 @@ export interface IFWorkbookSheetsUIMixin {
* @returns A promise that resolves to a boolean value
*/
endEditing(save?: boolean): Promise<boolean>;
+
+ /**
+ * Get scroll state of specified sheet.
+ * @returns {IScrollState} scroll state
+ * @example
+ * ``` ts
+ * univerAPI.getActiveWorkbook().getScrollStateBySheetId($sheetId)
+ * ```
+ */
+ getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>;
+
+ /**
+ * Disable selection. After disabled, there would be no response for selection.
+ * @example
+ * ```
+ * univerAPI.getActiveWorkbook().disableSelection();
+ * ```
+ */
+ disableSelection(): void;
+
+ /**
+ * Enable selection. After this you can select range.
+ * @example
+ * ```
+ * univerAPI.getActiveWorkbook().enableSelection();
+ * ```
+ */
+ enableSelection(): void;
+
+ /**
+ * Set selection invisible, Unlike disableSelection, selection still works, you just can not see them.
+ * @example
+ * ```
+ * univerAPI.getActiveWorkbook().transparentSelection();
+ * ```
+ */
+ transparentSelection(): void;
+
+ /**
+ * Set selection visible.
+ * @example
+ * ```
+ * univerAPI.getActiveWorkbook().showSelection();
+ * ```
+ */
+ showSelection(): void;
}
export class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheetsUIMixin {
@@ -186,15 +232,7 @@ export class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheet
return true;
}
- /**
- * Get scroll state of specified sheet.
- * @returns {IScrollState} scroll state
- * @example
- * ``` ts
- * univerAPI.getActiveWorkbook().getScrollStateBySheetId($sheetId)
- * ```
- */
- getScrollStateBySheetId(sheetId: string): Nullable<IScrollState> {
+ override getScrollStateBySheetId(sheetId: string): Nullable<IScrollState> {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService);
const render = renderManagerService.getRenderById(unitId);
@@ -203,14 +241,7 @@ export class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheet
return scm.getScrollStateByParam({ unitId, sheetId });
}
- /**
- * Disable selection. After disabled, there would be no response for selection.
- * @example
- * ```
- * univerAPI.getActiveWorkbook().disableSelection();
- * ```
- */
- disableSelection(): void {
+ override disableSelection(): void {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService) as RenderManagerService;
const render = renderManagerService.getRenderById(unitId);
@@ -219,14 +250,7 @@ export class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheet
}
}
- /**
- * Enable selection. After this you can select range.
- * @example
- * ```
- * univerAPI.getActiveWorkbook().enableSelection();
- * ```
- */
- enableSelection(): void {
+ override enableSelection(): void {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService) as RenderManagerService;
const render = renderManagerService.getRenderById(unitId);
@@ -235,14 +259,7 @@ export class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheet
}
}
- /**
- * Set selection invisible, Unlike disableSelection, selection still works, you just can not see them.
- * @example
- * ```
- * univerAPI.getActiveWorkbook().transparentSelection();
- * ```
- */
- transparentSelection(): void {
+ override transparentSelection(): void {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService) as RenderManagerService;
const render = renderManagerService.getRenderById(unitId);
@@ -251,14 +268,7 @@ export class FWorkbookSheetsUIMixin extends FWorkbook implements IFWorkbookSheet
}
}
- /**
- * Set selection visible.
- * @example
- * ```
- * univerAPI.getActiveWorkbook().showSelection();
- * ```
- */
- showSelection(): void {
+ override showSelection(): void {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService) as RenderManagerService;
const render = renderManagerService.getRenderById(unitId);
diff --git a/packages/sheets-ui/src/facade/f-worksheet.ts b/packages/sheets-ui/src/facade/f-worksheet.ts
index f7dc6d0d6f..2ebdd6ab86 100644
--- a/packages/sheets-ui/src/facade/f-worksheet.ts
+++ b/packages/sheets-ui/src/facade/f-worksheet.ts
@@ -53,6 +53,40 @@ export interface IFWorksheetSkeletonMixin {
* ```
*/
getZoom(): number;
+
+ /**
+ * Return visible range, sum view range of 4 viewports.
+ * @returns IRange
+ */
+ getVisibleRange(): IRange;
+
+ /**
+ * Scroll spreadsheet to cell position. Based on the limitations of viewport and the number of rows and columns, you can only scroll to the maximum scrollable range.
+ * @param row
+ * @param column
+ */
+ scrollToCell(row: number, column: number): void;
+
+ /**
+ * Get scroll state of current sheet.
+ * @returns {IScrollState} curr scroll state
+ * @example
+ * ``` ts
+ * univerAPI.getActiveWorkbook().getActiveSheet().getScrollState()
+ * ```
+ */
+ getScrollState(): Nullable<IScrollState>;
+
+ /**
+ * Invoked when scrolling the sheet.
+ * @param {function(params: Nullable<IViewportScrollState>): void} callback The scrolling callback function.
+ * @example
+ * ``` ts
+ * univerAPI.getActiveWorkbook().getActiveSheet().onScroll((params) => {...})
+ * ```
+ */
+ onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable;
+
}
export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSkeletonMixin {
@@ -89,11 +123,7 @@ export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSk
return this._worksheet.getZoomRatio();
}
- /**
- * Return visible range, sum view range of 4 viewports.
- * @returns IRange
- */
- getVisibleRange(): IRange {
+ override getVisibleRange(): IRange {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService);
const render = renderManagerService.getRenderById(unitId);
@@ -122,12 +152,7 @@ export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSk
return range;
}
- /**
- * Scroll spreadsheet to cell position. Based on the limitations of viewport and the number of rows and columns, you can only scroll to the maximum scrollable range.
- * @param row
- * @param column
- */
- scrollToCell(row: number, column: number): void {
+ override scrollToCell(row: number, column: number): void {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService);
const render = renderManagerService.getRenderById(unitId);
@@ -137,15 +162,7 @@ export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSk
}
}
- /**
- * Get scroll state of current sheet.
- * @returns {IScrollState} curr scroll state
- * @example
- * ``` ts
- * univerAPI.getActiveWorkbook().getActiveSheet().getScrollState()
- * ```
- */
- getScrollState(): Nullable<IScrollState> {
+ override getScrollState(): Nullable<IScrollState> {
const unitId = this._workbook.getUnitId();
const sheetId = this._worksheet.getSheetId();
const renderManagerService = this._injector.get(IRenderManagerService);
@@ -155,15 +172,7 @@ export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSk
return scm.getScrollStateByParam({ unitId, sheetId });
}
- /**
- * Invoked when scrolling the sheet.
- * @param {function(params: Nullable<IViewportScrollState>): void} callback The scrolling callback function.
- * @example
- * ``` ts
- * univerAPI.getActiveWorkbook().getActiveSheet().onScroll((params) => {...})
- * ```
- */
- onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable {
+ override onScroll(callback: (params: Nullable<IViewportScrollState>) => void): IDisposable {
const unitId = this._workbook.getUnitId();
const renderManagerService = this._injector.get(IRenderManagerService) as RenderManagerService;
const scrollManagerService = renderManagerService.getRenderById(unitId)?.with(SheetScrollManagerService);
@@ -173,12 +182,12 @@ export class FWorksheetSkeletonMixin extends FWorksheet implements IFWorksheetSk
});
return toDisposable(sub);
}
- return toDisposable(() => {});
+ return toDisposable(() => { });
}
}
FWorksheet.extend(FWorksheetSkeletonMixin);
declare module '@univerjs/sheets/facade' {
// eslint-disable-next-line ts/naming-convention
- interface FWorksheet extends IFWorksheetSkeletonMixin {}
+ interface FWorksheet extends IFWorksheetSkeletonMixin { }
}