Excel JavaScript API 1.8 中的新增功能
Excel JavaScript API 要求集 1.8 的功能包括适用于数据透视表、数据验证、图表、图表事件、性能选项和工作簿创建的 API。
数据透视表
加载项通过数据透视表 API 的波形 2 设置数据透视表的层次结构。 现在可以控制数据及其聚合方式。 数据透视表一文详细介绍了新的数据透视表功能。
数据有效性
数据有效性可以控制用户在工作表中输入的内容。 可以将单元格限制为预定义的答案集，或者在用户输入无效数据时提供弹出警告。 立即详细了解向区域添加数据有效性。
图表
另一轮图表 API 可更好地对图表元素进行编程控制。 现在，你对图例、坐标轴、趋势线和绘图区拥有更高的访问权限。
事件
已为图表添加更多事件。 让加载项处理用于与图表的交互。 此外，你还可以在整个工作簿中触发事件。
API 列表
下表列出了 Excel JavaScript API 要求集 1.8 中的 API。 若要查看 Excel JavaScript API 要求集 1.8 或更低版本支持的所有 API 的 API 参考文档，请参阅 要求集 1.8 或更低版本中的 Excel API。
| 类 | 域 | 说明 |
|---|---|---|
| BasicDataValidation | formula1 | 当运算符属性设置为二进制运算符（如 GreaterThan (左侧操作数是用户尝试在单元格) 中输入的值时，指定右侧操作数。 |
| formula2 | 使用三元运算符 Between 和 NotBetween 指定上限操作数。 | |
| operator | 用于验证数据有效性的运算符。 | |
| Chart | categoryLabelLevel | 指定图表类别标签级别枚举常量，引用源类别标签的级别。 |
| displayBlanksAs | 指定在图表上绘制空白单元格的方式。 | |
| onActivated | 在激活图表时发生。 | |
| onDeactivated | 停用图表时发生。 | |
| plotArea | 表示图表的绘图区。 | |
| plotBy | 指定列或行在图表上用作数据系列的方式。 | |
| plotVisibleOnly | 如果仅绘制可见单元格，则为 True。 | |
| seriesNameLevel | 指定图表系列名称级别枚举常量，引用源系列名称的级别。 | |
| showDataLabelsOverMaximum | 指定当值大于数值轴上的最大值时是否显示数据标签。 | |
| style | 指定图表的图表样式。 | |
| ChartActivatedEventArgs | chartId | 获取激活的图表的 ID。 |
| type | 获取事件的类型。 | |
| worksheetId | 获取激活图表的工作表的 ID。 | |
| ChartAddedEventArgs | chartId | 获取添加到工作表的图表的 ID。 |
| source | 获取事件源。 | |
| type | 获取事件的类型。 | |
| worksheetId | 获取在其中添加图表的工作表的 ID。 | |
| ChartAxis | 对准 | 指定指定轴刻度线标签的对齐方式。 |
| isBetweenCategories | 指定值轴是否与类别之间的分类轴交叉。 | |
| 多级 | 指定轴是否为多级轴。 | |
| numberFormat | 指定轴刻度线标签的格式代码。 | |
| 抵消 | 指定标签级别之间的距离，以及第一级与轴线之间的距离。 | |
| position | 指定另一个轴交叉处的指定轴位置。 | |
| positionAt | 指定其他轴交叉的轴位置。 | |
| setPositionAt (值：数字) | 设置其他轴交叉处的指定轴位置。 | |
| textOrientation | 为图表轴刻度标签指定文本的方向。 | |
| ChartAxisFormat | fill | 指定图表填充格式。 |
| ChartAxisTitle | setFormula (公式：字符串) | 该字符串值表示采用 A1 表示法的图表轴标题的公式。 |
| ChartAxisTitleFormat | 边框 | 指定图表轴标题的边框格式，其中包括颜色、线条样式和粗细。 |
| fill | 指定图表轴标题的填充格式。 | |
| ChartBorder | clear() | 清除图表元素的边框格式。 |
| ChartCollection | onActivated | 在激活图表时发生。 |
| onAdded | 在将新图表添加到工作表时发生。 | |
| onDeactivated | 停用图表时发生。 | |
| onDeleted | 删除图表时发生。 | |
| ChartDataLabel | autoText | 指定数据标签是否根据上下文自动生成适当的文本。 |
| format | 表示图表数据标签的格式。 | |
| formula | 该字符串值表示采用 A1 表示法的图表数据标签的公式。 | |
| height | 返回图表数据标签的高度，以磅为单位。 | |
| horizontalAlignment | 表示图表数据标签水平对齐。 | |
| left | 表示图表数据标签左边缘到图表区域左边缘的距离，以磅为单位。 | |
| numberFormat | 该字符串值表示数据标签的格式代码。 | |
| text | 该字符串表示图表上的数据标签文本。 | |
| textOrientation | 表示文本针对图表数据标签所指向的角度。 | |
| top | 表示图表数据标签上边缘到图表区域顶部的距离，以磅为单位。 | |
| verticalAlignment | 表示图表数据标签垂直对齐。 | |
| width | 返回图表数据标签的宽度，以磅为单位。 | |
| ChartDataLabelFormat | 边框 | 表示边框格式，包括颜色、线条样式和粗细。 |
| ChartDataLabels | autoText | 指定数据标签是否根据上下文自动生成适当的文本。 |
| horizontalAlignment | 指定图表数据标签的水平对齐方式。 | |
| numberFormat | 指定数据标签的格式代码。 | |
| textOrientation | 表示数据标签的文本所指向的角度。 | |
| verticalAlignment | 表示图表数据标签垂直对齐。 | |
| ChartDeactivatedEventArgs | chartId | 获取已停用的图表的 ID。 |
| type | 获取事件的类型。 | |
| worksheetId | 获取停用图表的工作表的 ID。 | |
| ChartDeletedEventArgs | chartId | 获取从工作表中删除的图表的 ID。 |
| source | 获取事件源。 | |
| type | 获取事件的类型。 | |
| worksheetId | 获取要在其中删除图表的工作表的 ID。 | |
| ChartLegendEntry | height | 指定图表图例上图例条目的高度。 |
| index | 指定图表图例中图例项的索引。 | |
| left | 指定图表图例条目的左侧值。 | |
| top | 指定图表图例条目的顶部。 | |
| width | 表示图表图例上图例条目的宽度。 | |
| ChartLegendFormat | 边框 | 表示边框格式，包括颜色、线条样式和粗细。 |
| ChartPlotArea | format | 指定图表绘图区的格式设置。 |
| height | 指定绘图区的高度值。 | |
| insideHeight | 指定绘图区的内部高度值。 | |
| insideLeft | 指定绘图区的左侧内部值。 | |
| insideTop | 指定绘图区的内部顶部值。 | |
| insideWidth | 指定绘图区的内部宽度值。 | |
| left | 指定绘图区的左侧值。 | |
| position | 指定绘图区的位置。 | |
| top | 指定绘图区的最大值。 | |
| width | 指定绘图区的宽度值。 | |
| ChartPlotAreaFormat | 边框 | 指定图表绘图区的边框属性。 |
| fill | 指定对象的填充格式，其中包括背景格式信息。 | |
| ChartSeries | axisGroup | 指定指定系列的组。 |
| dataLabels | 表示系列中所有数据标签的集合。 | |
| 爆炸 | 指定饼图或圆环图切片的爆炸值。 | |
| firstSliceAngle | 指定第一个饼图或圆环图切片的角度，以度为单位， (垂直) 顺时针。 | |
| invertIfNegative | 如此 如果 Excel 反转项中的模式，当它对应于负数。 | |
| 重叠 | 指定条柱的摆放方式。 | |
| secondPlotSize | 以主饼图大小百分比的形式指定饼图或条形图的次要部分的大小。 | |
| splitType | 指定饼图或饼图条形图的两个部分的拆分方式。 | |
| varyByCategories | 如果 Excel 为每个数据标记分配不同的颜色或图案，则为 True。 | |
| ChartTrendline | 向后Period | 表示趋势线向后延伸的周期数。 |
| forwardPeriod | 表示趋势线向前延伸的周期数。 | |
| 标签 | 表示图表趋势线的标签。 | |
| showEquation | 如果图表上显示趋势线公式，则为 True。 | |
| showRSquared | 如此 如果趋势线的 r 平方值显示在图表上。 | |
| ChartTrendlineLabel | autoText | 指定趋势线标签是否根据上下文自动生成适当的文本。 |
| format | 图表趋势线标签的格式。 | |
| formula | 表示使用 A1 样式表示法的图表趋势线标签公式的字符串值。 | |
| height | 返回图表趋势线标签的高度，以磅为单位。 | |
| horizontalAlignment | 表示图表趋势线标签的水平对齐方式。 | |
| left | 表示从图表趋势线标签的左边缘到图表区左边缘的距离（以磅为单位）。 | |
| numberFormat | 表示趋势线标签的格式代码的字符串值。 | |
| text | 该字符串表示图表上的趋势线标签文本。 | |
| textOrientation | 表示文本针对图表趋势线标签的方向角度。 | |
| top | 表示从图表趋势线标签的上边缘到图表区顶部的距离（以磅为单位）。 | |
| verticalAlignment | 表示图表趋势线标签的垂直对齐方式。 | |
| width | 返回图表趋势线标签的宽度，以磅为单位。 | |
| ChartTrendlineLabelFormat | 边框 | 指定边框格式，包括颜色、线条样式和粗细。 |
| fill | 指定当前图表趋势线标签的填充格式。 | |
| font | 指定 (字体属性，例如图表趋势线标签的字体名称、字号和颜色) 。 | |
| CustomDataValidation | formula | 自定义数据验证公式。 |
| DataPivotHierarchy | field | 返回与 DataPivotHierarchy 相关联的 PivotFields。 |
| id | DataPivotHierarchy 的 ID。 | |
| 名称 | DataPivotHierarchy 的名称。 | |
| numberFormat | DataPivotHierarchy 的数字格式。 | |
| position | DataPivotHierarchy 的位置。 | |
| setToDefault () | 将 DataPivotHierarchy 重置回其默认值。 | |
| showAs | 指定数据是否应显示为特定的摘要计算。 | |
| summarizeBy | 指定是否显示 DataPivotHierarchy 的所有项。 | |
| DataPivotHierarchyCollection | add (pivotHierarchy：Excel.PivotHierarchy) | 将 PivotHierarchy 添加到当前轴。 |
| getCount() | 获取集合中的透视层级结构的数量。 | |
| getItem(name: string) | 按名称或 ID 获取 DataPivotHierarchy。 | |
| getItemOrNullObject(name: string) | 按名称获取 DataPivotHierarchy。 | |
| items | 获取此集合中已加载的子项。 | |
| 删除 (DataPivotHierarchy：Excel.DataPivotHierarchy) | 从当前轴删除 PivotHierarchy。 | |
| DataValidation | clear() | 清除当前区域中的数据有效性。 |
| errorAlert | 用户输入无效数据时，出现错误警报。 | |
| ignoreBlanks | 指定是否对空白单元格执行数据验证。 | |
| prompt | 当用户选择单元格时提示。 | |
| 规则 | 包含不同类型的数据验证条件的数据验证规则。 | |
| type | 数据验证的类型，有关详细信息，请参阅 Excel.DataValidationType 。 |
|
| 有效 | 表示所有单元格值根据数据有效性规则是否全部有效。 | |
| DataValidationErrorAlert | 邮件 | 表示错误警报消息。 |
| showAlert | 指定当用户输入无效数据时是否显示错误警报对话框。 | |
| style | 有关详细信息，请参阅 Excel.DataValidationAlertStyle 数据验证警报类型。 |
|
| title | 表示错误警报对话框标题。 | |
| DataValidationPrompt | 邮件 | 指定提示的消息。 |
| showPrompt | 指定当用户选择具有数据验证的单元格时是否显示提示。 | |
| title | 指定提示的标题。 | |
| DataValidationRule | 自 定义 | 自定义数据有效性条件。 |
| date | 日期数据有效性条件。 | |
| 十进制 | 小数数据有效性条件。 | |
| 列表 | 列表数据有效性条件。 | |
| textLength | 文本长度数据验证条件。 | |
| time | 时间数据有效性条件。 | |
| wholeNumber | 整数数据验证条件。 | |
| DateTimeDataValidation | formula1 | 当运算符属性设置为二进制运算符（如 GreaterThan (左侧操作数是用户尝试在单元格) 中输入的值时，指定右侧操作数。 |
| formula2 | 使用三元运算符 Between 和 NotBetween 指定上限操作数。 | |
| operator | 用于验证数据有效性的运算符。 | |
| FilterPivotHierarchy | enableMultipleFilterItems | 确定是否允许多个筛选项。 |
| fields | 返回与 FilterPivotHierarchy 相关联的 PivotFields。 | |
| id | FilterPivotHierarchy 的 ID。 | |
| 名称 | FilterPivotHierarchy 的名称。 | |
| position | FilterPivotHierarchy 的位置。 | |
| setToDefault () | 将 FilterPivotHierarchy 重置回其默认值。 | |
| FilterPivotHierarchyCollection | add (pivotHierarchy：Excel.PivotHierarchy) | 将 PivotHierarchy 添加到当前轴。 |
| getCount() | 获取集合中的透视层级结构的数量。 | |
| getItem(name: string) | 按名称或 ID 获取 FilterPivotHierarchy。 | |
| getItemOrNullObject(name: string) | 按名称获取 FilterPivotHierarchy。 | |
| items | 获取此集合中已加载的子项。 | |
| 删除 (filterPivotHierarchy：Excel.FilterPivotHierarchy) | 从当前轴删除 PivotHierarchy。 | |
| ListDataValidation | inCellDropDown | 指定是否在单元格下拉列表中显示列表。 |
| source | 数据有效性列表源 | |
| PivotField | id | PivotField 的 ID。 |
| 项目 | 返回与 PivotField 关联的 PivotItems。 | |
| 名称 | PivotField 的名称。 | |
| showAllItems | 确定是否显示 PivotField 的所有项。 | |
| sortByLabels (sortBy： SortBy) | PivotField 排序。 | |
| subtotals | PivotField 小计。 | |
| PivotFieldCollection | getCount() | 获取集合中透视字段的数目。 |
| getItem(name: string) | 按名称或 ID 获取 PivotField。 | |
| getItemOrNullObject(name: string) | 按名称获取透视字段。 | |
| items | 获取此集合中已加载的子项。 | |
| PivotHierarchy | fields | 返回与 PivotHierarchy 相关联的 PivotFields。 |
| id | PivotHierarchy 的 ID。 | |
| 名称 | PivotHierarchy 的名称。 | |
| PivotHierarchyCollection | getCount() | 获取集合中的透视层级结构的数量。 |
| getItem(name: string) | 按名称或 ID 获取 PivotHierarchy。 | |
| getItemOrNullObject(name: string) | 按名称获取 PivotHierarchy。 | |
| items | 获取此集合中已加载的子项。 | |
| PivotItem | id | PivotItem 的 ID。 |
| isExpanded | 确定是展开项以显示子项还是折叠项并隐藏子项。 | |
| 名称 | PivotItem 的名称。 | |
| visible | 指定 PivotItem 是否可见。 | |
| PivotItemCollection | getCount() | 获取集合中 PivotItems 的数目。 |
| getItem(name: string) | 按名称或 ID 获取 PivotItem。 | |
| getItemOrNullObject(name: string) | 按名称获取 PivotItem。 | |
| items | 获取此集合中已加载的子项。 | |
| PivotLayout | getColumnLabelRange () | 返回数据透视表列标签所在位置的区域。 |
| getDataBodyRange () | 返回数据透视表数据值所在位置的区域。 | |
| getFilterAxisRange () | 返回数据透视表筛选区的区域。 | |
| getRange() | 返回存在数据透视表的区域，不包括筛选区。 | |
| getRowLabelRange () | 返回数据透视表行标签所在位置的区域。 | |
| layoutType | 此属性指示数据透视表上的所有字段的 PivotLayoutType。 | |
| showColumnGrandTotals | 指定数据透视表是否显示列的总计。 | |
| showRowGrandTotals | 指定数据透视表是否显示行的总计。 | |
| subtotalLocation | 此属性指示 SubtotalLocationType 数据透视表上所有字段的 。 |
|
| PivotTable | columnHierarchies | 数据透视表的列透视层级结构。 |
| dataHierarchies | 数据透视表的数据透视层级结构。 | |
| delete() | 删除 PivotTable 对象。 | |
| filterHierarchies | 数据透视表的筛选器透视层级结构。 | |
| 层次 结构 | 数据透视表的透视层级结构。 | |
| 布局 | PivotLayout，用于说明数据透视表的布局和可视化结构。 | |
| rowHierarchies | 数据透视表的行透视层级结构。 | |
| PivotTableCollection | 添加 (名称： string， source： Range |字符串|表，目标：范围|字符串) | 根据指定的源数据添加数据透视表，并将其插入目标区域的左上角单元格。 |
| 区域 | dataValidation | 返回数据有效性对象。 |
| RowColumnPivotHierarchy | fields | 返回与 RowColumnPivotHierarchy 相关联的 PivotFields。 |
| id | RowColumnPivotHierarchy 的 ID。 | |
| 名称 | RowColumnPivotHierarchy 的名称。 | |
| position | RowColumnPivotHierarchy 的位置。 | |
| setToDefault () | 将 RowColumnPivotHierarchy 重置回其默认值。 | |
| RowColumnPivotHierarchyCollection | add (pivotHierarchy：Excel.PivotHierarchy) | 将 PivotHierarchy 添加到当前轴。 |
| getCount() | 获取集合中的透视层级结构的数量。 | |
| getItem(name: string) | 按名称或 ID 获取 RowColumnPivotHierarchy。 | |
| getItemOrNullObject(name: string) | 按名称获取 RowColumnPivotHierarchy。 | |
| items | 获取此集合中已加载的子项。 | |
| 删除 (rowColumnPivotHierarchy： Excel.RowColumnPivotHierarchy) | 从当前轴删除 PivotHierarchy。 | |
| 运行时 | enableEvents | 在当前任务窗格或内容外接程序中切换 JavaScript 事件。 |
| ShowAsRule | baseField | 计算依据的 ShowAs 透视字段（如果适用，根据 ShowAsCalculation 类型），否则 null为 。 |
| baseItem | 要基于计算的 ShowAs 项（如果适用，根据 ShowAsCalculation 类型），否则 null为 。 |
|
| 计算 |
ShowAs用于透视字段的计算。 |
|
| 样式 | autoIndent | 指定当单元格中的文本对齐方式设置为相等分布时，是否自动缩进文本。 |
| textOrientation | 此样式中的文本方向。 | |
| Subtotals | automatic | 如果 Automatic 设置为 true，则在设置 Subtotals时将忽略所有其他值。 |
| 平均 | ||
| count | ||
| countNumbers | ||
| 麦克斯 | ||
| min | ||
| 产品 | ||
| standardDeviation | ||
| standardDeviationP | ||
| 和 | ||
| 方差 | ||
| varianceP | ||
| Table | legacyId | 返回数字 ID。 |
| TableChangedEventArgs | getRange(ctx: Excel.RequestContext) | 获取表示特定工作表上表格已更改区域的区域的区域。 |
| getRangeOrNullObject(ctx: Excel.RequestContext) | 获取表示特定工作表上表格已更改区域的区域的区域。 | |
| Workbook | readOnly |
true如果工作簿在只读模式下打开，则返回 。 |
| WorkbookCreated | ||
| Worksheet | onCalculated | 在计算工作表时发生。 |
| showGridlines | 指定网格线是否对用户可见。 | |
| showHeadings | 指定标题是否对用户可见。 | |
| WorksheetCalculatedEventArgs | type | 获取事件的类型。 |
| worksheetId | 获取进行计算的工作表的 ID。 | |
| WorksheetChangedEventArgs | getRange(ctx: Excel.RequestContext) | 获取区域，该区域表示特定工作表上的更改区域。 |
| getRangeOrNullObject(ctx: Excel.RequestContext) | 获取区域，该区域表示特定工作表上的更改区域。 | |
| WorksheetCollection | onCalculated | 在计算工作簿中的任何工作表时发生。 |