Class: FWorksheet

activate(): FWorksheet

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

addConditionalFormattingRule(rule): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a conditional formatting rule that bolds the text for cells with not empty content in the range A1:T100.
const fRange = fWorksheet.getRange('A1:T100');
const rule = fWorksheet.newConditionalFormattingRule()
  .whenCellNotEmpty()
  .setRanges([fRange.getRange()])
  .setItalic(true)
  .setBackground('red')
  .setFontColor('green')
  .build();
fWorksheet.addConditionalFormattingRule(rule);

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
 
// Register a float button component
const FloatButton = () => {
  const divStyle = {
    width: '100px',
    height: '30px',
    backgroundColor: '#fff',
    border: '1px solid #ccc',
    boxSizing: 'border-box' as const,
    display: 'flex',
    justifyContent: 'center',
    alignItems: 'center',
    textAlign: 'center' as const,
    cursor: 'pointer',
  };
 
  const clickHandler = () => {
    console.warn('click');
  };
 
  return (
    <div style={divStyle} onClick={clickHandler}>
      FloatButton
    </div>
  );
};
univerAPI.registerComponent('FloatButton', FloatButton);
 
// Add the float button to the column D header, position is right align, width is 100px, height is 30px, margin is 0
const disposeable = fWorksheet.addFloatDomToColumnHeader(3, {
  componentKey: 'FloatButton',
  allowTransform: false,
}, {
  width: 100,
  height: 30,
  marginX: 0,
  marginY: 0,
  horizonOffsetAlign: 'right',
}, 'myFloatButton');
 
// Remove the float button
setTimeout(() => {
  disposeable?.dispose();
}, 2000);

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
 
// You should register components at an appropriate time (e.g., when Univer is loaded)
// This is a React component. For Vue3 components, the third parameter should be `{ framework: 'vue3' }`
univerAPI.registerComponent(
  'myFloatDom',
  ({ data }) => (
    <div style={{ width: '100%', height: '100%', background: '#fff', border: '1px solid #ccc', boxSizing: 'border-box' }}>
      popup content:
      {' '}
      {data?.label}
    </div>
  ),
);
 
// Add a floating DOM
// If disposable is null, floating DOM addition failed
const disposeable = fWorksheet.addFloatDomToPosition({
  componentKey: 'myFloatDom',
  initPosition: {
    startX: 100,
    endX: 300,
    startY: 100,
    endY: 200,
  },
 
  // Component data
  data: {
    label: 'hahah',
  },
});
 
// Remove the floating DOM
setTimeout(() => {
  disposeable?.dispose();
}, 2000);

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
 
// Register a range loading component
const RangeLoading = () => {
  const divStyle = {
    width: '100%',
    height: '100%',
    backgroundColor: '#fff',
    border: '1px solid #ccc',
    boxSizing: 'border-box' as const,
    display: 'flex',
    justifyContent: 'center',
    alignItems: 'center',
    textAlign: 'center' as const,
    transformOrigin: 'top left',
  };
 
  return (
    <div style={divStyle}>
      Loading...
    </div>
  );
};
univerAPI.registerComponent('RangeLoading', RangeLoading);
 
// Add the range loading component covering the range A1:C3
const range = fWorksheet.getRange('A1:C3');
const disposeable = fWorksheet.addFloatDomToRange(range, { componentKey: 'RangeLoading' }, {}, 'myRangeLoading');
 
setTimeout(() => {
  disposeable?.dispose();
}, 2000);
 
// another example-------------------
// Register a float button component
const FloatButton = () => {
  const divStyle = {
    width: '100px',
    height: '30px',
    backgroundColor: '#fff',
    border: '1px solid #ccc',
    boxSizing: 'border-box' as const,
    display: 'flex',
    justifyContent: 'center',
    alignItems: 'center',
    textAlign: 'center' as const,
    cursor: 'pointer',
  };
 
  const clickHandler = () => {
    console.warn('click');
  };
 
  return (
    <div style={divStyle} onClick={clickHandler}>
      FloatButton
    </div>
  );
};
univerAPI.registerComponent('FloatButton', FloatButton);
 
