Excel JavaScript API 以编程方式控制 Excel 工作簿中的文本、表和图表。 在本单元中,你将了解如何使用表,包括格式设置选项、如何筛选数据以及对表中的数据进行排序。 你还将了解如何向工作表添加和自定义图表。
Microsoft 365开发人员平台(包括 Office)为开发人员提供了许多用于嵌入自定义项的画布,Office 加载项是三个画布之一:文档、对话和页面。
Microsoft Teams 在用户之间进行对话,使开发人员能够使用消息传递扩展、对话机器人和其他自定义选项来扩展体验。
开发人员使用 SharePoint 框架 自定义 SharePoint Server 和 SharePoint Online 中的页面。
还可以扩展 Office 客户端(如 Word、Excel、PowerPoint、OneNote 和 Outlook)以使用加载项实现自定义任务窗格、操作和其他自定义项。
首先,我们将了解适用于 Microsoft Excel 的 Office.js 的剖析:
- 当页面首次加载加载项时,所有 Office 加载项都必须停止 方法。
- 如果在加载项中使用较新的 Office.js 功能,请务必使用 API 检查客户端是否支持这些扩展。
- 对于 Excel JavaScript API,你可以使用 方法获取当前工作簿 的实例。
- 引用当前 Excel 工作簿的后,可以使用方法加载上下文中的任何属性。 此方法将添加请求队列,以便出于性能原因将多个请求链接在一起。
- 准备好检索已排队的属性或执行任何排队操作时,请使用 方法执行使用 方法定义的一批排队操作。
- 方法将返回一个 JavaScript 承诺,可用于获取结果或上一个操作并执行新操作。
- 最佳做法是,应侦听、捕获和处理使用 Excel JavaScript API 时可能发生的任何错误。
Excel 加载项开发人员应了解 Excel 工作簿的层次结构,以及它与 Office.js 中的对象之间的关系。
Office.js 通过 和 属性为 Excel 工作簿提供上下文。
工作簿包括含有多个集合的工作表。 这些集合包括图表、表和数据透视表等内容。
可以直接从工作簿对象(包括表和数据透视表)访问工作表中的许多对象。
工作表使用 和 方法来识别其同级。
可以使用 方法获取活动工作表,并使用 方法设置活动工作表。
Office.js 还提供许多工作表事件,如 、 和 ,开发人员可以在其自定义加载项中使用这些事件。
表是电子表格的核心。 Excel 支持定义数据范围,以作为数据表的基础。
范围表示一个或多个相邻的单元格,例如单元格、行、列、单元格块等。
可以使用工作表和地址获取包含 Office.js 的范围对象。 例如,范围"A1:D4"表示此屏幕截图中从左上到右下单元格的范围。
表是基于数据范围建立的。
函数接受具有标志的数据范围,以指示表是否具有标题。
可通过其命名范围或 ID 检索现有表。 开发人员还可以循环访问工作表中的表集合。
添加表后,可以使用二维数组添加标题和表行。
使用标题标志创建的表将使用数据范围中的第一行作为其标题。
还可以将 属性与二维数组一起使用来设置标题值。
以下代码片段演示了使用 Excel JavaScript API 的工作文本和段落的工作示例:
从工作表获取数据范围:
根据指定的范围将表插入到工作表中
从工作簿或工作表中按名称获取表
将标题行添加到指定的表
通过冻结最顶端的行来冻结标题行
删除表中的第二行
更新表中的第二行
将行添加到表的末尾
添加行
可以使用 Office.js 筛选表中的任何列。
若要筛选一列,请首先获取列的引用,然后使用 方法筛选特定值。
以下代码将按 Education 和 Groceries的值筛选表的类别列:
还可以分别使用表函数 和 ,以编程方式重新应用和清除表上的筛选器。
以下代码将演示如何重新应用和清除筛选器:
开发人员可以使用 Excel 加载项中的 Office.js API 对表数据进行排序。若要进行排序,请调用 方法并包含 参数以指定要排序的字段。
以下代码定义了排序字段的数组。 属性指定表中的列索引,布尔属性指定是按升序还是降序排序:
可以使用 和 方法重新应用和清除表排序。
Microsoft Excel 已成为一个数据操作和可视化的平台。 理所当然地,Excel JavaScript API 允许开发人员添加和操作图表。
图表存在于工作表中,但也可以直接从工作簿对象访问。
图表具有许多复杂的关系属性,可用于微调图表的外观。 其中包括标题、图例、轴、系列、标签和格式。
用户和开发人员可以基于数据范围创建图表,并且通常使用表创建图表。
函数用于创建一个图表,该图表接受图表、数据和。 参数支持以下值
- 自动
- 标量
- 矩阵
Excel 支持多种不同类型的图表。 开发人员可以使用 方法将图表添加到工作表。
参数指定要使用的图表类型。 有关Excel.ChartType enum的可用选项,请参阅 SDK。
参数指定系列是按行还是按列。 有关Excel.ChartSeriesBy enum的可用选项,请参阅 SDK。
Excel 图表对象包含开发人员可用于在 Excel 工作表中自定义图表的多个属性。 下表列出了 Office.js 图表对象中的一些常用属性:
除了上表中的属性外,图表对象还包括多个关系属性。 这些会影响图表在 Excel 中的显示方式:
以下代码示例演示如何使用 Office.js API 在 Excel 中创建和操作图表:
使用表数据添加聚集柱形图
按名称获取现有图表
修改图表属性,例如位置、标题、颜色和字号