Class: FWorksheet

activate(): FWorksheet

addConditionalFormattingRule(rule): FWorksheet

 const workbook = univerAPI.getActiveWorkbook();
 const worksheet = workbook?.getActiveSheet();
 const rule = worksheet?.createConditionalFormattingRule()
      .whenCellNotEmpty()
      .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
      .setItalic(true)
      .setItalic(true)
      .setBackground('red')
      .setFontColor('green')
      .build();
 worksheet?.addConditionalFormattingRule(rule!);

addFloatDomToColumnHeader(
   column, 
   layer, 
   domPos, 
   id?): Nullable<{
  dispose: ...;
  id: ...;
}>

{
const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
const rs = sheet.addFloatDomToColumnHeader(3,
	{
		allowTransform: false,
		componentKey: 'FloatButton', // React comp key registered in ComponentManager
		props: {
			a: 1,
		},
	},
	{width: 100, height: 40, marginX: 0, marginY: 0, horizonOffsetAlign: 'right'},
	'ai-selector' // dom id
)
}

addFloatDomToPosition(layer, id?): Nullable<{
  dispose: ...;
  id: ...;
}>

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
sheet.addFloatDomToPosition({
	allowTransform: false,
	initPosition: {
		startX: 200,
		endX: 400,
		startY: 200,
		endY: 400,
	},
	componentKey: 'ImageDemo',
	props: {
		a: 1,
	},
	data: {
		aa: '128',
	},
});

addFloatDomToRange(
   range, 
   layer, 
   domLayout, 
   id?): Nullable<{
  dispose: ...;
  id: ...;
}>

const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
const range = sheet.getRange(0, 0, 3, 3);
univerAPI.getActiveWorkbook().setActiveRange(range);
const {id, dispose } = sheet.addFloatDomToRange(range, {
	allowTransform: false,
	componentKey: 'RangeLoading',
	props: {
		a: 1,
	},
	data: {
		aa: '128',
	},
}, {},
'loadingcover'
)
setTimeout(()=> {
dispose();
}, 2000)
 
// another example-------------------
{
const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
const range = univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange()
const {id, dispose } = sheet.addFloatDomToRange(range, {
	allowTransform: false,
	componentKey: 'FloatButton', // React comp key registered in ComponentManager
	props: {
		a: 1,
	},
	data: {
		aa: '128',
	},
}, {
width: 100,
height: 30,
marginX: '100%', // margin percent to range width, or pixel
marginY: '100%'
},
'AIButton') // dom id
}
 

addSparkline(
   sourceRanges, 
   targetRanges, 
   type): FSparkline

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
 
const sparkline = worksheet.addSparkline(
  [{ startRow: 0, endRow: 6, startColumn: 0, endColumn: 0 }],
  [{ startRow: 9, endRow: 9, startColumn: 0, endColumn: 0 }]
);
 
console.log('sparkline instance', sparkline);

autoFitRow(rowPosition, auto?): FWorksheet

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

cancelFreeze(): FWorksheet

const sheet = workbook.getActiveSheet();
// Cancel freeze
sheet.cancelFreeze();

clear(options?): 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 });

clearComments(): Promise<boolean>

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getSheetById(sheetId);
await worksheet.clearComments();

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

composeSparkline(ranges): void

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
 
const firstSparkline = worksheet.addSparkline(
  [{ startRow: 0, endRow: 6, startColumn: 0, endColumn: 0 }],
  [{ startRow: 9, endRow: 9, startColumn: 0, endColumn: 0 }]
);
 
const secondSparkline = worksheet.addSparkline(
  [{ startRow: 0, endRow: 6, startColumn: 0, endColumn: 0 }],
  [{ startRow: 9, endRow: 9, startColumn: 1, endColumn: 1 }]
);
 
// There will be two sparklines here
const allSparklineBeforeCompose = worksheet.getAllSubSparkline();
 
worksheet.composeSparkline([{ startRow: 9, endRow: 9, startColumn: 0, endColumn: 1 }]);
 