// Add the float button to the range A5:C7, position is start from A5 cell, and width is 100px, height is 30px, margin is 100% of range width and height
const range2 = fWorksheet.getRange('A5:C7');
const disposeable2 = fWorksheet.addFloatDomToRange(range2, {
  componentKey: 'FloatButton',
}, {
  width: 100,
  height: 30,
  marginX: '100%', // margin percent to range width, or pixel
  marginY: '100%'
}, 'myFloatButton');

addSparkline(
   sourceRanges, 
   targetRanges, 
   type): FSparkline

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a sparkline in the range A10, with the data source in the range A1:A7.
const sourceRanges = [fWorksheet.getRange('A1:A7').getRange()];
const targetRanges = [fWorksheet.getRange('A10').getRange()];
const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges, univerAPI.Enum.SparklineTypeEnum.LINE_CHART);
console.log('sparkline instance', sparkline);

appendRow(rowContents): 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, auto?): FWorksheet

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

autoResizeColumn(columnPosition): FWorksheet

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

autoResizeColumns(startColumn, numColumns): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Set the A:C columns to a width that fits their text.
fWorksheet.autoResizeColumns(0, 3);

autoResizeRows(startRow, numRows): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Set the first 3 rows to a height that fits their text.
fWorksheet.autoResizeRows(0, 3);

cancelFreeze(): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Cancel freeze
fWorksheet.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 fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const result = await fWorksheet.clearComments();
console.log(result);

clearConditionalFormatRules(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
fWorksheet.clearConditionalFormatRules();
console.log(fWorksheet.getConditionalFormattingRules()); // []

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 fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a sparkline in the range A10, with the data source in the range A1:A7.
const firstSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('A1:A7').getRange()],
  [fWorksheet.getRange('A10').getRange()]
);
// Create a sparkline in the range B10, with the data source in the range B1:B7.
const secondSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('B1:B7').getRange()],
  [fWorksheet.getRange('B10').getRange()]
);
console.log('debugger', fWorksheet.getAllSubSparkline().size); // 2
 
// Compose the two sparklines into one group after 3 seconds
setTimeout(() => {
  fWorksheet.composeSparkline([fWorksheet.getRange('A10:B10').getRange()]);
  console.log('debugger', fWorksheet.getAllSubSparkline().size); // 1
}, 3000);

createConditionalFormattingRule(): FConditionalFormattingBuilder

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 fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Delete column C
fWorksheet.deleteColumn(2);
// Delete column A
fWorksheet.deleteColumn(0);

deleteColumns(columnPosition, howMany): 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);

deleteConditionalFormattingRule(cfId): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const rules = fWorksheet.getConditionalFormattingRules();
 
// Delete the first rule
fWorksheet.deleteConditionalFormattingRule(rules[0]?.cfId);

deleteImages(sheetImages): FWorksheet

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
const image = fWorksheet.getImages()[0];
fWorksheet.deleteImages([image]);

deleteRow(rowPosition): FWorksheet

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

deleteRows(rowPosition, howMany): 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);

equalTo(other): 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

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

getActiveImages(): FOverGridImage[]

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
const images = fWorksheet.getActiveImages();
images.forEach((image) => {
  console.log(image, image.getId());
});

getActiveRange(): FRange

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

getAllSubSparkline(): Map<string, ISparklineGroup>

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Get all sparklines in the current worksheet
const allSparkline = fWorksheet.getAllSubSparkline();
console.log('allSparkline', allSparkline);

getCellMergeData(row, column): FRange

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

getCharts(): FChart[]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Get all charts on the active sheet.
const charts = fWorksheet.getCharts();
console.log(charts);

getColumnCustomMetadata(index): CustomData

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

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

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

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

getCommentById(commentId): FThreadComment

getComments(): FThreadComment[]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const comments = fWorksheet.getComments();
comments.forEach((comment) => {
  const isRoot = comment.getIsRoot();
 
  if (isRoot) {
    console.log('root comment:', comment.getCommentData());
 
    const replies = comment.getReplies();
    replies.forEach((reply) => {
      console.log('reply comment:', reply.getCommentData());
    });
  }
});

