FSheetsFormulaUIUniver

packages	`@univerjs/sheets-formula-ui`

APIs

`showRangeSelectorDialog`

Shows the range selector dialog.

Signature

showRangeSelectorDialog(opts: IShowRangeSelectorDialogOptions): Promise<IUnitRangeName[]>

Parameters

opts (IShowRangeSelectorDialogOptions) — The options of the range selector dialog.

Returns

(Promise<IUnitRangeName[]>) — The selected ranges.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const unitId = fWorkbook.getId()

await univerAPI.showRangeSelectorDialog({
  unitId,
  subUnitId: fWorksheet.getSheetId(),
  initialValue: [{
    unitId,
    sheetName: fWorksheet.getSheetName(),
    range: fWorksheet.getRange('A1:B2').getRange(),
  }],
  maxRangeCount: 2,
  supportAcrossSheet: true,
  callback: (ranges, isCancel) => {
    // Handle the selected ranges
    console.log(ranges, isCancel)
  },
})

APIs

showRangeSelectorDialog

Table of Contents

`showRangeSelectorDialog`