// After compose, there will only be one sparkline
const allSparklineAfterCompose = worksheet.getAllSubSparkline();
console.log('debugger', allSparklineBeforeCompose, allSparklineAfterCompose);

createConditionalFormattingRule(): FConditionalFormattingBuilder

 const workbook = univerAPI.getActiveWorkbook();
 const worksheet = workbook?.getActiveSheet();
 const rule = worksheet?.createConditionalFormattingRule()
     .whenCellNotEmpty()
     .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
     .setItalic(true)
     .setItalic(true)
     .setBackground('red')
     .setFontColor('green')
     .build();

customizeColumnHeader(cfg): void

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
fWorksheet.customizeColumnHeader({
	headerStyle: {
		fontColor: '#fff',
		backgroundColor: '#4e69ee',
		fontSize: 9
	},
	columnsCfg: {
		0: 'kuma II',
		3: {
			text: 'Size',
			textAlign: 'left', // CanvasTextAlign
			fontColor: '#fff',
			fontSize: 12,
			borderColor: 'pink',
			backgroundColor: 'pink',
		},
		4: 'Wow'
	}
});

customizeRowHeader(cfg): void

univerAPI.customizeRowHeader({
	headerStyle: {
		backgroundColor: 'pink',
		fontSize: 12
	},
	rowsCfg: {
		0: 'MokaII',
		3: {
			text: 'Size',
			textAlign: 'left'
		}
	}
});

deleteColumn(columnPosition): FWorksheet

const sheet = workbook.getActiveSheet();
// Delete column C
sheet.deleteColumn(2);
// Delete column A
sheet.deleteColumn(0);

deleteColumns(columnPosition, howMany): FWorksheet

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

deleteConditionalFormattingRule(cfId): FWorksheet

 const workbook = univerAPI.getActiveWorkbook();
 const worksheet = workbook?.getActiveSheet();
 const rules = worksheet?.getConditionalFormattingRules();
 worksheet?.deleteConditionalFormattingRule(rules![0].cfId);

deleteImages(sheetImages): FWorksheet

deleteRow(rowPosition): FWorksheet

const sheet = workbook.getActiveSheet();
// Delete 3 rows at row index 2 (rows 3-5)
sheet.deleteRow(2);
// Delete 1 row at row index 0 (first row)
sheet.deleteRow(0);

deleteRows(rowPosition, howMany): FWorksheet

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

equalTo(other): boolean

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fWorkSheet2 = fWorkbook.getSheetByName('Sheet1');
console.log(fWorkSheet.equals(fWorkSheet2)); // true, if the active sheet is 'Sheet1'

getActiveImages(): FOverGridImage[]

univerAPI.getActiveWorkbook().getActiveSheet().getImages();

getActiveRange(): FRange

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

getAllSubSparkline(): Map<string, ISparklineGroup>

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
 
const allSparkline = worksheet.getAllSubSparkline();
console.log('allSparkline', allSparkline);

getCellMergeData(row, column): FRange

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

getCharts(): FChart[]

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const charts = fSheet.getCharts();
console.log(charts.length); //chart count

getColumnCustomMetadata(index): CustomData

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

getColumnDefaultStyle(index, keepRaw?): string | Nullable<...>

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

getCommentById(commentId): FThreadComment

getComments(): FThreadComment[]

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getSheetById(sheetId);
const comments = worksheet.getComments();

getConditionalFormattingRules(): IConditionFormattingRule[]

univerAPI.getActiveWorkbook()?.getActiveSheet().getConditionalFormattingRules();

getDataRange(): FRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
// the sheet is a empty sheet
const cellRange = fWorkSheet.getRange(200, 10, 1, 1);
cellRange.setValue('Hello World');
console.log(fWorkSheet.getDataRange().getA1Notation()); // A1:J200

getDataValidation(ruleId): Nullable<FDataValidation>

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getWorksheet('sheet1');
const dataValidation = worksheet.getDataValidation('ruleId');

getDataValidations(): FDataValidation[]

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getWorksheet('sheet1');
const dataValidations = worksheet.getDataValidations();

