FRangeSheetsMCP
| packages | @univerjs-pro/sheets-mcp |
|---|
APIs
getFormulaUsages
Get all formula usages in the range
Signature
getFormulaUsages(): Promise<IFormulaUsage[]>Returns
- (
Promise<IFormulaUsage[]>) — A promise that resolves to an array of formula usages
Examples
const workbook = univerAPI.getActiveWorkbook()
const sheet = workbook.getActiveSheet()
const range = sheet.getRangeByA1('A1:C10')
const usages = await range.getFormulaUsages()getFormulaUsagesAsA1
Get all formula usages in the range in A1 notation
Signature
getFormulaUsagesAsA1(): Promise<IFormulaUsageAsA1[]>Returns
- (
Promise<IFormulaUsageAsA1[]>) — A promise that resolves to an array of formula usages in A1 notation
Examples
const workbook = univerAPI.getActiveWorkbook()
const sheet = workbook.getActiveSheet()
const range = sheet.getRangeByA1('A1:C10')
const usagesA1 = await range.getFormulaUsagesAsA1()getSizeUsages
Get all row height and column width usages in the range
Signature
getSizeUsages(options?: IGetSizeUsagesOptions): ISizeUsageGroupedParameters
options(IGetSizeUsagesOptions) — options for max count
Returns
- (
ISizeUsageGrouped) — Grouped size usages with widths and heights
Examples
const workbook = univerAPI.getActiveWorkbook()
const sheet = workbook.getActiveSheet()
const range = sheet.getRangeByA1('A1:C10')
const usages = range.getSizeUsages()
// or limit results
const usagesLimited = range.getSizeUsages({ maxCount: 100 })getSizeUsagesAsA1
Get all row height and column width usages in the range in A1 notation
Signature
getSizeUsagesAsA1(options?: IGetSizeUsagesOptions): ISizeUsageGroupedAsA1Parameters
options(IGetSizeUsagesOptions) — options for max count
Returns
- (
ISizeUsageGroupedAsA1) — Grouped size usages in A1 notation with widths and heights
Examples
const workbook = univerAPI.getActiveWorkbook()
const sheet = workbook.getActiveSheet()
const range = sheet.getRangeByA1('A1:C10')
const usagesA1 = range.getSizeUsagesAsA1()
// or limit results
const usagesA1Limited = range.getSizeUsagesAsA1({ maxCount: 100 })getStyleUsages
Get all style usages in the range
Signature
getStyleUsages(options?: IGetStyleUsagesOptions): IStyleUsage[]Parameters
options(IGetStyleUsagesOptions) — options for filtering style properties and max count
Returns
- (
IStyleUsage[]) — An array of style usages
Examples
const workbook = univerAPI.getActiveWorkbook()
const sheet = workbook.getActiveSheet()
const range = sheet.getRangeByA1('A1:C10')
const usages = range.getStyleUsages()
// or filter by specific properties
const usagesFiltered = range.getStyleUsages({ properties: ['fontSize', 'fontFamily', 'width'] })
// or limit results
const usagesLimited = range.getStyleUsages({ maxCount: 100 })getStyleUsagesAsA1
Get all style usages in the range in A1 notation
Signature
getStyleUsagesAsA1(options?: IGetStyleUsagesOptions): IStyleUsageAsA1[]Parameters
options(IGetStyleUsagesOptions) — options for filtering style properties and max count
Returns
- (
IStyleUsageAsA1[]) — An array of style usages in A1 notation
Examples
const workbook = univerAPI.getActiveWorkbook()
const sheet = workbook.getActiveSheet()
const range = sheet.getRangeByA1('A1:C10')
const usagesA1 = range.getStyleUsagesAsA1()
// or filter by specific properties
const usagesA1Filtered = range.getStyleUsagesAsA1({ properties: ['fontSize', 'fontFamily', 'height'] })
// or limit results
const usagesA1Limited = range.getStyleUsagesAsA1({ maxCount: 100 })