FWorksheet

const sheet = univerAPI.getActiveWorkbook()?.getActiveSheet()if (!sheet) throw new Error('No active worksheet')sheet.getRange('A1').setValue('Hello, Univer!')

activate(): FWorksheet

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

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.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')fWorkSheet.appendRow([1, 'Hello Univer', true, '=A1'])

autoFitRow(rowPosition: number, auto?: BooleanNumber): FWorksheet

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')fWorkSheet.autoFitRow(24)

cancelFreeze(): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Cancel freezefWorksheet.cancelFreeze()

clear(options?: IFacadeClearOptions): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// clear the sheet of content and formatting informationfWorkSheet.clear()// clear the sheet of content onlyfWorkSheet.clear({ contentsOnly: true })

clearContents(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// clear the sheet of content onlyfWorkSheet.clearContents()

clearFormats(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// clear the sheet of formatting onlyfWorkSheet.clearFormats()

deleteColumn(columnPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Delete column CfWorksheet.deleteColumn(2)// Delete column AfWorksheet.deleteColumn(0)

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

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Delete the third rowfWorksheet.deleteRow(2)// Delete the first rowfWorksheet.deleteRow(0)

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

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Delete rows at index 2, and range from index 4 to 6 (rows 3, 5-7)fWorksheet.deleteRowsByPoints([2, [4, 6]])

dispose(): void

equalTo(other: FWorksheet): boolean

const fWorkbook = univerAPI.getActiveWorkbook()const sheets = fWorkbook.getSheets()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')console.log(fWorkSheet.equalTo(sheets[0])) // true, if the active sheet is the first sheet.

getActiveCell(): FRange | null

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')console.log(fWorkSheet.getActiveCell().getA1Notation())

getActiveRange(): FRange | null

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get the currently active rangeconst activeRange = fWorksheet.getActiveRange()if (activeRange) {  console.log('Active range:', activeRange.getA1Notation())}

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

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')const merge = fWorkSheet.getCellMergeData(0, 0)if (merge) {  console.log('Merged range:', merge.getA1Notation())}

getColumnCustomMetadata(index: number): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')const custom = fWorkSheet.getColumnCustomMetadata(0)console.log(custom)

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

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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))

getCustomMetadata(): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')const custom = fWorkSheet.getCustomMetadata()console.log(custom)

getDataRange(): FRange

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// Assume the sheet is a empty sheetconst cellRange = fWorkSheet.getRange('J50')cellRange.setValue('Hello World')console.log(fWorkSheet.getDataRange().getA1Notation()) // A1:J50

getDefaultStyle(): Nullable<IStyleData> | string

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const defaultStyle = fWorksheet.getDefaultStyle()console.log(defaultStyle)

getDefinedNames(): FDefinedName[]

// The code below gets all the defined names in the worksheetconst fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const definedNames = fWorksheet.getDefinedNames()console.log(definedNames, definedNames[0]?.getFormulaOrRefString())

getFreeze(): IFreeze

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get the freeze state of the current sheetconst freeze = fWorksheet.getFreeze()console.log(freeze)

getFrozenColumnRange(): IColumnRange

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// Get the range of the frozen columnsconst frozenColumns = fWorkSheet.getFrozenColumnRange()console.log(frozenColumns)

getFrozenColumns(): number

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// Get the number of frozen columnsconst frozenColumns = fWorkSheet.getFrozenColumns()console.log(frozenColumns)

getFrozenRowRange(): IRowRange

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// Get the range of the frozen rowsconst frozenRows = fWorkSheet.getFrozenRowRange()console.log(frozenRows)

getFrozenRows(): number

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// Get the number of frozen rowsconst frozenRows = fWorkSheet.getFrozenRows()console.log(frozenRows)

getGridLinesColor(): string | undefined

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// get the gridlines color of the sheetconsole.log(fWorkSheet.getGridLinesColor())

getHiddenState(): WorksheetHiddenState

getIndex(): number

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// get the position of the active sheetconst position = fWorkSheet.getIndex()console.log(position)

getInject(): Injector

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const injector = fWorksheet.getInject()console.log(injector)

getLastColumn(): number

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// Assume the sheet is a empty sheetconst cellRange = fWorkSheet.getRange('J50')cellRange.setValue('Hello World')console.log(fWorkSheet.getLastColumn()) // 9

getLastRow(): number

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// Assume the sheet is a empty sheetconst cellRange = fWorkSheet.getRange('J50')cellRange.setValue('Hello World')console.log(fWorkSheet.getLastRow()) // 49

getMaxColumns(): number

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const totalColumns = fWorksheet.getMaxColumns()console.log(`Sheet has ${totalColumns} columns`)

getMaxRows(): number

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const totalRows = fWorksheet.getMaxRows()console.log(`Sheet has ${totalRows} rows`)

getMergeData(): FRange[]

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get all merged ranges in the sheetconst mergedData = fWorksheet.getMergeData()// Process each merged rangemergedData.forEach((range) => {  console.log(range.getA1Notation())})

getMergedRanges(): FRange[]

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get all merged ranges in the sheetconst mergedRanges = fWorksheet.getMergedRanges()// Process each merged rangemergedRanges.forEach((range) => {  console.log(range.getA1Notation())})

getRange(row: number, column: number): FRangegetRange(row: number, column: number, numRows: number): FRangegetRange(row: number, column: number, numRows: number, numColumns: number): FRangegetRange(a1Notation: string): FRangegetRange(range: IRange): FRange

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get range for cell at row 0, column 0 (A1)const range = fWorksheet.getRange(0, 0)console.log(range)

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get range for cells A1:C3const range = fWorksheet.getRange(0, 0, 3, 3)console.log(range)

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get range for cells A1:C3const range = fWorksheet.getRange('A1:C3')console.log(range)// Get range for a single cellconst cell = fWorksheet.getRange('B2')console.log(cell)// Get range with sheet nameconst sheetName = fWorksheet.getSheetName()const rangeWithSheet = fWorksheet.getRange(`${sheetName}!A1:C3`)console.log(rangeWithSheet)

getRowCustomMetadata(index: number): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')const custom = fWorkSheet.getRowCustomMetadata(0)console.log(custom)

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

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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))

