本文介绍了如何使用 Excel JavaScript API 调用内置 Excel 工作表函数(如
VLOOKUP
和
SUM
)。 其中还收录了可以使用 Excel JavaScript API 调用的内置 Excel 工作表函数的完整列表。
若要了解如何使用 Excel JavaScript API 在 Excel 中创建
自定义函数
,请参阅
在 Excel 中创建自定义函数
。
创建工作表函数
下面的代码片段展示了如何调用工作表函数,其中
sampleFunction()
是占位符,应将它替换为要调用的函数名称和函数需要使用的输入参数。
value
工作表函数返回的 对象的 属性
FunctionResult
包含指定函数的结果。 如本示例所示,必须先
load
value
读取 对象的 属性
FunctionResult
。 在此示例中,函数结果被直接写入控制台。
await Excel.run(async (context) => {
let functionResult = context.workbook.functions.sampleFunction();
functionResult.load('value');
await context.sync();
console.log('Result of the function: ' + functionResult.value);
有关可以使用 Excel JavaScript API 调用的函数列表,请参阅本文的支持的工作表函数部分。
下图展示了 Excel 工作表中的表格,其中包含三个月内各种工具的销售数据。 表格中的每个数字均表示具体工具在特定月份中的销售件数。 接下来的两个示例展示了如何向此类数据应用内置工作表函数。
示例 1:单函数
下面的代码示例向前述示例数据应用 VLOOKUP
函数,以确定 11 月售出的扳手数。
await Excel.run(async (context) => {
let range = context.workbook.worksheets.getItem("Sheet1").getRange("A1:D4");
let unitSoldInNov = context.workbook.functions.vlookup("Wrench", range, 2, false);
unitSoldInNov.load('value');
await context.sync();
console.log(' Number of wrenches sold in November = ' + unitSoldInNov.value);
示例 2:嵌套函数
下面的代码示例向前述示例数据应用 VLOOKUP
函数,以分别确定 11 月和 12 月售出的扳手数。然后,应用 SUM
函数,以计算这两个月售出的扳手总数。
如此示例所示,如果一个或多个函数调用嵌套在另一个函数调用中,只需对随后要读取的最终结果(在此示例中为 load
)执行 sumOfTwoLookups
操作即可。 系统会计算所有中间结果(在此示例中,为每个 VLOOKUP
函数的结果),并根据这些中间结果计算最终结果。
await Excel.run(async (context) => {
let range = context.workbook.worksheets.getItem("Sheet1").getRange("A1:D4");
let sumOfTwoLookups = context.workbook.functions.sum(
context.workbook.functions.vlookup("Wrench", range, 2, false),
context.workbook.functions.vlookup("Wrench", range, 3, false)
sumOfTwoLookups.load('value');
await context.sync();
console.log(' Number of wrenches sold in November and December = ' + sumOfTwoLookups.value);
支持的工作表函数
可以使用 Excel JavaScript API 调用以下内置 Excel 工作表函数。