Excel 中的新增功能 JavaScript API 1.12

ExcelApi 1.12 添加了用于跟踪动态数组和查找公式直接先例的 API,从而增强了对范围内公式的支持。 它还添加了数据透视表筛选器的 API 控制。 还改进了注释、区域性设置和自定义属性功能区域。

功能区域 说明 相关对象
评论事件 将添加、更改和删除事件添加到注释集合。 CommentCollection
日期和时间 区域性设置 允许访问有关日期和时间格式的其他区域性设置。 CultureInfo、 NumberFormatInfo应用程序
直接引用 返回用于计算单元格公式的区域。 区域
透视筛选器 将值驱动筛选器应用于数据透视表的字段。 PivotField、 PivotFilters
范围溢出 允许加载项查找与 动态数组 结果关联的范围。 区域
工作表级自定义属性 除了将自定义属性限定为工作簿级别外,还允许将自定义属性的范围限定为工作表级别。 WorksheetCustomProperty、 WorksheetCustomPropertyCollection

API 列表

下表列出了 Excel JavaScript API 要求集 1.12 中的 API。 若要查看 Excel JavaScript API 要求集 1.12 或更早版本支持的所有 API 的 API 参考文档,请参阅 要求集 1.12 或更早版本中的 Excel API。

类 域 说明
ChartAxisTitle textOrientation 指定图表轴标题时文本的方向角度。
ChartSeries getDimensionValues (维度:Excel.ChartSeriesDimension) 从图表系列的单个维度中获取值。
Comment contentType 获取注释的内容类型。
CommentAddedEventArgs commentDetails 获取 CommentDetail 包含评论 ID 及其相关回复 ID 的数组。
source 指定时间源。
type 获取事件的类型。
worksheetId 获取发生事件的工作表的 ID。
CommentChangedEventArgs changeType 获取表示如何触发更改的事件的更改类型。
commentDetails 获取包含 CommentDetail 评论 ID 及其相关回复的 ID 的数组。
source 指定时间源。
type 获取事件的类型。
worksheetId 获取发生事件的工作表的 ID。
CommentCollection onAdded 在添加注释时发生。
onChanged 当更改注释集中的注释或答复时(包括删除回复时)发生。
onDeleted 在注释集合中删除注释时发生。
CommentDeletedEventArgs commentDetails 获取 CommentDetail 包含评论 ID 及其相关回复 ID 的数组。
source 指定时间源。
type 获取事件的类型。
worksheetId 获取发生事件的工作表的 ID。
CommentDetail commentId 表示注释的 ID。
replyIds 表示属于注释的相关回复的 ID。
CommentReply contentType 回复的内容类型。
CultureInfo datetimeFormat 定义区域上适当的日期和时间显示格式。
DatetimeFormatInfo dateSeparator 获取用作日期分隔符的字符串。
longDatePattern 获取长日期值的格式字符串。
longTimePattern 获取长期值的格式字符串。
shortDatePattern 获取短日期值的格式字符串。
timeSeparator 获取用作时间分隔符的字符串。
PivotDateFilter 比较器 比较器是与其他值进行比较的静态值。
条件 指定筛选器的条件,该条件定义必要的筛选条件。
独家 如果 ,筛选 true器 将排除 符合条件的项目。
lowerBound 筛选条件的 between 范围下限。
upperBound 筛选条件的 between 范围上限。
wholeDays 对于 equals、 、 beforeafter和between筛选条件,指示比较是否应作为全天进行。
PivotField applyFilter (筛选器:Excel.PivotFilters) 设置字段的一个或多个当前 PivotFilter,并将它们应用到字段。
clearAllFilters () 清除该字段的所有筛选器中的所有条件。
clearFilter (filterType: Excel.PivotFilterType) 从给定类型的字段筛选器中清除所有现有条件 (如果当前已应用) 条件。
getFilters () 获取当前在字段上应用的所有筛选器。
isFiltered (filterType?: Excel.PivotFilterType) 检查字段上是否有任何应用的筛选器。
PivotFilters dateFilter 数据透视字段当前应用的日期筛选器。
labelFilter 数据透视字段当前应用的标签筛选器。
manualFilter 数据透视字段当前应用的手动筛选器。
valueFilter 数据透视字段当前应用的值筛选器。
PivotLabelFilter 比较器 比较器是与其他值进行比较的静态值。
条件 指定筛选器的条件,该条件定义必要的筛选条件。
独家 如果 ,筛选 true器 将排除 符合条件的项目。
lowerBound 筛选条件的 between 范围下限。
substring 用于 beginsWith、 和endsWithcontains筛选条件的子字符串。
upperBound 筛选条件的 between 范围上限。
PivotManualFilter selectedItems 要手动筛选的所选项目列表。
PivotTable allowMultipleFiltersPerField 指定数据透视表是否允许对表中的给定数据透视字段应用多个数据透视筛选器。
PivotTableScopedCollection getCount() 获取集合中的数据透视表数。
getFirst() 获取集合中的第一个数据透视表。
getItem(key: string) 按名称获取 PivotTable 对象。
getItemOrNullObject(name: string) 按名称获取 PivotTable 对象。
items 获取此集合中已加载的子项。
PivotValueFilter 比较器 比较器是与其他值进行比较的静态值。
条件 指定筛选器的条件,该条件定义必要的筛选条件。
独家 如果 ,筛选 true器 将排除 符合条件的项目。
lowerBound 筛选条件的 between 范围下限。
selectionType 指定筛选器是用于前/后 N 项、前/后 N 个百分比,还是最高/后 N 个总和。
阈值 要针对顶部/底部筛选条件筛选的项目、百分比或总和的“N”阈值数。
upperBound 筛选条件的 between 范围上限。
value 要作为筛选所依据的字段中所选“值”的名称。
区域 getDirectPrecedents () 返回一个 WorkbookRangeAreas 对象,该对象表示在同一工作表或多个工作表中包含指定区域的所有直接优先单元格的区域。
getPivotTables (fullyContained?: boolean) 获取与范围重叠的数据透视表的作用域集合。
getSpillParent() 获取 Range 对象,它包含要将某个单元格溢出到的定位单元格。
getSpillParentOrNullObject() 获取包含要溢出到的单元格的锚单元格的范围对象。
getSpillingToRange() 获取 Range 对象,它在调用定位单元格时包含溢出区域。
getSpillingToRangeOrNullObject() 获取 Range 对象,它在调用定位单元格时包含溢出区域。
hasSpill 表示所有单元格是否都具有溢出边框。
numberFormatCategories 表示每个单元格的数字格式类别。
savedAsArray 表示是否将所有单元格都另存为数组公式。
RangeAreasCollection getCount() 获取此集合中的对象数 RangeAreas 。
getItemAt(index: number) 基于集合中的位置返回 RangeAreas 对象。
items 获取此集合中已加载的子项。
WorkbookRangeAreas 地址 以 A1 样式返回地址数组。
areas 返回对象 RangeAreasCollection 。
getRangeAreasBySheet (key: string) RangeAreas基于集合中的工作表 ID 或名称返回对象。
getRangeAreasOrNullObjectBySheet (key: string) 基于集合中的工作表名称或 ID 返回 RangeAreas 对象。
范围 返回在对象中 RangeCollection 包含此对象的范围。
Worksheet customProperties 获取工作表级自定义属性的集合。
WorksheetCustomProperty delete() 删除 custom property 对象。
key 获取 customProperty 的键。
value 指定自定义属性的值。
WorksheetCustomPropertyCollection add (key: string, value: string) 添加映射到所提供键的新自定义属性。
getCount() 获取此工作表上的自定义属性数。
getItem(key: string) 按键获取自定义属性对象(不区分大小写)。
getItemOrNullObject(key: string) 按键获取自定义属性对象(不区分大小写)。
items 获取此集合中已加载的子项。

另请参阅