getDefaultStyle(): string | Nullable<...>

const sheet = workbook.getActiveSheet();
const defaultStyle = sheet.getDefaultStyle();

getDefinedNames(): FDefinedName[]

// The code below gets all the defined names in the worksheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const sheet1 = activeSpreadsheet.getSheetByName('Sheet1');
const definedNames = sheet1.getDefinedNames();

getFilter(): FFilter

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const filter = worksheet.getFilter();

getFreeze(): IFreeze

const sheet = workbook.getActiveSheet();
// Get the freeze state of the current sheet
const freeze = sheet.getFreeze();
console.log(freeze);

getFrozenColumnRange(): IColumnRange

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

getFrozenColumns(): number

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

getFrozenRowRange(): IRowRange

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

getFrozenRows(): number

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

getGridLinesColor(): string

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

getImageById(id): FOverGridImage

univerAPI.getActiveWorkbook().getActiveSheet().getImageById('xxxx');

getImages(): FOverGridImage[]

univerAPI.getActiveWorkbook().getActiveSheet().getImages();

getIndex(): number

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

getInject(): Injector

const injector = univerAPI.getActiveWorkbook().getActiveSheet().getInject();

getLastColumn(): number

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fRange = fWorkSheet.getRange(100, 20, 1, 1);
console.log(fWorkSheet.getLastColumn());

getLastColumns(): number

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fRange = fWorkSheet.getRange(100, 20, 1, 1);
console.log(fWorkSheet.getLastColumns()); // 20

getLastRow(): number

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fRange = fWorkSheet.getRange(100,1,1,1);
fRange.setValue('Hello World');
console.log(fWorkSheet.getLastRow());
 
***
 
### ~~getLastRows()~~
 
```ts
getLastRows(): number

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fRange = fWorkSheet.getRange(100,1,1,1);
fRange.setValue('Hello World');
console.log(fWorkSheet.getLastRows()); // 100
 
***
 
### getMaxColumns()
 
```ts
getMaxColumns(): number

const sheet = workbook.getActiveSheet();
const totalColumns = sheet.getMaxColumns();
console.log(`Sheet has ${totalColumns} columns`);

getMaxRows(): number

const sheet = workbook.getActiveSheet();
const totalRows = sheet.getMaxRows();
console.log(`Sheet has ${totalRows} rows`);

getMergeData(): FRange[]

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const rangeFirst = worksheet.getRange(0, 0, 2, 2);
const mergeFirst = rangeFirst.merge();
const rangeSecond = worksheet.getRange(5, 0, 2, 2);
const mergeSecond = rangeSecond.merge();
const mergeData = worksheet.getMergeData();
console.log('debugger', mergeData);

getMergedRanges(): FRange[]

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

getRange(row, column): FRange

const sheet = workbook.getActiveSheet();
// Get range for cell at row 0, column 0 (A1)
const range = sheet.getRange(0, 0);

getRange(
   row, 
   column, 
   numRows): FRange

getRange(
   row, 
   column, 
   numRows, 
   numColumns): FRange

getRange(a1Notation): FRange

const sheet = workbook.getActiveSheet();
// Get range for cells A1:C3
const range = sheet.getRange("A1:C3");
// Get range for a single cell
const cell = sheet.getRange("B2");
// Get range with sheet name
const rangeWithSheet = sheet.getRange("Sheet1!A1:C3");

getRange(range): FRange

getRowCustomMetadata(index): CustomData

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

getRowDefaultStyle(index, keepRaw?): string | Nullable<...>

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

getScrollState(): IScrollState

univerAPI.getActiveWorkbook().getActiveSheet().getScrollState()

getSelection(): FSelection

const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
const selections = sheet.getSelection();

getSheet(): Worksheet

const sheet = univerAPI.getActiveWorkbook().getActiveSheet().getSheet();

getSheetId(): string

const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
const id = sheet.getSheetId();

getSheetName(): string

const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
const name = sheet.getSheetName();

getSkeleton(): any

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const skeleton = fWorksheet.getSkeleton();
console.log(skeleton);

