FWorksheet

activate(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheets = fWorkbook.getSheets()
// activate the last sheet
fWorkSheets[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.getActiveSheet()
fWorkSheet.appendRow([1, 'Hello Univer', true, '=A1'])

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

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

cancelFreeze(): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Cancel freeze
fWorksheet.cancelFreeze()

clear(options?: IFacadeClearOptions): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
// clear the sheet of content and formatting information
fWorkSheet.clear()
// clear the sheet of content only
fWorkSheet.clear({ contentsOnly: true })

clearContents(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
// clear the sheet of content only
fWorkSheet.clearContents()

clearFormats(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
// clear the sheet of formatting only
fWorkSheet.clearFormats()

deleteColumn(columnPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Delete column C
fWorksheet.deleteColumn(2)
// Delete column A
fWorksheet.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 row
fWorksheet.deleteRow(2)
// Delete the first row
fWorksheet.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]])

dispose(): void

equalTo(other: FWorksheet): boolean

const fWorkbook = univerAPI.getActiveWorkbook()
const sheets = fWorkbook.getSheets()
const fWorkSheet = fWorkbook.getActiveSheet()
console.log(fWorkSheet.equalTo(sheets[0])) // true, if the active sheet is the first sheet.

getActiveCell(): FRange | null

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet()
console.log(fWorkSheet.getActiveCell().getA1Notation())

getActiveRange(): FRange | null

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

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())
}

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 0
const 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 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)

// Get the width of the column A
console.log(fWorksheet.getColumnWidth(0))

getCustomMetadata(): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
const custom = fWorkSheet.getCustomMetadata()
console.log(custom)

getDataRange(): FRange

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
// Assume the sheet is a empty sheet
const cellRange = fWorkSheet.getRange('J50')
cellRange.setValue('Hello World')
console.log(fWorkSheet.getDataRange().getA1Notation()) // A1:J50

getDefaultStyle(): Nullable<IStyleData> | string

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const defaultStyle = fWorksheet.getDefaultStyle()
console.log(defaultStyle)

getDefinedNames(): FDefinedName[]

// The code below gets all the defined names in the worksheet
const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const definedNames = fWorksheet.getDefinedNames()
console.log(definedNames, definedNames[0]?.getFormulaOrRefString())

getFreeze(): IFreeze

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Get the freeze state of the current sheet
const freeze = fWorksheet.getFreeze()
console.log(freeze)

getFrozenColumnRange(): IColumnRange

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

getFrozenColumns(): number

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

getFrozenRowRange(): IRowRange

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

getFrozenRows(): number

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

getGridLinesColor(): string | undefined

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

getIndex(): number

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
// get the position of the active sheet
const position = fWorkSheet.getIndex()
console.log(position)

getInject(): Injector

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const injector = fWorksheet.getInject()
console.log(injector)

