Class: FRange

activate(): FRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.activate(); // the active cell will be A1

activateAsCurrentCell(): FRange

addComment(content): Promise<boolean>

addCommentAsync(content): Promise<boolean>

const range = univerAPI.getActiveWorkbook()
 .getActiveSheet()
 .getActiveRange();
 
const comment = univerAPI.newTheadComment()
 .setContent(univerAPI.newRichText().insertText('hello zhangsan'));
const success = await range.addCommentAsync(comment);

addConditionalFormattingRule(rule): FRange

attachAlertPopup(alert): IDisposable

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
let range = sheet.getRange(2, 2, 3, 3);
range.attachAlertPopup({ message: 'This is an alert', type: 'warning' });

attachPopup(popup): any

univerAPI.getComponentManager().register(
	'myPopup',
	() => React.createElement('div', {
		style: {
			color: 'red',
			fontSize: '14px'
		}
	}, 'Custom Popup')
);

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
let range = sheet.getRange(2, 2, 3, 3);
univerAPI.getActiveWorkbook().setActiveRange(range);
let disposable = range.attachPopup({
	componentKey: 'myPopup'
});

attachRangePopup(popup): any

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
let range = sheet.getRange(2, 2, 3, 3);
univerAPI.getActiveWorkbook().setActiveRange(range);
 
univerAPI.getComponentManager().register(
	'myPopup',
	() => React.createElement('div', {
		style: {
			background: 'red',
			fontSize: '14px'
		}
	}, 'Custom Popup')
);
let disposable = range.attachRangePopup({
	componentKey: 'myPopup',
	direction: 'top' // 'vertical' | 'horizontal' | 'top' | 'right' | 'left' | 'bottom' | 'bottom-center' | 'top-center';
});

breakApart(): FRange

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const range = worksheet.getRange(0,0,2,2);
const merge = range.merge();
const anchor = worksheet.getRange(0,0);
const isPartOfMergeFirst = anchor.isPartOfMerge();
console.log('debugger' isPartOfMergeFirst) // true
range.breakApart();
const isPartOfMergeSecond = anchor.isPartOfMerge();
console.log('debugger' isPartOfMergeSecond) // false

cancelHyperLink(id): boolean

clearComment(): Promise<boolean>

clearCommentAsync(): Promise<boolean>

clearComments(): Promise<boolean>

clearCommentsAsync(): Promise<boolean>

const range = univerAPI.getActiveWorkbook()
 .getActiveSheet()
 .getActiveRange();
const success = await range.clearCommentsAsync();

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();
 worksheet?.addConditionalFormattingRule(rule!);

createFilter(this): FFilter

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const filter = worksheet.getRange('A1:D14').createFilter();

deleteConditionalFormattingRule(cfId): FRange

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

forEach(callback): void

generateHTML(this): string

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
sheet.getRange(5, 7).generateHTML();

getA1Notation(withSheet?): string

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getA1Notation()); // A1:B2

getCell(this): ICellWithCoord

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
sheet.getRange(5, 7).getCell();

getCellData(): ICellData

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCellData()

getCellDataGrid(): ...[][]

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCellDataGrid()

getCellDatas(): ...[][]

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCellDatas()

getCellRect(this): DOMRect

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
sheet.getRange(5, 7).getCellRect();

getCellStyle(): any

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCellStyle()

getCellStyleData(): IStyleData

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCellStyleData()

getCellStyles(): ...[][]

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCellStyles()

getColumn(): number

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getColumn()

getComment(): Nullable<FThreadComment>

const range = univerAPI.getActiveWorkbook()
 .getActiveSheet()
 .getActiveRange();
const comment = range.getComment();

getComments(): FThreadComment[]

const range = univerAPI.getActiveWorkbook()
 .getActiveSheet()
 .getActiveRange();
const comments = range.getComments();
comments.forEach((comment) => {
  console.log(comment.getContent());
});

getConditionalFormattingRules(): IConditionFormattingRule[]

 const workbook = univerAPI.getActiveWorkbook();
 const worksheet = workbook?.getActiveSheet();
 workbook?.setActiveRange(worksheet?.getRange(5, 5, 3, 3)!);
 const rules = univerAPI.getActiveWorkbook()?.getActiveRange()?.getConditionalFormattingRules();

getCustomMetaData(): CustomData

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCustomMetaData()

getCustomMetaDatas(): ...[][]

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getCustomMetaDatas()

getDataValidation(): Nullable<FDataValidation>

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const dataValidation = worksheet.getActiveRange().getDataValidation();

getDataValidations(): FDataValidation[]

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const dataValidations = worksheet.getActiveRange().getDataValidations();

getFilter(): FFilter

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const filter = worksheet.getRange('A1:D14').getFilter();

getFormulas(): ...[][]

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getFormulas()

getHeight(): number

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getHeight()

getHorizontalAlignment(): string

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getHorizontalAlignment()

getHyperLinks(): ICellHyperLink[]

getRange(): IRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getRange()

getRow(): number

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getRow()

getScreenshot(): string | false

univerAPI.getActiveUniverSheet()
 .getActiveSheet()
 .getActiveRange()
 .getScreenshot();

getSheetId(): string

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getSheetId()

getSheetName(): string

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getSheetName()

getUnitId(): string

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getUnitId()

getUrl(): string

getUsedThemeStyle(): string

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:E20');
fRange.useThemeStyle('default');
const themeStyle = fRange.getUsedThemeStyle();
console.log(themeStyle); // 'default'

getValidatorStatus(): Promise<...[]>

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const validatorStatus = worksheet.getActiveRange().getValidatorStatus();