getSparklineByCell(row, col): FSparkline

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const sparkline = worksheet.getSparklineByCell(9, 0)

getSparklineGroupByCell(row, col): FSparklineGroup

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const sparkline = worksheet.getSparklineGroupByCell(9, 0)

getTabColor(): string

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

getUrl(): string

getValidatorStatus(): Promise<ObjectMatrix<...>>

getValidatorStatusAsync(): Promise<ObjectMatrix<...>>

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getWorksheet('sheet1');
const validatorStatus = worksheet.getValidatorStatus();

getVisibleRange(): IRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const visibleRange = fWorksheet.getVisibleRange();

getWorkbook(): Workbook

const workbook = univerAPI.getActiveWorkbook().getWorkbook();

getZoom(): number

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const zoomRatio = fWorksheet.getZoom();
console.log(zoomRatio);

hasHiddenGridLines(): boolean

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

hideColumn(column): FWorksheet

const sheet = workbook.getActiveSheet();
// Hide columns C, D, E
sheet.hideColumn({ startColumn: 2, endColumn: 4 });
// Hide column A
sheet.hideColumn({ startColumn: 0, endColumn: 0 });

hideColumns(columnIndex, numColumn?): FWorksheet

const sheet = workbook.getActiveSheet();
// Hide columns C, D, E
sheet.hideColumns(2, 3);
// Hide column A
sheet.hideColumns(0, 1);

hideRow(row): FWorksheet

const sheet = workbook.getActiveSheet();
// Hide 3 rows starting from row index 1 (rows 2-4)
sheet.hideRow(1);
// Hide single row at index 0 (first row)
sheet.hideRow(0);

hideRows(rowIndex, numRow?): FWorksheet

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

hideSheet(): FWorksheet

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

insertChart(chartBuildInfo): Promise<FChart>

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartInfo = fSheet.newChart()
  .addRange('A1:B8')
  .setChartType(ChartTypeBits.Column)
  .setPosition(1, 1, 0, 0)
  .build();
const fChart = await fSheet.insertChart(chartInfo);

insertColumnAfter(afterPosition): FWorksheet

const sheet = workbook.getActiveSheet();
// Insert 3 columns at column index 2 (before column C)
sheet.insertColumnAfter(2);
// Insert 1 column at column index 0 (before column A)
sheet.insertColumnAfter(0);

insertColumnBefore(beforePosition): FWorksheet

const sheet = workbook.getActiveSheet();
// Insert 3 columns at column index 2 (before column C)
sheet.insertColumnBefore(2);
// Insert 1 column at column index 0 (before column A)
sheet.insertColumnBefore(0);

insertColumns(columnIndex, numColumns?): FWorksheet

const sheet = workbook.getActiveSheet();
// Insert 3 columns at column index 2 (before column C)
sheet.insertColumns(2, 3);
// Insert 1 column at column index 0 (before column A)
sheet.insertColumns(0);

insertColumnsAfter(afterPosition, howMany): FWorksheet

const sheet = workbook.getActiveSheet();
// Insert 3 columns at column index 2 (before column C)
sheet.insertColumnsAfter(2, 3);
// Insert 1 column at column index 0 (before column A)
sheet.insertColumnsAfter(0, 1);

insertColumnsBefore(beforePosition, howMany): FWorksheet

const sheet = workbook.getActiveSheet();
// Insert 3 columns at column index 2 (before column C)
sheet.insertColumnsBefore(2, 3);
// Insert 1 column at column index 0 (before column A)
sheet.insertColumnsBefore(0, 1);

insertDefinedName(name, formulaOrRefString): void

insertImage(url): Promise<boolean>

const activeSpreadsheet = univerAPI.getActiveWorkbook();
const activeSheet = activeSpreadsheet.getActiveSheet();
activeSheet.insertImage('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', 5, 5, 0, 0);

insertImage(
   url, 
   column, 
row): Promise<boolean>

insertImage(
   url, 
   column, 
   row, 
   offsetX, 
offsetY): Promise<boolean>