getLastColumn(): number

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
// Assume the sheet is a empty sheet
const 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 sheet
const 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`)

getMergeData(): FRange[]

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Get all merged ranges in the sheet
const mergedData = fWorksheet.getMergeData()
// Process each merged range
mergedData.forEach((range) => {
  console.log(range.getA1Notation())
})

getMergedRanges(): FRange[]

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Get all merged ranges in the sheet
const mergedRanges = fWorksheet.getMergedRanges()
// Process each merged range
mergedRanges.forEach((range) => {
  console.log(range.getA1Notation())
})

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

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 0
const 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 bold
const fRange = fWorksheet.getRange('A1')
fRange.setValue('Hello, Univer!').setFontSize(30).setFontWeight('bold')

// Get the height of the first row
console.log(fWorksheet.getRowHeight(0))

getSelection(): FSelection | null

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

getSheet(): Worksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const sheet = fWorksheet.getSheet()
console.log(sheet)

getSheetId(): string

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const sheetId = fWorksheet.getSheetId()
console.log(sheetId)

getSheetName(): string

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const sheetName = fWorksheet.getSheetName()
console.log(sheetName)

getTabColor(): string | undefined

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

getWorkbook(): Workbook

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const workbook = fWorksheet.getWorkbook()
console.log(workbook)

getWorksheetPermission(): FWorksheetPermission

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const permission = fWorksheet.getWorksheetPermission()

// Set worksheet to read-only mode
await permission.setMode('readOnly')

// Check if a specific cell can be edited
const canEdit = permission.canEditCell(0, 0)

// Protect multiple ranges at once
const range1 = fWorksheet.getRange('A1:B10')
const range2 = fWorksheet.getRange('D1:E10')
await permission.protectRanges([
  { ranges: [range1], options: { name: 'Range 1', allowEdit: false } },
  { ranges: [range2], options: { name: 'Range 2', allowEdit: false } },
])

// Subscribe to permission changes
permission.permission$.subscribe((snapshot) => {
  console.log('Worksheet permissions changed:', snapshot)
})

hasHiddenGridLines(): boolean

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet()
// check if the gridlines are hidden
if (fWorkSheet.hasHiddenGridLines()) {
  console.log('Gridlines are hidden')
}

hideColumn(column: FRange): FWorksheet

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

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Hide columns C, D, E
fWorksheet.hideColumns(2, 3)
// Hide column A
fWorksheet.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)

hideSheet(): FWorksheet

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

insertColumnAfter(afterPosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Insert a column after column C
fWorksheet.insertColumnAfter(2)
// Insert a column after column A
fWorksheet.insertColumnAfter(0)

insertColumnBefore(beforePosition: number): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Insert a column before column C
fWorksheet.insertColumnBefore(2)
// Insert a column before column A
fWorksheet.insertColumnBefore(0)

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

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

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

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

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

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

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

// The code below inserts a defined name
const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
fWorksheet.insertDefinedName('MyDefinedName', 'Sheet1!$A$1')

insertRowAfter(afterPosition: number): FWorksheet

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

insertRowBefore(beforePosition: number): FWorksheet

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

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

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

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

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

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

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

isSheetHidden(): boolean

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheets = fWorkbook.getSheets()
// check if the last sheet is hidden
console.log(fWorkSheets[fWorkSheets.length - 1].isSheetHidden())

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 0
const rowSpec1 = fWorksheet.getRange('3:5')
fWorksheet.moveRows(rowSpec1, 0)
// Move 1 row at row index 0 (first row) to row index 2
const rowSpec2 = fWorksheet.getRange('1:1')
fWorksheet.moveRows(rowSpec2, 2)

onBeforeCellDataChange(callback: (cellValue: ObjectMatrix<Nullable<ICellData>>) => void): IDisposable

onCellDataChange(callback: (cellValue: ObjectMatrix<Nullable<ICellData>>) => void): IDisposable

setActiveRange(range: FRange): FWorksheet

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet()
fWorkSheet.setActiveRange(fWorkSheet.getRange('A10:B10'))

setColumnCount(columnCount: number): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()

// Set the number of columns in the worksheet to 10
fWorkSheet.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'});

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Set width of column B to 100 pixels
fWorksheet.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 pixels
fWorksheet.setColumnWidths(1, 3, 100)

setCustomMetadata(custom: CustomData | undefined): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
fWorkSheet.setCustomMetadata({ key: 'value' })

setDefaultStyle(style: string | Nullable<IStyleData>): FWorksheet

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

setFreeze(freeze: IFreeze): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Freeze first 3 rows and 2 columns
fWorksheet.setFreeze({
  startRow: 3,
  startColumn: 2,
  xSplit: 2,
  ySplit: 3,
})

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 red
fWorkSheet.setGridLinesColor('#ff0000')

setHiddenGridlines(hidden: boolean): FWorksheet

const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet()
// hide the gridlines
fWorkSheet.setHiddenGridlines(true)

setName(name: string): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorkSheet = fWorkbook.getActiveSheet()
// set the sheet name to 'Sheet1'
fWorkSheet.setName('NewSheet1')

setRangesAutoHeight(ranges: IRange[]): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
const ranges = [
  { startRow: 1, endRow: 10, startColumn: 0, endColumn: 10 },
  { startRow: 11, endRow: 20, startColumn: 0, endColumn: 10 },
]
fWorksheet.setRangesAutoHeight(ranges)

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 40
fWorkSheet.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'});

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Set the height of the second row to 30 pixels
fWorksheet.setRowHeight(1, 30)
// Set the height of the first row to 20 pixels
fWorksheet.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 red
fWorkSheet.setTabColor('#ff0000')

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Unhide columns C, D, E
fWorksheet.showColumns(2, 3)
// Unhide column A
fWorksheet.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)

showSheet(): FWorksheet

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

unhideColumn(column: FRange): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet()
// Unhide columns C, D, E
const column1 = fWorksheet.getRange('C:E')
fWorksheet.unhideColumn(column1)
// Unhide column A
const 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)