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

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Set the range A1:B2 as the active range, default active cell is A1
const fRange = fWorksheet.getRange('A1:B2');
fRange.activate();
console.log(fWorksheet.getActiveRange().getA1Notation()); // A1:B2
console.log(fWorksheet.getActiveCell().getA1Notation()); // A1
 
// Set the cell B2 as the active cell
// Because B2 is in the active range A1:B2, the active range will not change, and the active cell will be changed to B2
const cell = fWorksheet.getRange('B2');
cell.activateAsCurrentCell();
console.log(fWorksheet.getActiveRange().getA1Notation()); // A1:B2
console.log(fWorksheet.getActiveCell().getA1Notation()); // B2
 
// Set the cell C3 as the active cell
// Because C3 is not in the active range A1:B2, a new active range C3:C3 will be created, and the active cell will be changed to C3
const cell2 = fWorksheet.getRange('C3');
cell2.activateAsCurrentCell();
console.log(fWorksheet.getActiveRange().getA1Notation()); // C3:C3
console.log(fWorksheet.getActiveCell().getA1Notation()); // C3

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

// Attach an alert popup to the start cell of range C3:E5
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('C3:E5');
 
const disposable = fRange.attachAlertPopup({
  title: 'Warning',
  message: 'This is an warning message',
  type: 1
});
 
// Detach the alert after 5 seconds
setTimeout(() => {
  disposable.dispose();
}, 5000);

attachPopup(popup): any

// Register a custom popup component
univerAPI.registerComponent(
  'myPopup',
  () => React.createElement('div', {
    style: {
      color: 'red',
      fontSize: '14px'
    }
  }, 'Custom Popup')
);
 
// Attach the popup to the start cell of range C3:E5
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('C3:E5');
const disposable = fRange.attachPopup({
  componentKey: 'myPopup'
});
 
// Detach the popup after 5 seconds
setTimeout(() => {
  disposable.dispose();
}, 5000);

attachRangePopup(popup): any

// Register a custom popup component
univerAPI.registerComponent(
  'myPopup',
  () => React.createElement('div', {
    style: {
      background: 'red',
      fontSize: '14px'
    }
  }, 'Custom Popup')
);
 
// Attach the popup to the range C3:E5
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('C3:E5');
const disposable = fRange.attachRangePopup({
  componentKey: 'myPopup',
  direction: 'top' // 'vertical' | 'horizontal' | 'top' | 'right' | 'left' | 'bottom' | 'bottom-center' | 'top-center'
});

breakApart(): FRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.merge();
const anchor = fWorksheet.getRange('A1');
console.log(anchor.isPartOfMerge()); // true
fRange.breakApart();
console.log(anchor.isPartOfMerge()); // false

cancelHyperLink(id): boolean

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1');
const richText = univerAPI.newRichText().insertLink('Univer', 'https://univer.ai/');
fRange.setRichTextValueForCell(richText);
 
// Cancel hyperlink after 3 seconds
setTimeout(() => {
  const cellValue = fRange.getValue(true);
  const hyperlinks = cellValue.getLinks();
  const id = hyperlinks[0].rangeId;
  const newRichText = cellValue.copy().cancelLink(id);
  fRange.setRichTextValueForCell(newRichText);
}, 3000);

clear(options?): FRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fRange = fWorkSheet.getRange('A1:D10');
 
// clear the content and format of the range A1:D10
fRange.clear();
 
// clear the content only of the range A1:D10
fRange.clear({ contentsOnly: true });

clearComment(): Promise<boolean>

clearCommentAsync(): Promise<boolean>

clearComments(): Promise<boolean>

clearCommentsAsync(): Promise<boolean>

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

clearConditionalFormatRules(): FRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:T100');
 
// Clear all conditional format rules for the range
fRange.clearConditionalFormatRules();
console.log(fRange.getConditionalFormattingRules()); // []

clearContent(): FRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fRange = fWorkSheet.getRange('A1:D10');
 
// clear the content only of the range A1:D10
fRange.clearContent();

clearFormat(): FRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const fRange = fWorkSheet.getRange('A1:D10');
// clear the format only of the range A1:D10
fRange.clearFormat();

createConditionalFormattingRule(): FConditionalFormattingBuilder

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 = fRange.createConditionalFormattingRule()
  .whenCellNotEmpty()
  .setItalic(true)
  .setBackground('red')
  .setFontColor('green')
  .build();
fWorksheet.addConditionalFormattingRule(rule);
console.log(fRange.getConditionalFormattingRules());

createFilter(this): FFilter

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:D14');
let fFilter = fRange.createFilter();
 
