Class: FSelection

Represents the active selection in the sheet.

Example


const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fSelection = fWorksheet.getSelection();
const activeRange = fSelection.getActiveRange();
console.log(activeRange);

Methods

getActiveRange()


getActiveRange(): FRange

Represents the active selection in the sheet. Which means the selection contains the active cell.

Returns

FRange

The active selection.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fSelection = fWorksheet.getSelection();
const activeRange = fSelection.getActiveRange();
console.log(activeRange);

getActiveRangeList()


getActiveRangeList(): FRange[]

Represents the active selection list in the sheet.

Returns

FRange[]

The active selection list.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fSelection = fWorksheet.getSelection();
const activeRangeList = fSelection.getActiveRangeList();
console.log(activeRangeList);

getActiveSheet()


getActiveSheet(): FWorksheet

Returns the active sheet in the spreadsheet.

Returns

FWorksheet

The active sheet in the spreadsheet.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fSelection = fWorksheet.getSelection();
const activeSheet = fSelection.getActiveSheet();
console.log(activeSheet.equalTo(fWorksheet)); // true

getCurrentCell()


getCurrentCell(): any

Represents the current select cell in the sheet.

Returns

any

The current select cell info.Pay attention to the type of the return value.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fSelection = fWorksheet.getSelection();
const currentCell = fSelection.getCurrentCell();
console.log(currentCell);

getNextDataRange()


getNextDataRange(direction): FRange

Get the next primary cell in the specified direction. If the primary cell not exists in selections, return null.

Parameters

Parameter	Type	Description
`direction`	`Direction`	The direction to move the primary cell.The enum value is maybe one of the following: UP(0),RIGHT(1), DOWN(2), LEFT(3).

Returns

FRange

The next primary cell in the specified direction.

Example


// import { Direction } from '@univerjs/core';
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
// make sure the active cell is A1 and selection is A1:C3
const fSelection = fWorksheet.getSelection();
const nextCell = fSelection.getNextDataRange(Direction.RIGHT);
console.log(nextCell?.getA1Notation()); // B1

updatePrimaryCell()


updatePrimaryCell(cell): FSelection

Update the primary cell in the selection. if the primary cell not exists in selections, add it to the selections and clear the old selections.

Parameters

Parameter	Type	Description
`cell`	`FRange`	The new primary cell to update.

Returns

FSelection

The new selection after updating the primary cell.Because the selection is immutable, the return value is a new selection.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fSelection = fWorksheet.getSelection();
const cell = fWorksheet.getCell('A1');
const newSelection = fSelection.updatePrimaryCell(cell);
console.log(newSelection.getActiveRange().getA1Notation()); // A1