Worksheet

getActiveRange(): FRange | null

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Get the currently active rangeconst activeRange = fWorksheet.getActiveRange();if (activeRange) {  console.log('Active range:', activeRange.getA1Notation());}

getRange(rowOrA1Notation: IRange | number | string, column?: number, numRows?: number, numColumns?: number): FRange

getSelection(): FSelection | null

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();const selection = fWorksheet.getSelection();console.log(selection);

getCellMergeData(row: number, column: number): FRange | undefined

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();const merge = fWorkSheet.getCellMergeData(0, 0);if (merge) {  console.log('Merged range:', merge.getA1Notation());}

addFloatDomToColumnHeader(column: number, layer: IFICanvasFloatDom, domLayout: IDOMAnchor, id?: string): Nullable<{        id: string;        dispose: () => void;    }>

appendRow(rowContents: CellValue[]): FWorksheet

// Appends a new row with 4 columns to the bottom of the current// data region in the sheet containing the values in the array.const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();fWorkSheet.appendRow([1, 'Hello Univer', true, '=A1']);

autoFitRow(rowPosition: number, auto: BooleanNumber = BooleanNumber.TRUE): FWorksheet

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();fWorkSheet.autoFitRow(24);

autoResizeColumns(startColumn: number, numColumns?: number): FWorksheet

autoResizeRows(startRow: number, numRows?: number): FWorksheet

customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void

customizeRowHeader(cfg: IRowsHeaderCfgParam): void