// If the worksheet already has a filter, remove it and create a new filter.
if (!fFilter) {
  fWorksheet.getFilter().remove();
  fFilter = fRange.createFilter();
}
console.log(fFilter);

deleteCells(shiftDimension): void

// Assume the active sheet empty sheet.
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const values = [
  [1, 2, 3, 4],
  [2, 3, 4, 5],
  [3, 4, 5, 6],
  [4, 5, 6, 7],
  [5, 6, 7, 8],
];
 
// Set the range A1:D5 with some values, the range A1:D5 will be:
// 1 | 2 | 3 | 4
// 2 | 3 | 4 | 5
// 3 | 4 | 5 | 6
// 4 | 5 | 6 | 7
// 5 | 6 | 7 | 8
const fRange = fWorksheet.getRange('A1:D5');
fRange.setValues(values);
console.log(fWorksheet.getRange('A1:D5').getValues()); // [[1, 2, 3, 4], [2, 3, 4, 5], [3, 4, 5, 6], [4, 5, 6, 7], [5, 6, 7, 8]]
 
// Delete the range A1:B2 along the columns dimension, the range A1:D5 will be:
// 3 | 4 |   |
// 4 | 5 |   |
// 3 | 4 | 5 | 6
// 4 | 5 | 6 | 7
// 5 | 6 | 7 | 8
const fRange2 = fWorksheet.getRange('A1:B2');
fRange2.deleteCells(univerAPI.Enum.Dimension.COLUMNS);
console.log(fWorksheet.getRange('A1:D5').getValues()); // [[3, 4, null, null], [4, 5, null, null], [3, 4, 5, 6], [4, 5, 6, 7], [5, 6, 7, 8]]
 
// Set the range A1:D5 values again, the range A1:D5 will be:
// 1 | 2 | 3 | 4
// 2 | 3 | 4 | 5
// 3 | 4 | 5 | 6
// 4 | 5 | 6 | 7
// 5 | 6 | 7 | 8
fRange.setValues(values);
 
// Delete the range A1:B2 along the rows dimension, the range A1:D5 will be:
// 3 | 4 | 3 | 4
// 4 | 5 | 4 | 5
// 5 | 6 | 5 | 6
//   |   | 6 | 7
//   |   | 7 | 8
const fRange3 = fWorksheet.getRange('A1:B2');
fRange3.deleteCells(univerAPI.Enum.Dimension.ROWS);
console.log(fWorksheet.getRange('A1:D5').getValues()); // [[3, 4, 3, 4], [4, 5, 4, 5], [5, 6, 5, 6], [null, null, 6, 7], [null, null, 7, 8]]

deleteConditionalFormattingRule(cfId): FRange

forEach(callback): void

generateHTML(this): string

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.setValues([
  [1, 2],
  [3, 4]
]);
console.log(fRange.generateHTML());

getA1Notation(withSheet?): string

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

getBackground(): string

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

getBackgrounds(): ...[][]

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

getCell(this): ICellWithCoord

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('H6');
console.log(fRange.getCell());

getCellData(): ICellData

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

getCellDataGrid(): ...[][]

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

getCellDatas(): ...[][]

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

getCellRect(this): DOMRect

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('H6');
console.log(fRange.getCellRect());

getCellStyle(): any

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

getCellStyleData(): IStyleData

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

getCellStyles(): ...[][]

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

getColumn(): number

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

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 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);
 
// Get all the conditional formatting rules for the range F6:H8.
const targetRange = fWorksheet.getRange('F6:H8');
const rules = targetRange.getConditionalFormattingRules();
console.log(rules);

getCustomMetaData(): CustomData

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

getCustomMetaDatas(): ...[][]

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

getDataRegion(dimension?): FRange

// Assume the active sheet is a new sheet with no data.
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Set the range A1:D4 with some values, the range A1:D4 will be:
//  |     |     |
//  |     | 100 |
//  | 100 |     | 100
//  |     | 100 |
fWorksheet.getRange('C2').setValue(100);
fWorksheet.getRange('B3').setValue(100);
fWorksheet.getRange('D3').setValue(100);
fWorksheet.getRange('C4').setValue(100);
 
// Get C3 data region along the rows dimension, the range will be C2:D4
const range = fWorksheet.getRange('C3').getDataRegion(univerAPI.Enum.Dimension.ROWS);
console.log(range.getA1Notation()); // C2:C4
 
// Get C3 data region along the columns dimension, the range will be B3:D3
const range2 = fWorksheet.getRange('C3').getDataRegion(univerAPI.Enum.Dimension.COLUMNS);
console.log(range2.getA1Notation()); // B3:D3
 
// Get C3 data region along the both dimension, the range will be B2:D4
const range3 = fWorksheet.getRange('C3').getDataRegion();
console.log(range3.getA1Notation()); // B2:D4

