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 、 before 、 after 和 between 筛选器条件,指示是否应将比较作为整天进行。 |
|
PivotField | applyFilter (筛选器:Excel.PivotFilters) | 设置字段的一个或多个当前数据透视筛选器,并将其应用于字段。 |
clearAllFilters () | 清除所有字段筛选器中的所有条件。 | |
clearFilter (filterType:Excel.PivotFilterType) | 清除给定类型的字段筛选器中的所有现有条件, (当前) 应用条件。 | |
getFilters () | 获取字段上当前应用的所有筛选器。 | |
isFiltered (filterType?: Excel.PivotFilterType) | 检查字段上是否有任何已应用的筛选器。 | |
PivotFilters | dateFilter | PivotField 当前应用的日期筛选器。 |
labelFilter | PivotField 当前应用的标签筛选器。 | |
manualFilter | PivotField 当前应用的手动筛选器。 | |
valueFilter | PivotField 的当前应用值筛选器。 | |
PivotLabelFilter | 比较仪 | 比较器是与其他值进行比较的静态值。 |
条件 | 指定筛选器的条件,该条件定义必要的筛选条件。 | |
独家 | 如果 true 为 ,则筛选器 排除 满足条件的项目。 |
|
lowerBound | 筛选条件的范围的 between 下限。 |
|
substring | 用于 、 endsWith 和 contains 筛选条件的beginsWith 子字符串。 |
|
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 (键:string) |
RangeAreas 基于集合中的工作表 ID 或名称返回 对象。 |
|
getRangeAreasOrNullObjectBySheet (键:string) |
RangeAreas 根据集合中的工作表名称或 ID 返回 对象。 |
|
范围 | 返回在 对象中 RangeCollection 构成此对象的区域。 |
|
Worksheet | customProperties | 获取工作表级自定义属性的集合。 |
WorksheetCustomProperty | delete() | 删除 custom property 对象。 |
key | 获取 customProperty 的键。 | |
value | 获取或设置自定义属性的值。 | |
WorksheetCustomPropertyCollection | add (key: string, value: string) | 添加映射到提供的键的新自定义属性。 |
getCount() | 获取此工作表上的自定义属性数。 | |
getItem(key: string) | 按键获取自定义属性对象(不区分大小写)。 | |
getItemOrNullObject(key: string) | 按键获取自定义属性对象(不区分大小写)。 | |
items | 获取此集合中已加载的子项。 |