deleteColumn(columnPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Delete column CfWorksheet.deleteColumn(2);// Delete column AfWorksheet.deleteColumn(0);

deleteColumns(columnPosition: number, howMany: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Delete 3 columns at column index 2 (columns C, D, E)fWorksheet.deleteColumns(2, 3);// Delete 1 column at column index 0 (column A)fWorksheet.deleteColumns(0, 1);

deleteColumnsByPoints(columnPoints: Array<number | [number, number]>): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Delete columns at index 2, and range from index 4 to 6 (columns C, E-G)fWorksheet.deleteColumnsByPoints([2, [4, 6]]);

deleteRow(rowPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Delete the third rowfWorksheet.deleteRow(2);// Delete the first rowfWorksheet.deleteRow(0);

deleteRows(rowPosition: number, howMany: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Delete 3 rows at row index 2 (rows 3-5)fWorksheet.deleteRows(2, 3);// Delete 1 row at row index 0 (first row)fWorksheet.deleteRows(0, 1);

deleteRowsByPoints(rowPoints: Array<number | [number, number]>): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Delete rows at index 2, and range from index 4 to 6 (rows 3, 5-7)fWorksheet.deleteRowsByPoints([2, [4, 6]]);

getColumnCustomMetadata(index: number): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();const custom = fWorkSheet.getColumnCustomMetadata(0);console.log(custom);

getColumnDefaultStyle(index: number, keepRaw: boolean = false): Nullable<IStyleData> | string

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Get default style for column 0 (A)const colStyle = fWorksheet.getColumnDefaultStyle(0);console.log(colStyle);// Get raw style data for column 0const rawColStyle = fWorksheet.getColumnDefaultStyle(0, true);console.log(rawColStyle);

getColumnWidth(columnPosition: number): number

const fWorkbook = univerAPI.getActiveWorkbook();const fWorksheet = fWorkbook.getActiveSheet();// Set the long text value in cell A1const 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 textfWorksheet.autoResizeColumns(0);// Get the width of the column Aconsole.log(fWorksheet.getColumnWidth(0));

getFrozenColumnRange(): IColumnRange

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();// Get the range of the frozen columnsconst frozenColumns = fWorkSheet.getFrozenColumnRange();console.log(frozenColumns);

getFrozenColumns(): number

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();// Get the number of frozen columnsconst frozenColumns = fWorkSheet.getFrozenColumns();console.log(frozenColumns);

getFrozenRowRange(): IRowRange

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();// Get the range of the frozen rowsconst frozenRows = fWorkSheet.getFrozenRowRange();console.log(frozenRows);

getFrozenRows(): number

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();// Get the number of frozen rowsconst frozenRows = fWorkSheet.getFrozenRows();console.log(frozenRows);

getGridLinesColor(): string | undefined

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// get the gridlines color of the sheetconsole.log(fWorkSheet.getGridLinesColor());

getLastColumn(): number

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// Assume the sheet is a empty sheetconst cellRange = fWorkSheet.getRange('J50');cellRange.setValue('Hello World');console.log(fWorkSheet.getLastColumn()); // 9

getLastColumns(): number

getLastRow(): number

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// Assume the sheet is a empty sheetconst cellRange = fWorkSheet.getRange('J50');cellRange.setValue('Hello World');console.log(fWorkSheet.getLastRow()); // 49

getLastRows(): number

getMaxColumns(): number

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();const totalColumns = fWorksheet.getMaxColumns();console.log(`Sheet has ${totalColumns} columns`);

getMaxRows(): number

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();const totalRows = fWorksheet.getMaxRows();console.log(`Sheet has ${totalRows} rows`);

getRowCustomMetadata(index: number): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();const custom = fWorkSheet.getRowCustomMetadata(0);console.log(custom);

getRowDefaultStyle(index: number, keepRaw: boolean = false): Nullable<IStyleData> | string

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Get default style for row 0 (1)const rowStyle = fWorksheet.getRowDefaultStyle(0);console.log(rowStyle);// Get raw style data for row 0const rawRowStyle = fWorksheet.getRowDefaultStyle(0, true);console.log(rawRowStyle);

getRowHeight(rowPosition: number): number

const fWorkbook = univerAPI.getActiveWorkbook();const fWorksheet = fWorkbook.getActiveSheet();// Set the value of the cell A1 to 'Hello, Univer!', set the font size to 30 and font weight to boldconst fRange = fWorksheet.getRange('A1');fRange.setValue('Hello, Univer!').setFontSize(30).setFontWeight('bold');// Get the height of the first rowconsole.log(fWorksheet.getRowHeight(0));

getTabColor(): string | undefined

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// get the tab color of the sheetconsole.log(fWorkSheet.getTabColor());

hideColumn(column: FRange): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Hide columns C, D, Econst column1 = fWorksheet.getRange('C:E');fWorksheet.hideColumn(column1);// Hide column Aconst column2 = fWorksheet.getRange('A:A');fWorksheet.hideColumn(column2);

hideColumns(columnIndex: number, numColumn: number = 1): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Hide columns C, D, EfWorksheet.hideColumns(2, 3);// Hide column AfWorksheet.hideColumns(0, 1);

hideRow(row: FRange): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Hide 3 rows starting from row index 1 (rows 2-4)const row1 = fWorksheet.getRange('2:4');fWorksheet.hideRow(row1);// Hide single row at index 0 (first row)const row2 = fWorksheet.getRange('1:1');fWorksheet.hideRow(row2);

hideRows(rowIndex: number, numRow: number = 1): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Hide 3 rows starting from row index 1 (rows 2-4)fWorksheet.hideRows(1, 3);// Hide single row at index 0 (first row)fWorksheet.hideRows(0);

insertColumnAfter(afterPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert a column after column CfWorksheet.insertColumnAfter(2);// Insert a column after column AfWorksheet.insertColumnAfter(0);

insertColumnBefore(beforePosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert a column before column CfWorksheet.insertColumnBefore(2);// Insert a column before column AfWorksheet.insertColumnBefore(0);

insertColumns(columnIndex: number, numColumns: number = 1): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert 3 columns before column CfWorksheet.insertColumns(2, 3);// Insert 1 column before column AfWorksheet.insertColumns(0);

insertColumnsAfter(afterPosition: number, howMany: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert 3 columns after column CfWorksheet.insertColumnsAfter(2, 3);// Insert 1 column after column AfWorksheet.insertColumnsAfter(0, 1);

insertColumnsBefore(beforePosition: number, howMany: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert 3 columns before column CfWorksheet.insertColumnsBefore(2, 3);// Insert 1 column before column AfWorksheet.insertColumnsBefore(0, 1);

insertRowAfter(afterPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert a row after the third rowfWorksheet.insertRowAfter(2);// Insert a row after the first rowfWorksheet.insertRowAfter(0);

insertRowBefore(beforePosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert a row before the third rowfWorksheet.insertRowBefore(2);// Insert a row before the first rowfWorksheet.insertRowBefore(0);

insertRows(rowIndex: number, numRows: number = 1): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert 3 rows before the third rowfWorksheet.insertRows(2, 3);// Insert 1 row before the first rowfWorksheet.insertRows(0);

insertRowsAfter(afterPosition: number, howMany: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert 3 rows after the third rowfWorksheet.insertRowsAfter(2, 3);// Insert 1 row after the first rowfWorksheet.insertRowsAfter(0, 1);

insertRowsBefore(beforePosition: number, howMany: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Insert 3 rows before the third rowfWorksheet.insertRowsBefore(2, 3);// Insert 1 row before the first rowfWorksheet.insertRowsBefore(0, 1);

moveColumns(columnSpec: FRange, destinationIndex: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Move columns C, D, E to column index 2 (columns B, C, D)const columnSpec1 = fWorksheet.getRange('C:E');fWorksheet.moveColumns(columnSpec1, 1);// Move column F to column index 0 (column A)const columnSpec2 = fWorksheet.getRange('F:F');fWorksheet.moveColumns(columnSpec2, 0);

moveRows(rowSpec: FRange, destinationIndex: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Move 3 rows at row index 2 (rows 3-5) to row index 0const rowSpec1 = fWorksheet.getRange('3:5');fWorksheet.moveRows(rowSpec1, 0);// Move 1 row at row index 0 (first row) to row index 2const rowSpec2 = fWorksheet.getRange('1:1');fWorksheet.moveRows(rowSpec2, 2);

setColumnCount(columnCount: number): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// Set the number of columns in the worksheet to 10fWorkSheet.setColumnCount(10);

setColumnCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();fWorkSheet.setColumnCustom({ 0: { key: 'value' } });

setColumnCustomMetadata(index: number, custom: CustomData | undefined): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();fWorkSheet.setColumnCustomMetadata(0, { key: 'value' });

setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorksheet = fWorkbook.getActiveSheet();fWorksheet.setColumnDefaultStyle(0, 'default');// or// fWorksheet.setColumnDefaultStyle(0, {fs: 12, ff: 'Arial'});

setColumnHeaderHeight(height: number): FWorksheet

setColumnWidth(columnPosition: number, width: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Set width of column B to 100 pixelsfWorksheet.setColumnWidth(1, 100);

setColumnWidths(startColumn: number, numColumn: number, width: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Set width of columns B-D (index 1-3) to 100 pixelsfWorksheet.setColumnWidths(1, 3, 100);

setFrozenColumns(...args: [number] | [number, number]): FWorksheet

setFrozenRows(...args: [number] | [number, number]): FWorksheet

setGridLinesColor(color: string | undefined): FWorksheet

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();// set the gridlines color to redfWorkSheet.setGridLinesColor('#ff0000');

setRowAutoHeight(startRow: number, numRows: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();fWorksheet.setRowAutoHeight(1, 10);

setRowCount(rowCount: number): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// Set the number of rows in the worksheet to 40fWorkSheet.setRowCount(40);

setRowCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();fWorkSheet.setRowCustom({ 0: { key: 'value' } });

setRowCustomMetadata(index: number, custom: CustomData | undefined): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();fWorkSheet.setRowCustomMetadata(0, { key: 'value' });

setRowDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorksheet = fWorkbook.getActiveSheet();fWorksheet.setRowDefaultStyle(0, 'default');// or// fWorksheet.setRowDefaultStyle(0, {fs: 12, ff: 'Arial'});

setRowHeaderWidth(width: number): FWorksheet

setRowHeight(rowPosition: number, height: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Set the height of the second row to 30 pixelsfWorksheet.setRowHeight(1, 30);// Set the height of the first row to 20 pixelsfWorksheet.setRowHeight(0, 20);

setRowHeights(startRow: number, numRows: number, height: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();fWorksheet.setRowHeights(1, 10, 30);

setRowHeightsForced(startRow: number, numRows: number, height: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();fWorksheet.setRowHeightsForced(1, 10, 30);

setTabColor(color: string): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// set the tab color to redfWorkSheet.setTabColor('#ff0000');

showColumns(columnIndex: number, numColumns: number = 1): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Unhide columns C, D, EfWorksheet.showColumns(2, 3);// Unhide column AfWorksheet.showColumns(0, 1);

showRows(rowIndex: number, numRows: number = 1): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Show 3 rows starting from row index 1 (rows 2-4)fWorksheet.showRows(1, 3);// Show single row at index 0 (first row)fWorksheet.showRows(0);

unhideColumn(column: FRange): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Unhide columns C, D, Econst column1 = fWorksheet.getRange('C:E');fWorksheet.unhideColumn(column1);// Unhide column Aconst column2 = fWorksheet.getRange('A:A');fWorksheet.unhideColumn(column2);

unhideRow(row: FRange): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();// Unhide 3 rows starting from row index 1 (rows 2-4)const row1 = fWorksheet.getRange('2:4');fWorksheet.unhideRow(row1);// Unhide single row at index 0 (first row)const row2 = fWorksheet.getRange('1:1');fWorksheet.unhideRow(row2);

hideSheet(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheet = fWorkbook.getActiveSheet();// hide the active sheetfWorkSheet.hideSheet();

showSheet(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const fWorkSheets = fWorkbook.getSheets();// show the last sheetfWorkSheets[fWorkSheets.length - 1].showSheet();