getDataValidation(): Nullable<FDataValidation>

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a data validation rule that requires a number equal to 20 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10');
const rule = univerAPI.newDataValidation()
  .requireNumberEqualTo(20)
  .build();
fRange.setDataValidation(rule);
console.log(fRange.getDataValidation().getCriteriaValues());
 
// Change the rule criteria to require a number between 1 and 10
fRange.getDataValidation().setCriteria(
  univerAPI.Enum.DataValidationType.DECIMAL,
  [univerAPI.Enum.DataValidationOperator.BETWEEN, '1', '10']
);
 
// Print the new rule criteria values
console.log(fRange.getDataValidation().getCriteriaValues());

getDataValidations(): FDataValidation[]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a data validation rule that requires a number equal to 20 for the range A1:B10
const fRange1 = fWorksheet.getRange('A1:B10');
const rule1 = univerAPI.newDataValidation()
  .requireNumberEqualTo(20)
  .build();
fRange1.setDataValidation(rule1);
 
// Create a data validation rule that requires a number between 1 and 10 for the range C1:D10
const fRange2 = fWorksheet.getRange('C1:D10');
const rule2 = univerAPI.newDataValidation()
  .requireNumberBetween(1, 10)
  .build();
fRange2.setDataValidation(rule2);
 
// Get all data validation rules in the range A1:D10
const range = fWorksheet.getRange('A1:D10');
const rules = range.getDataValidations();
console.log(rules.length); // 2

getDisplayValue(): string

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.setValueForCell({
  v: 0.2,
  s: {
    n: {
      pattern: '0%',
    },
  },
});
console.log(fRange.getDisplayValue()); // 20%

getDisplayValues(): ...[][]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.setValues([
  [
    {
      v: 0.2,
      s: {
        n: {
          pattern: '0%',
        },
      },
    },
    {
      v: 45658,
      s: {
        n: {
          pattern: 'yyyy-mm-dd',
        },
      },
    }
  ],
  [
    {
      v: 1234.567,
      s: {
        n: {
          pattern: '#,##0.00',
        }
      }
    },
    null,
  ],
]);
console.log(fRange.getDisplayValues()); // [['20%', '2025-01-01'], ['1,234.57', '']]

getFilter(): FFilter

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:D14');
let fFilter = fRange.getFilter();
 
// If the worksheet does not have a filter, create a new filter.
if (!fFilter) {
   fFilter = fRange.createFilter();
}
console.log(fFilter);

getFormula(): string

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

getFormulas(): ...[][]

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

getHeight(): number

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

getHorizontalAlignment(): string

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

getHorizontalAlignments(): ...[][]

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

getHyperLinks(): ICellHyperLink[]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1');
const richText = univerAPI.newRichText().insertLink('Univer', 'https://univer.ai/');
fRange.setRichTextValueForCell(richText);
 
// Get hyperlinks
console.log(fRange.getValue(true).getLinks());

getLastColumn(): number

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

getLastRow(): number

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

getNumberFormat(): string

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

getNumberFormats(): ...[][]

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

getRange(): IRange

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
const range = fRange.getRange();
const { startRow, startColumn, endRow, endColumn } = range;
console.log(range);

getRawValue(): Nullable<CellValue>

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.setValueForCell({
  v: 0.2,
  s: {
    n: {
      pattern: '0%',
    },
  },
});
console.log(fRange.getRawValue()); // 0.2

getRawValues(): ...[][]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.setValues([
  [
    {
      v: 0.2,
      s: {
        n: {
          pattern: '0%',
        },
      },
    },
    {
      v: 45658,
      s: {
        n: {
          pattern: 'yyyy-mm-dd',
        },
      },
    }
  ],
  [
    {
      v: 1234.567,
      s: {
        n: {
          pattern: '#,##0.00',
        }
      }
    },
    null,
  ],
]);
console.log(fRange.getRawValues()); // [[0.2, 45658], [1234.567, null]]

getRow(): number

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

getScreenshot(): string | false

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:D10');
console.log(fRange.getScreenshot());

getSheetId(): string

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

getSheetName(): string

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

getUnitId(): string

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

getUrl(): string

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1');
const url = fRange.getUrl();
console.log(url);

getUsedThemeStyle(): string

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

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

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Set some values in the range A1:B10
const fRange = fWorksheet.getRange('A1:B10');
fRange.setValues([
  [1, 2],
  [3, 4],
  [5, 6],
  [7, 8],
  [9, 10],
  [11, 12],
  [13, 14],
  [15, 16],
  [17, 18],
  [19, 20]
]);
 
