Excel JavaScript 预览 API

  • 项目

新的 Excel JavaScript API 首先在“预览版”中引入，在进行充分测试并获得用户反馈后，它将成为编号的特定要求集的一部分。

注意

预览 API 可能会发生变更，不适合在生产环境中使用。 我们建议你仅在测试和开发环境中试用它们。 不要在生产环境或业务关键型文档中使用预览 API。

若要使用预览 API：

下表提供了 API 的简明摘要，而后续 的 API 列表 表提供了详细的列表。

功能区域 说明 相关对象
文档任务 将批注转换为分配给用户的任务。 DocumentTask、 DocumentTaskChange、 DocumentTaskChangeCollection、 DocumentTaskCollection
链接数据类型 添加了对从外部源连接到 Excel 的数据类型的支持。 LinkedDataType、 LinkedDataTypeAddedEventArgs、 LinkedDataTypeCollection
表样式 为表格样式的字体、边框、填充颜色和其他方面提供控件。 表、 数据透视表、 切片器

API 列表

下表列出了当前处于预览状态的 Excel JavaScript API。 有关所有 Excel JavaScript API 的完整列表， (包括预览 API 和以前发布的 API) ，请参阅 所有 Excel JavaScript API。

类 域 说明
Application formatStaleValues 指定是启用还是禁用“计算选项”中的“设置过时值格式”选项。
Base64EncodedImage data base64 字符串编码。
type 编码图像的文件类型。
Chart getDataRange () 获取整个图表的数据源。
getDataRangeOrNullObject () 获取整个图表的数据源。
Comment assignTask (分配者：Excel.EmailIdentity) 将附加到批注的任务作为代理人分配给给定用户。
getTask () 获取与此注释关联的任务。
getTaskOrNullObject () 获取与此注释关联的任务。
CommentReply assignTask (分配者：Excel.EmailIdentity) 将附加到注释的任务分配给给定用户作为唯一的代理人。
getTask () 获取与此批注回复的线程关联的任务。
getTaskOrNullObject () 获取与此批注回复的线程关联的任务。
DocumentTask assign (assignee： Excel.EmailIdentity) 将给定用户添加到附加到任务的被分配者列表中。
assignees 返回任务的被分配人的集合。
变化 获取任务的更改记录。
comment 获取与任务关联的注释。
completedBy 获取完成该任务的最新用户。
completedDateTime 获取任务的完成日期和时间。
createdBy 获取创建任务的用户。
createdDateTime 获取任务的创建日期和时间。
id 获取任务的 ID。
percentComplete 指定任务的完成百分比。
优先 指定任务的优先级。
startAndDueDateTime 获取或设置任务应开始和到期的日期和时间。
title 指定任务的标题。
取消分配 (被分配者：Excel.EmailIdentity) 从附加到任务的被分配者列表中删除给定用户。
unassignAll () 从附加到任务的被分配者列表中删除所有用户。
DocumentTaskChange assignee 表示为更改操作分配给任务 assign 的用户，或取消为更改操作分配任务 unassign 的用户。
changedBy 表示执行任务更改的用户的标识。
commentId 表示任务更改已定位到的 或 commentReply 的 IDcomment。
createdDateTime 表示任务更改记录的创建日期和时间。
dueDateTime 表示任务的截止日期和时间。
id 任务更改的唯一 GUID。
percentComplete 表示任务的完成百分比。
优先 表示任务的优先级。
startDateTime 表示任务的开始日期和时间。
title 表示任务的标题。
type 表示任务更改记录的操作类型。
undoChangeId 表示为 DocumentTaskChange.id 更改操作撤消 undo 的属性。
DocumentTaskChangeCollection getCount() 获取任务集合中更改记录的数目。
getItemAt(index: number) 通过使用任务更改记录在集合中的索引来获取该记录。
items 获取此集合中已加载的子项。
DocumentTaskCollection getCount() 获取集合中的任务数。
getItem(key: string) 使用其 ID 获取任务。
getItemAt(index: number) 按集合中的索引获取任务。
getItemOrNullObject(key: string) 使用其 ID 获取任务。
items 获取此集合中已加载的子项。
DocumentTaskSchedule dueDateTime 获取任务的截止日期和时间。
startDateTime 获取任务应开始的日期和时间。
EmailIdentity displayName 表示用户的显示名称。
email 表示用户的电子邮件。
id 表示用户的唯一 ID。
EntityArrayCardLayout arrayProperty 表示属性的名称，该属性包含卡中显示的数组。
columnsToReport 表示数组中声明卡列的计数。
displayName 表示属性的名称，该属性包含卡中显示的数组。
firstRowIsHeader 表示数组的第一行是否被视为标头。
布局 表示此布局的类型。
rowsToReport 表示数组中卡声明的行数。
EntityCardLayout 布局 表示此布局的类型。
ExternalCodeServiceObjectCellValue Python_str 表示在此 对象上使用 str () 函数的输出。
Python_type 表示此对象的全类型名称。
Python_typeName 表示此对象的短类型名称。
basicType 表示将为具有此值的单元格返回 Range.valueTypes 的值。
basicValue 表示将为具有此值的单元格返回 Range.values 的值。
language 表示此外部代码服务的运行时语言。
预览 表示单元格中显示的预览值。
type 表示此单元格值的类型。
标识 displayName 表示用户的显示名称。
id 表示用户的唯一 ID。
LinkedDataType dataProvider 链接数据类型的数据提供程序的名称。
lastRefreshed 自上次刷新链接数据类型时打开工作簿以来的本地时区日期和时间。
名称 链接数据类型的名称。
periodicRefreshInterval 如果 refreshMode 设置为“定期”，则刷新链接数据类型的频率（以秒为单位）。
refreshMode 检索链接数据类型数据的机制。
requestRefresh () 发出刷新链接数据类型的请求。
requestSetRefreshMode (refreshMode：Excel.LinkedDataTypeRefreshMode) 发出更改此链接数据类型的刷新模式的请求。
服务 Id 链接数据类型的唯一 ID。
supportedRefreshModes 返回一个数组，其中包含链接数据类型支持的所有刷新模式。
LinkedDataTypeAddedEventArgs 服务 Id 新链接数据类型的唯一 ID。
source 获取事件源。
type 获取事件的类型。
LinkedDataTypeCollection getCount() 获取集合中链接数据类型的数量。
getItem (键：数字) 按服务 ID 获取链接数据类型。
getItemAt(index: number) 按集合中的索引获取链接数据类型。
getItemOrNullObject (key： number) 按 ID 获取链接数据类型。
items 获取此集合中已加载的子项。
requestRefreshAll () 发出刷新集合中的所有链接数据类型的请求。
LocalImageCellValue altText 表示辅助功能方案中用于描述图像所表示内容的备用文本。
归 因 表示属性信息，用于描述此图像的源和许可证要求。
basicType 表示将为具有此值的单元格返回 Range.valueTypes 的值。
basicValue 表示将为具有此值的单元格返回 Range.values 的值。
image 表示图像本身（缓存或编码）。
供应商 表示描述提供图像的实体或个人的信息。
type 表示此单元格值的类型。
LocalImageCellValueCacheId cacheUid 表示图像在缓存中显示的 UID。
NamedSheetViewCollection getItemOrNullObject(key: string) 使用其名称获取工作表视图。
PivotLayout getCell (dataHierarchy：DataPivotHierarchy |string， rowItems： Array<PivotItem | string>， columnItems： Array<PivotItem | string>) 根据数据层次结构以及各自层次结构的行和列项，获取数据透视表中的唯一单元格。
pivotStyle 应用于数据透视表的样式。
setStyle (样式：字符串 |PivotTableStyle |BuiltInPivotTableStyle) 设置应用于数据透视表的样式。
PythonErrorCellValue basicType 表示将为具有此值的单元格返回 Range.valueTypes 的值。
basicValue 表示将为具有此值的单元格返回 Range.values 的值。
errorType 表示 的类型 ErrorCellValue。
type 表示此单元格值的类型。
Query delete() 删除查询和关联的连接。
refresh() 刷新查询。
QueryCollection refreshAll () 刷新所有查询。
区域
RangeAreas
RefreshModeChangedEventArgs refreshMode 链接数据类型刷新模式。
服务 Id 刷新模式已更改的对象的唯一 ID。
source 获取事件源。
type 获取事件的类型。
RefreshRequestCompletedEventArgs 刷新 指示刷新请求是否成功。
服务 Id 其刷新请求已完成的对象的唯一 ID。
source 获取事件源。
type 获取事件的类型。
警告 一个数组，其中包含从刷新请求生成的任何警告。
ShapeCollection addSvg(xml: string) 从 XML 字符串创建可缩放的矢量图形 (SVG) 并将其添加到工作表。
Slicer nameInFormula 表示公式中使用切片器名称。
setStyle (样式：字符串 |SlicerStyle |BuiltInSlicerStyle) 设置应用于切片器的样式。
slicerStyle 应用于切片器的样式。
Table clearStyle() 将表格更改为使用默认表格样式。
onFiltered 在对特定表应用筛选器时发生。
setStyle (样式：字符串 |TableStyle |BuiltInTableStyle) 设置应用于表的样式。
tableStyle 应用于表的样式。
TableCollection onFiltered 在工作簿或工作表中的任何表上应用筛选器时发生。
TableFilteredEventArgs tableId 获取应用筛选器的表的 ID。
type 获取事件的类型。
worksheetId 获取包含表的工作表的 ID。
TimeoutErrorCellValue basicType 表示将为具有此值的单元格返回 Range.valueTypes 的值。
basicValue 表示将为具有此值的单元格返回 Range.values 的值。
errorSubType 表示 的类型 TimeoutErrorCellValue。
errorType 表示 的类型 ErrorCellValue。
type 表示此单元格值的类型。
Workbook externalCodeServiceTimeout 指定为依赖于外部代码服务的公式分配的最大时间长度（以秒为单位）。
linkedDataTypes 返回属于工作簿的一部分的链接数据类型的集合。
showPivotFieldList 指定是否在工作簿级别显示数据透视表的字段列表窗格。
任务 返回工作簿中存在的任务的集合。
use1904DateSystem 如果工作簿使用 1904 日期系统，则为 True。
Worksheet onFiltered 在特定工作表上应用筛选器时发生。
任务 返回工作表中存在的任务的集合。
WorksheetCollection addFromBase64 (base64File： string， sheetNamesToInsert？： string[]， positionType？： Excel.WorksheetPositionType， relativeTo？： Worksheet |字符串) 将工作簿的指定工作表插入当前工作簿。
onFiltered 在工作簿中应用任何工作表的筛选器时发生。
WorksheetFilteredEventArgs type 获取事件的类型。
worksheetId 获取应用筛选器的工作表的 ID。

另请参阅