Excel JavaScript API 1.7 的最近更新
Excel JavaScript API 要求集 1.7 的功能包括用于图表、事件、工作表、区域、文档属性、已命名项目、保护选项和样式的 API。
自定义图表
通过新的图表 API，你可以创建其他图表类型、向图表中添加数据系列、设置图表标题、添加轴标题、添加显示单位、添加采用移动平均值的趋势线、将趋势线更改为线性趋势线等。 以下是一些示例。
- 图表轴 - 获取、设置、格式化和删除图表中的轴单位、标签和标题。
- 图表系列 - 添加、设置和删除图表中的某个系列。 更改系列标记、绘制顺序和大小。
- 图表趋势线 - 添加、获取和格式化图表中的趋势线。
- 图表图例 - 设置图表中的图例字体的格式。
- 图表点 - 设置图表点颜色。
- 图表标题子字符串 - 获取和设置图表的标题子字符串。
- 图表类型 - 用于创建更多图表类型的选项。
事件
Excel 事件 API 提供了多个事件处理程序，以便加载项能够在发生特定事件时自动运行指定的函数。 可以将函数设计为执行方案所需的任何操作。 有关当前可用的事件列表，请参阅使用 Excel JavaScript API 处理事件。
自定义工作表和区域的外观
使用新的 API 可以通过多种方式自定义工作表的外观：
- 冻结窗格，使特定行或列在你滚动工作表时保持可见。 例如，如果工作表中的第一行包含标题，则可以冻结此行，以便在你向下滚动工作表时列标题保持可见。
- 修改工作表标签颜色。
- 添加工作表标题。
可以通过多种方式自定义区域的外观：
- 设置某个区域的单元格样式，确保该区域内的所有单元格采用一致的格式。 单元格 样式是一组定义的格式特征，例如字体和字号、数字格式、单元格边框和单元格底纹。 使用 Excel 中的任意内置单元格样式，或者使用自己的自定义单元格样式。
- 设置区域的文本方向。
- 添加或修改区域上链接至工作表中的其他位置或外部位置的超链接。
管理文档属性
使用文档属性 API，你可以访问内置文档属性，并且还可以创建和管理自定义文档属性，以存储工作表的状态和驱动工作流和业务逻辑。
复制工作表
使用工作表复制 APIs，你可以将一个工作表中的数据和格式复制到相同工作簿中的另一个工作表，从而减少所需的数据传输量。
轻松地处理区域
使用各种区域 API，你可以完成诸如获取周围区域、获取大小经过重设的区域之类的任务。 这些 API 可以显著提高诸如区域操作和寻址之类任务的效率。
此外：
- 工作簿和工作表保护选项 - 使用这些 API 可保护工作表和工作簿结构中的数据。
- 更新已命名项目 - 使用此 API 可更新已命名项目。
- 获取活动单元格 - 使用此 API 获取工作簿的活动单元格。
API 列表
下表列出了 Excel JavaScript API 要求集 1.7 中的 API。 若要查看 Excel JavaScript API 要求集 1.7 或更低版本支持的所有 API 的 API 参考文档，请参阅 要求集 1.7 或更低版本中的 Excel API。
| 类 | 域 | 说明 |
|---|---|---|
| Chart | chartType | 指定图表的类型。 |
| id | 图表的唯一 ID。 | |
| showAllFieldButtons | 指定是否在数据透视图上显示所有字段按钮。 | |
| ChartAreaFormat | 边境 | 表示图表区域的边框格式，包括颜色、线条样式和粗细。 |
| ChartAxes | getItem (类型：Excel.ChartAxisType， group？： Excel.ChartAxisGroup) | 返回通过类型和组标识的特定轴。 |
| ChartAxis | axisGroup | 指定指定轴的组。 |
| baseTimeUnit | 指定指定类别轴的基本单位。 | |
| categoryType | 指定类别轴类型。 | |
| customDisplayUnit | 指定自定义轴显示单位值。 | |
| displayUnit | 表示轴显示单位。 | |
| height | 指定图表轴的高度（以磅为单位）。 | |
| left | 指定从轴的左边缘到图表区左侧的距离（以磅为单位）。 | |
| logBase | 指定使用对数刻度时对数的基数。 | |
| majorTickMark | 指定指定轴的主要刻度线的类型。 | |
| majorTimeUnitScale | 当 属性设置为 dateAxis时，categoryType指定类别轴的主要单位刻度值。 |
|
| minorTickMark | 指定指定轴的次要刻度线的类型。 | |
| minorTimeUnitScale | 当 属性设置为 dateAxis时categoryType，指定类别轴的次要单位刻度值。 |
|
| reversePlotOrder | 指定 Excel 是否从最后一个到第一个绘制数据点。 | |
| scaleType | 指定数值轴刻度类型。 | |
| setCategoryNames (sourceData： Range) | 设置指定轴的所有分类名称。 | |
| setCustomDisplayUnit (值：number) | 将轴显示单位设为自定义值。 | |
| showDisplayUnitLabel | 指定轴显示单位标签是否可见。 | |
| tickLabelPosition | 在指定坐标轴上指定刻度线标签的位置。 | |
| tickLabelSpacing | 指定刻度线标签之间的类别或系列数。 | |
| tickMarkSpacing | 指定刻度线之间的类别或系列数。 | |
| top | 指定从轴的上边缘到图表区顶部的距离（以磅为单位）。 | |
| type | 指定坐标轴类型。 | |
| visible | 指定轴是否可见。 | |
| width | 指定图表轴的宽度（以磅为单位）。 | |
| ChartBorder | color | 表示图表中的边框颜色的 HTML 颜色代码。 |
| lineStyle | 表示边框的线条样式。 | |
| weight | 表示边框的粗细，以磅为单位。 | |
| ChartDataLabel | position | 表示数据标签位置的值。 |
| 分隔符 | 该字符串表示用于图表中数据标签的分隔符。 | |
| showBubbleSize | 指定数据标签气泡大小是否可见。 | |
| showCategoryName | 指定数据标签类别名称是否可见。 | |
| showLegendKey | 指定数据标签图例键是否可见。 | |
| showPercentage | 指定数据标签百分比是否可见。 | |
| showSeriesName | 指定数据标签系列名称是否可见。 | |
| showValue | 指定数据标签值是否可见。 | |
| ChartFormatString | font | 表示字体属性，例如图表字符对象的字体名称、字号和颜色。 |
| ChartLegend | height | 指定图表上图例的高度（以磅为单位）。 |
| left | 指定图表上图例的左值（以磅为单位）。 | |
| legendEntries | 表示图例中 legendEntries 的集合。 | |
| showShadow | 指定图例在图表上是否有阴影。 | |
| top | 指定图表图例的顶部。 | |
| width | 指定图表上图例的宽度（以磅为单位）。 | |
| ChartLegendEntry | visible | 表示图表图例条目的可见性。 |
| ChartLegendEntryCollection | getCount() | 返回集合中的图例条目数。 |
| getItemAt(index: number) | 返回给定索引处的图例条目。 | |
| items | 获取此集合中已加载的子项。 | |
| ChartLineFormat | lineStyle | 表示线条样式。 |
| weight | 表示线条的粗细（以磅为单位）。 | |
| ChartPoint | dataLabel | 返回图表点的数据标签。 |
| hasDataLabel | 表示数据点是否具有数据标签。 | |
| markerBackgroundColor | 数据点标记背景色的 HTML 颜色代码表示形式 (例如，#FF0000 表示红色) 。 | |
| markerForegroundColor | 数据点标记前景色的 HTML 颜色代码表示形式 (例如，#FF0000 表示红色) 。 | |
| markerSize | 表示数据点的标记大小。 | |
| markerStyle | 表示图表数据点的标记样式。 | |
| ChartPointFormat | 边境 | 表示图表数据点的边框格式，其中包括颜色、样式和权重信息。 |
| ChartSeries | chartType | 表示系列的图表类型。 |
| delete() | 删除 chart series 对象。 | |
| doughnutHoleSize | 表示图表系列的圆环孔大小。 | |
| 过滤 | 指定是否筛选序列。 | |
| gapWidth | 表示图表系列的间隙宽度。 | |
| hasDataLabels | 指定序列是否具有数据标签。 | |
| markerBackgroundColor | 指定图表系列的标记背景色。 | |
| markerForegroundColor | 指定图表系列的标记前景色。 | |
| markerSize | 指定图表系列的标记大小。 | |
| markerStyle | 指定图表系列的标记样式。 | |
| plotOrder | 指定图表组中图表系列的绘图顺序。 | |
| setBubbleSizes (sourceData： Range) | 设置图表系列的气泡大小。 | |
| setValues (sourceData： Range) | 设置图表系列的值。 | |
| setXAxisValues (sourceData： Range) | 设置图表系列的 x 轴值。 | |
| showShadow | 指定序列是否具有阴影。 | |
| 光滑 | 指定序列是否平滑。 | |
| 趋势线 | 系列中趋势线的集合。 | |
| ChartSeriesCollection | add (name？： string， index？： number) | 向集合添加新系列。 |
| ChartTitle | getSubstring (start： number， length： number) | 获取图表标题的子字符串。 |
| height | 返回图表标题的高度，以磅为单位。 | |
| horizontalAlignment | 指定图表标题的水平对齐方式。 | |
| left | 指定从图表标题的左边缘到图表区左边缘的距离（以磅为单位）。 | |
| position | 表示图表标题的位置。 | |
| setFormula (公式：字符串) | 设置一个字符串值，用于表示采用 A1 表示法的图表标题的公式。 | |
| showShadow | 表示一个布尔值，用于确定图表标题是否具有阴影。 | |
| textOrientation | 为图表标题指定文本的方向。 | |
| top | 指定从图表标题的上边缘到图表区顶部的距离（以磅为单位）。 | |
| verticalAlignment | 指定图表标题的垂直对齐方式。 | |
| width | 指定图表标题的宽度（以磅为单位）。 | |
| ChartTitleFormat | 边境 | 表示图表标题的边框格式，包括颜色、线条样式和粗细。 |
| ChartTrendline | delete() | 删除 Trendline 对象。 |
| format | 表示图表趋势线的格式。 | |
| 拦截 | 表示趋势线的截距值。 | |
| movingAveragePeriod | 表示图表趋势线的周期。 | |
| 名称 | 表示趋势线的名称。 | |
| polynomialOrder | 表示图表趋势线的顺序。 | |
| type | 表示图表趋势线的类型。 | |
| ChartTrendlineCollection | 添加 (类型？： Excel.ChartTrendlineType) | 向趋势线集合添加新的趋势线。 |
| getCount() | 返回集合中的趋势线数量。 | |
| getItem(index: number) | 按索引获取趋势线对象，这是 items 数组中的插入顺序。 | |
| items | 获取此集合中已加载的子项。 | |
| ChartTrendlineFormat | line | 表示图表线条格式。 |
| CustomProperty | delete() | 删除 custom property 对象。 |
| key | 自定义属性的键。 | |
| type | 用于自定义属性的值的类型。 | |
| value | 自定义属性的值。 | |
| CustomPropertyCollection | add (key： string， value： any) | 新建自定义属性或设置现有自定义属性。 |
| deleteAll () | 删除此集合中的所有自定义属性。 | |
| getCount() | 获取自定义属性的计数。 | |
| getItem(key: string) | 按键获取自定义属性对象（不区分大小写）。 | |
| getItemOrNullObject(key: string) | 按键获取自定义属性对象（不区分大小写）。 | |
| items | 获取此集合中已加载的子项。 | |
| DataConnectionCollection | refreshAll () | 刷新集合中的数据连接，例如从数据透视表到 Power BI 数据集，或者从数据模型到同一工作簿中的表或区域。 |
| DocumentProperties | 作者 | 工作簿的作者。 |
| 类别 | 工作簿的类别。 | |
| comments | 工作簿元数据中的“注释”字段。 | |
| company | 工作簿的公司。 | |
| creationDate | 获取工作簿的创建日期。 | |
| 习惯 | 获取工作簿的自定义属性的集合。 | |
| 关键字 | 工作簿的关键字。 | |
| lastAuthor | 获取工作簿的最终作者。 | |
| 经理 | 工作簿的经理。 | |
| revisionNumber | 获取工作簿的修订号。 | |
| subject | 工作簿的主题。 | |
| title | 工作簿的标题。 | |
| NamedItem | arrayValues | 返回包含已命名项目的值和类型的对象。 |
| formula | 命名项的公式。 | |
| NamedItemArrayValues | types | 表示命名项数组中每个项的类型 |
| values | 表示已命名项目数组中每个项目的值。 | |
| 区域 | getAbsoluteResizedRange (numRows： number， numColumns： number) | 获取一个 Range 对象，该对象具有与当前 Range 对象相同的左上角单元格，但具有指定的行数和列数。 |
| getImage () | 将范围呈现为 Base64 编码的 PNG 图像。 | |
| getSurroundingRegion () | 返回一个 Range 对象，该对象代表此区域中左上角单元格的周围区域。 |
|
| hyperlink | 表示当前范围的超链接。 | |
| isEntireColumn | 表示当前区域是否为整列。 | |
| isEntireRow | 表示当前区域是否为整行。 | |
| numberFormatLocal | 表示基于用户语言设置的给定区域的 Excel 数字格式代码。 | |
| showCard () | 显示活动单元格的卡片（如果该单元格具有富值内容）。 | |
| style | 表示当前区域的样式。 | |
| RangeFormat | textOrientation | 区域中所有单元格的文本方向。 |
| useStandardHeight | 确定对象的行高 Range 是否等于工作表的标准高度。 |
|
| useStandardWidth | 指定 对象的列宽 Range 是否等于工作表的标准宽度。 |
|
| RangeHyperlink | address | 表示超链接的 URL 目标。 |
| documentReference | 表示超链接的文档引用目标。 | |
| screenTip | 表示鼠标悬停在超链接上时显示的字符串。 | |
| textToDisplay | 表示区域最左上方单元格中显示的字符串。 | |
| 样式 | Borders | 表示四个边框样式的四个边框对象的集合。 |
| 内置 | 指定样式是否为内置样式。 | |
| delete() | 删除此样式。 | |
| fill | 样式的填充。 | |
| font | 一个 Font 对象，表示样式的字体。 |
|
| formulaHidden | 指定在工作表受保护时是否隐藏公式。 | |
| horizontalAlignment | 表示样式水平对齐。 | |
| includeAlignment | 指定样式是否包括自动缩进、水平对齐、垂直对齐、换行文本、缩进级别和文本方向属性。 | |
| includeBorder | 指定样式是否包括颜色、颜色索引、线条样式和粗细边框属性。 | |
| includeFont | 指定样式是否包括背景、粗体、颜色、颜色索引、字体样式、斜体、名称、大小、删除线、下标、上标和下划线字体属性。 | |
| includeNumber | 指定样式是否包含数字格式属性。 | |
| includePatterns | 指定样式是否包括颜色、颜色索引、反转为负、图案、图案颜色和图案颜色索引内部属性。 | |
| includeProtection | 指定样式是否包括隐藏和锁定保护属性的公式。 | |
| indentLevel | 0 到 250 之间的一个整数，指示样式的缩进水平。 | |
| locked | 指定在工作表受保护时对象是否锁定。 | |
| 名称 | 样式的名称。 | |
| numberFormat | 样式中数字格式的格式代码。 | |
| numberFormatLocal | 样式中数字格式的本地化格式代码。 | |
| readingOrder | 样式中的阅读顺序。 | |
| shrinkToFit | 指定文本是否自动收缩以适应可用的列宽。 | |
| verticalAlignment | 指定样式的垂直对齐方式。 | |
| wrapText | 指定 Excel 是否包装对象中的文本。 | |
| StyleCollection | add(name: string) | 向集合添加新样式。 |
| getItem(name: string) |
Style按名称获取 。 |
|
| items | 获取此集合中已加载的子项。 | |
| Table | onChanged | 当单元格中的数据在特定表上发生更改时发生。 |
| onSelectionChanged | 在特定表上更改所选内容时发生。 | |
| TableChangedEventArgs | address | 获取地址，该地址表示特定工作表上的表格的更改区域。 |
| changeType | 获取表示更改事件的触发方式的更改类型。 | |
| source | 获取事件源。 | |
| tableId | 获取数据更改的表的 ID。 | |
| type | 获取事件的类型。 | |
| worksheetId | 获取数据更改的工作表的 ID。 | |
| TableCollection | onChanged | 在工作簿或工作表中的任何表上发生数据更改时发生。 |
| TableSelectionChangedEventArgs | address | 获取区域地址，该地址表示特定工作表上的表格选定区域。 |
| isInsideTable | 指定所选内容是否位于表中。 | |
| tableId | 获取更改所选内容的表的 ID。 | |
| type | 获取事件的类型。 | |
| worksheetId | 获取选定内容已更改的工作表的 ID。 | |
| Workbook | dataConnections | 表示工作簿中的所有数据连接。 |
| getActiveCell () | 获取工作簿中当前处于活动状态的单元格。 | |
| 名称 | 获取工作簿名称。 | |
| properties | 获取工作簿属性。 | |
| protection | 返回工作簿的保护对象。 | |
| 风格 | 表示与工作簿关联的样式的集合。 | |
| WorkbookProtection | 保护 (密码？：字符串) | 保护工作簿。 |
| 保护 | 指定工作簿是否受保护。 | |
| 取消保护 (密码？： 字符串) | 取消保护工作簿。 | |
| Worksheet | copy (positionType？： Excel.WorksheetPositionType， relativeTo？： Excel.Worksheet) | 复制工作表并将其放置在指定位置。 |
| freezePanes | 获取一个对象，该对象可用于操作工作表上的冻结窗格。 | |
| getRangeByIndexes (startRow： number， startColumn： number， rowCount： number， columnCount： number) | 获取对象， Range 从特定的行索引和列索引开始，并跨越一定数量的行和列。 |
|
| onActivated | 激活工作表时发生。 | |
| onChanged | 在特定工作表中的数据更改时发生。 | |
| onDeactivated | 在停用工作表时发生。 | |
| onSelectionChanged | 在特定工作表上更改所选内容时发生。 | |
| standardHeight | 返回工作表中所有行的标准（默认）行高，以磅为单位。 | |
| standardWidth | 指定工作表中所有列的标准 (默认) 宽度。 | |
| tabColor | 工作表的选项卡颜色。 | |
| WorksheetActivatedEventArgs | type | 获取事件的类型。 |
| worksheetId | 获取激活的工作表的 ID。 | |
| WorksheetAddedEventArgs | source | 获取事件源。 |
| type | 获取事件的类型。 | |
| worksheetId | 获取添加到工作簿的工作表的 ID。 | |
| WorksheetChangedEventArgs | address | 获取区域地址，该地址表示特定工作表上的更改区域。 |
| changeType | 获取表示更改事件的触发方式的更改类型。 | |
| source | 获取事件源。 | |
| type | 获取事件的类型。 | |
| worksheetId | 获取数据更改的工作表的 ID。 | |
| WorksheetCollection | onActivated | 激活工作簿中的任何工作表时发生。 |
| onAdded | 在将新工作表添加到工作簿时发生。 | |
| onDeactivated | 在停用工作簿中的任何工作表时发生。 | |
| onDeleted | 从工作簿中删除工作表时发生。 | |
| WorksheetDeactivatedEventArgs | type | 获取事件的类型。 |
| worksheetId | 获取已停用的工作表的 ID。 | |
| WorksheetDeletedEventArgs | source | 获取事件源。 |
| type | 获取事件的类型。 | |
| worksheetId | 获取从工作簿中删除的工作表的 ID。 | |
| WorksheetFreezePanes | freezeAt (frozenRange： Range |字符串) | 设置活动工作表视图中的冻结单元格。 |
| freezeColumns (count？： number) | 将工作表的第一列或多列冻结到位。 | |
| freezeRows (count？： number) | 将工作表的上一行或多行冻结到位。 | |
| getLocation() | 获取用于描述活动工作表视图中的冻结单元格的区域。 | |
| getLocationOrNullObject () | 获取用于描述活动工作表视图中的冻结单元格的区域。 | |
| 取消冻结 () | 移除工作表中的所有冻结窗格。 | |
| WorksheetProtection | 取消保护 (密码？： 字符串) | 解除对 worksheet 的保护。 |
| WorksheetProtectionOptions | allowEditObjects | 表示允许编辑对象的工作表保护选项。 |
| allowEditScenarios | 表示允许编辑方案的工作表保护选项。 | |
| selectionMode | 表示选择模式的工作表保护选项。 | |
| WorksheetSelectionChangedEventArgs | address | 获取区域地址，该地址表示特定工作表上的选定区域。 |
| type | 获取事件的类型。 | |
| worksheetId | 获取选定内容已更改的工作表的 ID。 |