// Create a data validation rule that requires a number between 1 and 10 for the range A1:B10
const rule = univerAPI.newDataValidation()
  .requireNumberBetween(1, 10)
  .build();
fRange.setDataValidation(rule);
 
// Get the validator status for the cell B2
const status = await fWorksheet.getRange('B2').getValidatorStatus();
console.log(status?.[0]?.[0]); // 'valid'
 
// Get the validator status for the cell B10
const status2 = await fWorksheet.getRange('B10').getValidatorStatus();
console.log(status2?.[0]?.[0]); // 'invalid'

getValue(): CellValue

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getValue());
 
// set the first cell value to 123
fRange.setValueForCell(123);
console.log(fRange.getValue()); // 123

getValue(includeRichText): any

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getValue(true));
 
// set the first cell value to 123
const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } })
  .setStyle(0, 1, { bl: 1, cl: { rgb: '#c81e1e' } })
  .setStyle(6, 7, { bl: 1, cl: { rgb: '#c81e1e' } });
fRange.setRichTextValueForCell(richText);
console.log(fRange.getValue(true).toPlainText()); // Hello World

getValueAndRichTextValues(): ...[][]

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

getValues(): ...[][]

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

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

// Get values with rich text if available
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getValues(true));

getVerticalAlignment(): string

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

getVerticalAlignments(): ...[][]

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

getWidth(): number

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

getWrap(): boolean

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

getWraps(): ...[][]

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getWraps());
 
***
 
### getWrapStrategy()
 
```ts
getWrapStrategy(): WrapStrategy

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

highlight(style?, primary?): IDisposable

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Highlight the range C3:E5 with default style
const fRange = fWorksheet.getRange('C3:E5');
fRange.highlight();
 
// Highlight the range C7:E9 with custom style
const fRange2 = fWorksheet.getRange('C7:E9');
const disposable = fRange2.highlight({ stroke: 'red', fill: 'yellow' });
 
// Remove the range C7:E9 highlight after 5 seconds
setTimeout(() => {
  disposable.dispose();
}, 5000);

insertCellImageAsync(file): Promise<boolean>

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Insert an image into the cell A10
const fRange = fWorksheet.getRange('A10');
const result = await fRange.insertCellImageAsync('https://avatars.githubusercontent.com/u/61444807?s=48&v=4');
console.log(result);

insertCells(shiftDimension): void

// Assume the active sheet empty sheet.
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const values = [
  [1, 2, 3, 4],
  [2, 3, 4, 5],
  [3, 4, 5, 6],
  [4, 5, 6, 7],
  [5, 6, 7, 8],
];
 
// Set the range A1:D5 with some values, the range A1:D5 will be:
// 1 | 2 | 3 | 4
// 2 | 3 | 4 | 5
// 3 | 4 | 5 | 6
// 4 | 5 | 6 | 7
// 5 | 6 | 7 | 8
const fRange = fWorksheet.getRange('A1:D5');
fRange.setValues(values);
console.log(fWorksheet.getRange('A1:D5').getValues()); // [[1, 2, 3, 4], [2, 3, 4, 5], [3, 4, 5, 6], [4, 5, 6, 7], [5, 6, 7, 8]]
 
// Insert the empty cells into the range A1:B2 along the columns dimension, the range A1:D5 will be:
//   |   | 1 | 2
//   |   | 2 | 3
// 3 | 4 | 5 | 6
// 4 | 5 | 6 | 7
// 5 | 6 | 7 | 8
const fRange2 = fWorksheet.getRange('A1:B2');
fRange2.insertCells(univerAPI.Enum.Dimension.COLUMNS);
console.log(fWorksheet.getRange('A1:D5').getValues()); // [[null, null, 1, 2], [null, null, 2, 3], [3, 4, 5, 6], [4, 5, 6, 7], [5, 6, 7, 8]]
 
// Set the range A1:D5 values again, the range A1:D5 will be:
// 1 | 2 | 3 | 4
// 2 | 3 | 4 | 5
// 3 | 4 | 5 | 6
// 4 | 5 | 6 | 7
// 5 | 6 | 7 | 8
fRange.setValues(values);
 
// Insert the empty cells into the range A1:B2 along the rows dimension, the range A1:D5 will be:
//   |   | 3 | 4
//   |   | 4 | 5
// 1 | 2 | 5 | 6
// 2 | 3 | 6 | 7
// 3 | 4 | 7 | 8
const fRange3 = fWorksheet.getRange('A1:B2');
fRange3.insertCells(univerAPI.Enum.Dimension.ROWS);
console.log(fWorksheet.getRange('A1:D5').getValues()); // [[null, null, 3, 4], [null, null, 4, 5], [1, 2, 5, 6], [2, 3, 6, 7], [3, 4, 7, 8]]