getValue(): CellValue

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getValue()

getValue(includeRichText): any

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getValue(true)

getValueAndRichTextValues(): ...[][]

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getValueAndRichTextValues()

getValues(): ...[][]

// Get plain values
const values = range.getValues();

getValues(includeRichText): ...[][]

// Get values with rich text if available
const richTextValues = univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getValues(true)

getVerticalAlignment(): string

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getVerticalAlignment()

getWidth(): number

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getWidth()

getWrap(): boolean

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getWrap()

getWrapStrategy(): WrapStrategy

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .getWrapStrategy()

highlight(style?, primary?): IDisposable

let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
let range = sheet.getRange(2, 2, 3, 3);
range.highlight({ stroke: 'red' }, { startRow: 2, startColumn: 2 });

isMerged(): boolean

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .isMerged()

isPartOfMerge(): boolean

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const range = worksheet.getRange(0,0,2,2);
const merge = range.merge();
const anchor = worksheet.getRange(0,0);
const isPartOfMerge = anchor.isPartOfMerge();
console.log('debugger, isPartOfMerge) // true

merge(defaultMerge?): FRange

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const range = worksheet.getRange(0, 0, 2, 2);
const merge = range.merge();
const isMerged = merge.isMerged();
console.log('debugger', isMerged);

mergeAcross(defaultMerge?): FRange

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const range = worksheet.getRange(2, 2, 2, 2);
const merge = range.mergeAcross();
const allMerge = worksheet.getMergeData();
console.log(allMerge.length); // There will be two merged cells.

mergeVertically(defaultMerge?): FRange

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook.getActiveSheet();
const range = worksheet.getRange(4, 4, 2, 2);
const merge = range.mergeVertically();
const allMerge = worksheet.getMergeData();
console.log(allMerge.length); // There will be two merged cells.

moveConditionalFormattingRule(
   cfId, 
   toCfId, 
   type?): FRange

const workbook = univerAPI.getActiveWorkbook();
const worksheet = workbook?.getActiveSheet();
const rules = worksheet?.getConditionalFormattingRules()!;
const rule = rules[2];
const targetRule = rules[0];
worksheet?.moveConditionalFormattingRule(rule.cfId, targetRule.cfId, 'before');

removeThemeStyle(themeName): void

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:E20');
fRange.removeThemeStyle('default');

setBackground(color): FRange

univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')

setBackgroundColor(color): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setBackgroundColor('red')

setBorder(
   type, 
   style, 
   color?): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setBorder(BorderType.ALL, BorderStyleType.THIN, '#ff0000');

setConditionalFormattingRule(cfId, rule): FRange

  const workbook = univerAPI.getActiveWorkbook();
  const worksheet = workbook?.getActiveSheet();
  const rules = worksheet?.getConditionalFormattingRules()!;
  const rule = rules[0];
  worksheet?.setConditionalFormattingRule(rule.cfId, { ...rule, ranges: [] });

setCustomMetaData(data): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setCustomMetaData({ key: 'value' });

setCustomMetaDatas(datas): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setCustomMetaDatas([[{ key: 'value' }]]);

setDataValidation(rule): FRange

const rule = FUniver.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

setFontColor(color): this

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setFontColor('#ff0000');

setFontFamily(fontFamily): this

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setFontFamily('Arial');

setFontLine(fontLine): this

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setFontLine('underline');

setFontSize(size): this

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setFontSize(12);

setFontStyle(fontStyle): this

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setFontStyle('italic');

setFontWeight(fontWeight): this

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setFontWeight('bold');

setHorizontalAlignment(alignment): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setHorizontalAlignment('left');

setHyperLink(url, label?): Promise<boolean>

setNumberFormat(pattern): FRange

setRichTextValueForCell(value): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setRichTextValueForCell(new RichTextValue().insertText('Hello'));

setRichTextValues(values): FRange

univerAPI
  .getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setRichTextValues([[new RichTextValue().insertText('Hello')]]);

setValue(value): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setValue(1);

setValueForCell(value): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setValueForCell(1);

setValues(value): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setValues([[1, 2], [3, 4]]);

setVerticalAlignment(alignment): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setVerticalAlignment('top');

setWrap(isWrapEnabled): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setWrap(true);

setWrapStrategy(strategy): FRange

univerAPI.getActiveWorkbook()
  .getActiveSheet()
  .getActiveRange()
  .setWrapStrategy(WrapStrategy.WRAP);

sort(column): FRange

const activeSpreadsheet = univerAPI.getActiveWorkbook();
const activeSheet = activeSpreadsheet.getActiveSheet();
const range = activeSheet.getRange(0, 0, 10, 10);
range.sort(1); // Sorts the range by the first column in ascending order.
range.sort({ column: 1, ascending: false }); // Sorts the range by the first column in descending order.
range.sort([{ column: 1, ascending: false }, 2]); // Sorts the range by the first column in descending order and the second column in ascending order.

splitTextToColumns(treatMultipleDelimitersAsOne?): void

// A1:A3 has following values:
//     A  | B | C
//  1,2,3 |   |
//  4,,5,6 |   |
// After calling splitTextToColumns(true), the range will be:
//  A | B | C
//  1 | 2 | 3
//  4 | 5 | 6
// After calling splitTextToColumns(false), the range will be:
//  A | B | C | D
//  1 | 2 | 3 |
//  4 |   | 5 | 6

splitTextToColumns(treatMultipleDelimitersAsOne?, delimiter?): void

updateHyperLink(
   id, 
   url, 
label?): Promise<boolean>

useThemeStyle(themeName): void

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:E20');
fRange.useThemeStyle('default');