getConditionalFormattingRules(): IConditionFormattingRule[]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const rules = fWorksheet.getConditionalFormattingRules();
console.log(rules);

getCustomMetadata(): CustomData

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

getDataValidation(ruleId): Nullable<FDataValidation>

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const rules = fWorksheet.getDataValidations();
console.log(fWorksheet.getDataValidation(rules[0]?.rule.uid));

getDataValidations(): FDataValidation[]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const rules = fWorksheet.getDataValidations();
console.log(rules);

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

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

getFilter(): FFilter

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const filter = worksheet.getFilter();
console.log(filter, filter?.getRange().getA1Notation());

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

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

getImageById(id): FOverGridImage

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
const image = fWorksheet.getImageById('xxxx');
console.log(image);

getImages(): FOverGridImage[]

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
const images = fWorksheet.getImages();
images.forEach((image) => {
  console.log(image, image.getId());
});

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

getPivotTableByCell(row, col): FPivotTable

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const pivotTable = fSheet.getPivotTableByCell(1, 1);
if(pivotTable) {
  pivotTable.addField(1, univerAPI.Enum.PivotTableFiledAreaEnum.Row, 0);
}

getRange(row, column): FRange

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Get range for cell at row 0, column 0 (A1)
const range = fWorksheet.getRange(0, 0);
console.log(range);

getRange(
   row, 
   column, 
   numRows): FRange

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

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Get range for cells A1:C3
const range = fWorksheet.getRange(0, 0, 3, 3);
console.log(range);

getRange(a1Notation): FRange

const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Get range for cells A1:C3
const range = fWorksheet.getRange("A1:C3");
console.log(range);
// Get range for a single cell
const cell = fWorksheet.getRange("B2");
console.log(cell);
// Get range with sheet name
const sheetName = fWorksheet.getSheetName();
const rangeWithSheet = fWorksheet.getRange(`${sheetName}!A1:C3`);
console.log(rangeWithSheet);

getRange(range): FRange

getRowCustomMetadata(index): CustomData

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

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

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

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

getScrollState(): IScrollState

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Scroll to cell D10
const fRange = fWorksheet.getRange('D10');
const row = fRange.getRow();
const column = fRange.getColumn();
fWorksheet.scrollToCell(row, column);
 
// Get scroll state
const scrollState = fWorksheet.getScrollState();
const { offsetX, offsetY, sheetViewStartColumn, sheetViewStartRow } = scrollState;
console.log(scrollState); // sheetViewStartRow: 9, sheetViewStartColumn: 3, offsetX: 0, offsetY: 0

getSelection(): FSelection

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

getSkeleton(): any

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

getSparklineByCell(row, col): FSparkline

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a sparkline in the range A10, with the data source in the range A1:A7.
const sourceRanges = [fWorksheet.getRange('A1:A7').getRange()];
const targetRanges = [fWorksheet.getRange('A10').getRange()];
const sparkline = fWorksheet.addSparkline(sourceRanges, targetRanges);
 
console.log('Cell A10: ', fWorksheet.getSparklineByCell(9, 0));
console.log('Cell A11: ', fWorksheet.getSparklineByCell(10, 0));

getSparklineGroupByCell(row, col): FSparklineGroup

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a sparkline in the range A10, with the data source in the range A1:A7.
const firstSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('A1:A7').getRange()],
  [fWorksheet.getRange('A10').getRange()]
);
// Create a sparkline in the range B10, with the data source in the range B1:B7.
const secondSparkline = fWorksheet.addSparkline(
  [fWorksheet.getRange('B1:B7').getRange()],
  [fWorksheet.getRange('B10').getRange()]
);
console.log('Cell A10: ', fWorksheet.getSparklineGroupByCell(9, 0));
 
// Compose the two sparklines into one group after 3 seconds
setTimeout(() => {
  fWorksheet.composeSparkline([fWorksheet.getRange('A10:B10').getRange()]);
  console.log('Cell A10: ', fWorksheet.getSparklineGroupByCell(9, 0));
}, 3000);

getTabColor(): string