getSelection(): FSelection | null

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const selection = fWorksheet.getSelection()console.log(selection)

getSheet(): Worksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const sheet = fWorksheet.getSheet()console.log(sheet)

getSheetId(): string

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const sheetId = fWorksheet.getSheetId()console.log(sheetId)

getSheetName(): string

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const sheetName = fWorksheet.getSheetName()console.log(sheetName)

getTabColor(): string | undefined

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// get the tab color of the sheetconsole.log(fWorkSheet.getTabColor())

getWorkbook(): Workbook

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const workbook = fWorksheet.getWorkbook()console.log(workbook)

getWorksheetPermission(): FWorksheetPermission

hasHiddenGridLines(): boolean

const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// check if the gridlines are hiddenif (fWorkSheet.hasHiddenGridLines()) {  console.log('Gridlines are hidden')}

hideColumn(column: FRange): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Hide columns C, D, EfWorksheet.hideColumns(2, 3)// Hide column AfWorksheet.hideColumns(0, 1)

hideRow(row: FRange): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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)

hideSheet(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()const fWorkSheet = fWorkbook.getSheetByName('Sheet1')if (!fWorkSheet) throw new Error('fWorkSheet is not available')// hide the active sheetfWorkSheet.hideSheet()

insertColumnAfter(afterPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Insert a column after column CfWorksheet.insertColumnAfter(2)// Insert a column after column AfWorksheet.insertColumnAfter(0)

insertColumnBefore(beforePosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Insert a column before column CfWorksheet.insertColumnBefore(2)// Insert a column before column AfWorksheet.insertColumnBefore(0)

insertColumns(columnIndex: number, numColumns?: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Insert 3 columns before column CfWorksheet.insertColumnsBefore(2, 3)// Insert 1 column before column AfWorksheet.insertColumnsBefore(0, 1)

insertDefinedName(name: string, formulaOrRefString: string): void

// The code below inserts a defined nameconst fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')fWorksheet.insertDefinedName('MyDefinedName', 'Sheet1!$A$1')

insertRowAfter(afterPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Insert a row before the third rowfWorksheet.insertRowBefore(2)// Insert a row before the first rowfWorksheet.insertRowBefore(0)

insertRows(rowIndex: number, numRows?: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// 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().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Insert 3 rows before the third rowfWorksheet.insertRowsBefore(2, 3)// Insert 1 row before the first rowfWorksheet.insertRowsBefore(0, 1)