Excel JavaScript API 要求集 1.1
Excel JavaScript API 1.1 是首版 API。 这是Excel 2016支持的唯一特定于 Excel 的要求集。
API 列表
下表列出了 Excel JavaScript API 要求集 1.1 中的 API。 若要查看 Excel JavaScript API 要求集 1.1 支持的所有 API 的 API 参考文档，请参阅 要求集 1.1 中的 Excel API。
| 类 | 域 | 说明 |
|---|---|---|
| Application | calculate (calculationType：Excel.CalculationType) | 重新计算 Excel 中当前打开的所有工作簿。 |
| calculationMode | 返回工作簿中使用的计算模式，由 中的 Excel.CalculationMode常量定义。 |
|
| Binding | getRange() | 返回绑定表示的区域。 |
| getTable() | 返回绑定表示的表。 | |
| getText() | 返回绑定表示的文本。 | |
| id | 表示绑定标识符。 | |
| type | 返回绑定的类型。 | |
| BindingCollection | count | 返回集合中绑定的数量。 |
| getItem(id: string) | 按 ID 获取绑定对象。 | |
| getItemAt(index: number) | 根据其在项目数组中的位置获取绑定对象。 | |
| items | 获取此集合中已加载的子项。 | |
| Chart | axes | 表示图表坐标轴。 |
| dataLabels | 表示图表上的数据标签。 | |
| delete() | 删除 chart 对象。 | |
| format | 封装图表区域的格式属性。 | |
| height | 指定图表对象的高度（以磅为单位）。 | |
| left | 从图表左侧到工作表原点的距离，以磅为单位。 | |
| 传说 | 表示图表的图例。 | |
| 名称 | 指定图表对象的名称。 | |
| series | 表示单个系列或图表中的系列集合。 | |
| setData (sourceData： Range， seriesBy？： Excel.ChartSeriesBy) | 重置图表的源数据。 | |
| setPosition (startCell： Range |string， endCell？： Range |字符串) | 相对于工作表上的单元格放置图表。 | |
| title | 表示指定图表的标题，包括标题的文本、可见性、位置和格式。 | |
| top | 指定从工作表) 或图表 () 上 (的图表区顶部到第 1 行的上边缘到第 1 行顶部的距离（以磅为单位）。 | |
| width | 指定图表对象的宽度（以磅为单位）。 | |
| ChartAreaFormat | fill | 表示对象的填充格式，包括背景格式信息。 |
| font | 表示当前对象的字体属性（字体名称、字体大小、颜色等）。 | |
| ChartAxes | categoryAxis | 表示图表中的类别轴。 |
| seriesAxis | 表示三维图表的系列轴。 | |
| valueAxis | 表示坐标轴中的数值轴。 | |
| ChartAxis | format | 表示 chart 对象的格式，包括线条和字体格式。 |
| majorGridlines | 返回一个 对象，该对象代表指定轴的主要网格线。 | |
| majorUnit | 表示两个主要刻度标记之间的间隔。 | |
| maximum | 表示数值轴上的最大值。 | |
| minimum | 表示数值轴上的最小值。 | |
| minorGridlines | 返回一个 对象，该对象代表指定轴的次要网格线。 | |
| minorUnit | 表示两个次要刻度标记之间的间隔。 | |
| title | 表示坐标轴标题。 | |
| ChartAxisFormat | font | 指定图表轴元素的字体属性 (字体名称、字号、颜色等 ) 。 |
| line | 指定图表折线格式。 | |
| ChartAxisTitle | format | 指定图表轴标题的格式。 |
| text | 指定轴标题。 | |
| visible | 指定轴标题是否可见。 | |
| ChartAxisTitleFormat | font | 指定图表轴标题对象的字体属性，例如字体名称、字号或颜色。 |
| ChartCollection | add (type： Excel.ChartType， sourceData： Range， seriesBy？： Excel.ChartSeriesBy) | 创建新图表。 |
| count | 返回工作表中的图表数。 | |
| getItem(name: string) | 使用图表名称获取图表。 | |
| getItemAt(index: number) | 根据其在集合中的位置获取图表。 | |
| items | 获取此集合中已加载的子项。 | |
| ChartDataLabelFormat | fill | 表示当前图表数据标签的填充格式。 |
| font | 表示 (字体属性，例如图表数据标签的字体名称、字号和颜色) 。 | |
| ChartDataLabels | format | 指定图表数据标签的格式，其中包括填充和字体格式。 |
| position | 表示数据标签位置的值。 | |
| 分离 | 表示用于图表中数据标签的分隔符的字符串。 | |
| showBubbleSize | 指定数据标签气泡大小是否可见。 | |
| showCategoryName | 指定数据标签类别名称是否可见。 | |
| showLegendKey | 指定数据标签图例键是否可见。 | |
| showPercentage | 指定数据标签百分比是否可见。 | |
| showSeriesName | 指定数据标签系列名称是否可见。 | |
| showValue | 指定数据标签值是否可见。 | |
| ChartFill | clear() | 清除图表元素的填充颜色。 |
| setSolidColor(color: string) | 将图表元素的填充格式设置为统一颜色。 | |
| ChartFont | bold | 表示字体的加粗状态。 |
| color | 文本颜色 (的 HTML 颜色代码表示形式，例如，#FF0000 表示红色) 。 | |
| italic | 表示字体的斜体状态。 | |
| 名称 | 字体名称 (例如“Calibri”) | |
| size | 字体大小 (，例如 11) | |
| underline | 应用于字体的下划线类型。 | |
| ChartGridlines | format | 表示图表网格线的格式。 |
| visible | 指定轴网格线是否可见。 | |
| ChartGridlinesFormat | line | 表示图表线条格式。 |
| ChartLegend | format | 表示图表图例的格式，包括填充和字体格式。 |
| 重叠 | 指定图表图例是否应与图表的main正文重叠。 | |
| position | 指定图例在图表上的位置。 | |
| visible | 指定图表图例是否可见。 | |
| ChartLegendFormat | fill | 表示对象的填充格式，包括背景格式信息。 |
| font | 表示字体属性，例如图表图例的字体名称、字号和颜色。 | |
| ChartLineFormat | clear() | 清除图表元素的线条格式。 |
| color | 表示图表中的线条颜色的 HTML 颜色代码。 | |
| ChartPoint | format | 封装图表点的格式属性。 |
| value | 返回图表点的值。 | |
| ChartPointFormat | fill | 表示图表的填充格式，其中包括背景格式信息。 |
| ChartPointsCollection | count | 返回系列中的图表点数。 |
| getItemAt(index: number) | 根据其在系列中的位置检索点。 | |
| items | 获取此集合中已加载的子项。 | |
| ChartSeries | format | 表示图表系列的格式，包括填充和线条格式。 |
| 名称 | 指定图表中序列的名称。 | |
| 点 | 返回序列中所有点的集合。 | |
| ChartSeriesCollection | count | 返回集合中的系列数量。 |
| getItemAt(index: number) | 根据其在集合中的位置检索系列 | |
| items | 获取此集合中已加载的子项。 | |
| ChartSeriesFormat | fill | 表示图表系列的填充格式，包括背景格式信息。 |
| line | 表示线条格式。 | |
| ChartTitle | format | 表示图表标题的格式，包括填充和字体格式。 |
| 重叠 | 指定图表标题是否将覆盖图表。 | |
| text | 指定图表的标题文本。 | |
| visible | 指定图表标题是否可见。 | |
| ChartTitleFormat | fill | 表示对象的填充格式，包括背景格式信息。 |
| font | 表示对象的字体属性 (，例如字体名称、字号和颜色) 。 | |
| NamedItem | getRange() | 返回与名称相关的 range 对象。 |
| 名称 | 对象的名称。 | |
| type | 指定名称公式返回的值的类型。 | |
| value | 表示 name 公式计算出的值。 | |
| visible | 指定对象是否可见。 | |
| NamedItemCollection | getItem(name: string) |
NamedItem使用其名称获取对象。 |
| items | 获取此集合中已加载的子项。 | |
| 区域 | address | 指定 A1 样式中的区域引用。 |
| addressLocal | 表示用户语言中指定范围的范围引用。 | |
| cellCount | 指定区域中的单元格数。 | |
| clear(applyTo?: Excel.ClearApplyTo) | 清除区域值、格式、填充、边框等。 | |
| columnCount | 指定区域中的列总数。 | |
| columnIndex | 指定区域中第一个单元格的列号。 | |
| 删除 (shift：Excel.DeleteShiftDirection) | 删除与区域相关的单元格。 | |
| format | 返回一个格式对象，其中封装了区域的字体、填充、边框、对齐方式和其他属性。 | |
| formulas | 表示采用 A1 表示法的公式。 | |
| formulasLocal | 表示采用 A1 样式表示法的公式，使用用户的语言和数字格式区域设置。 | |
| getBoundingRect (anotherRange： Range |字符串) | 获取包含指定区域的最小 range 对象。 | |
| getCell(row: number, column: number) | 根据行和列编号获取包含单个单元格的 range 对象。 | |
| getColumn(column: number) | 获取范围中包含的列。 | |
| getEntireColumn() | 获取一个 对象，该对象表示区域 (的整个列，例如，如果当前区域表示单元格“B4：E11”，则它是 getEntireColumn 表示列“B：E”) 的区域。 |
|
| getEntireRow() | 获取一个对象，该对象表示区域 (的整行，例如，如果当前区域表示单元格“B4：E11”，则它是 GetEntireRow 表示行“4：11”) 的区域。 |
|
| getIntersection (anotherRange： Range |字符串) | 获取表示指定区域的矩形交集的 range 对象。 | |
| getLastCell () | 获取区域内的最后一个单元格。 | |
| getLastColumn () | 获取区域内的最后一列。 | |
| getLastRow () | 获取区域内的最后一行。 | |
| getOffsetRange(rowOffset: number, columnOffset: number) | 获取表示与指定区域偏移的区域的对象。 | |
| getRow(row: number) | 获取范围中包含的行。 | |
| insert (shift：Excel.InsertShiftDirection) | 将单个单元格或一系列单元格插入到工作表中取代此区域，并移动其他单元格以留出空间。 | |
| numberFormat | 表示给定区域的 Excel 数字格式代码。 | |
| rowCount | 返回区域中的总行数。 | |
| rowIndex | 返回区域中第一个单元格的行编号。 | |
| select() | 在 Excel UI 中选择指定的区域。 | |
| text | 指定区域的文本值。 | |
| valueTypes | 指定每个单元格中的数据类型。 | |
| values | 表示指定区域的原始值。 | |
| worksheet | 包含当前区域的工作表。 | |
| RangeBorder | color | 表示边框线颜色的 HTML 颜色代码，形式 #RRGGBB (例如“FFA500”) ，或作为命名的 HTML 颜色 (例如“橙色”) 。 |
| sideIndex | 指示边框的特定边的常量值。 | |
| style | 线条样式的常量之一，指定边框的线条样式。 | |
| weight | 指定区域周围的边框的粗细。 | |
| RangeBorderCollection | count | 集合中的 border 对象数量。 |
| getItem (索引：Excel.BorderIndex) | 使用其名称获取 border 对象 | |
| getItemAt(index: number) | 使用其索引获取 border 对象 | |
| items | 获取此集合中已加载的子项。 | |
| RangeFill | clear() | 重置区域背景。 |
| color | 表示背景颜色的 HTML 颜色代码，格式 #RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (，例如“orange”) | |
| RangeFont | bold | 表示字体的粗体状态。 |
| color | 文本颜色 (的 HTML 颜色代码表示形式，例如，#FF0000 表示红色) 。 | |
| italic | 指定字体的斜体状态。 | |
| 名称 | 字体名称 (，例如“Calibri”) 。 | |
| size | 字号 | |
| underline | 应用于字体的下划线类型。 | |
| RangeFormat | Borders | 应用于整个区域的 Border 对象的集合。 |
| fill | 返回在整个区域内定义的 fill 对象。 | |
| font | 返回在整个区域内定义的 Font 对象。 | |
| horizontalAlignment | 表示指定对象的水平对齐方式。 | |
| verticalAlignment | 表示指定对象的垂直对齐方式。 | |
| wrapText | 指定 Excel 是否包装对象中的文本。 | |
| Table | 列 | 表示表中所有列的集合。 |
| delete() | 删除表。 | |
| getDataBodyRange () | 获取与表的数据体相关的 range 对象。 | |
| getHeaderRowRange () | 获取与表的标题行相关的 range 对象。 | |
| getRange() | 获取与整个表相关的 range 对象。 | |
| getTotalRowRange () | 获取与表的总计行相关的 range 对象。 | |
| id | 返回用于唯一标识指定工作簿中表的值。 | |
| 名称 | 表的名称。 | |
| rows | 表示表中所有行的集合。 | |
| showHeaders | 指定标题行是否可见。 | |
| showTotals | 指定总行是否可见。 | |
| style | 表示表格样式的常量值。 | |
| TableCollection | 添加 (地址：范围 |string，hasHeaders：布尔) | 创建一个新表。 |
| count | 返回工作簿中的表数目。 | |
| getItem(key: string) | 按名称或 ID 获取表。 | |
| getItemAt(index: number) | 根据其在集合中的位置获取表。 | |
| items | 获取此集合中已加载的子项。 | |
| TableColumn | delete() | 从表中删除列。 |
| getDataBodyRange () | 获取与列的数据体相关的 range 对象。 | |
| getHeaderRowRange () | 获取与列的标头行相关的 range 对象。 | |
| getRange() | 获取与整个列相关的 range 对象。 | |
| getTotalRowRange () | 获取与列的总计行相关的 range 对象。 | |
| id | 返回标识表内的列的唯一键。 | |
| index | 返回表的列集合内列的索引编号。 | |
| 名称 | 指定表列的名称。 | |
| values | 表示指定区域的原始值。 | |
| TableColumnCollection | add (index？： number， values？： Array<Array<boolean | string | number>> | boolean | string | number， name？： string) | 向表中添加新列。 |
| count | 返回表中的列数。 | |
| getItem (键： number |字符串) | 按名称或 ID 获取 column 对象。 | |
| getItemAt(index: number) | 根据其在集合中的位置获取列。 | |
| items | 获取此集合中已加载的子项。 | |
| TableRow | delete() | 从表中删除行。 |
| getRange() | 返回与整个行相关的 range 对象。 | |
| index | 返回表的行集合内行的索引编号。 | |
| values | 表示指定区域的原始值。 | |
| TableRowCollection | add (index？： number， values？： Array<Array<boolean | string | number>> | boolean | string | number， alwaysInsert？： boolean) | 向表中添加一行或多行。 |
| count | 返回表中的行数。 | |
| getItemAt(index: number) | 根据其在集合中的位置获取行。 | |
| items | 获取此集合中已加载的子项。 | |
| Workbook | application | 表示包含此工作簿的 Excel 应用程序实例。 |
| bindings | 表示属于工作簿的绑定的集合。 | |
| getSelectedRange () | 从工作簿中获取当前选定的单个区域。 | |
| 名字 | 表示工作簿范围的命名项的集合， () 命名区域和常量。 | |
| 表 | 表示与工作簿关联的表的集合。 | |
| 工作表 | 表示与工作簿关联的工作表的集合。 | |
| Worksheet | activate() | 在 Excel UI 中激活工作表。 |
| 图表 | 返回属于工作表的图表集合。 | |
| delete() | 从工作簿中删除工作表。 | |
| getCell(row: number, column: number) |
Range获取包含基于行号和列号的单个单元格的对象。 |
|
| getRange (address？： string) |
Range获取 对象，该对象表示由地址或名称指定的单个矩形单元格块。 |
|
| id | 返回用于唯一标识指定工作簿中工作表的值。 | |
| 名称 | 工作表的显示名称。 | |
| position | 工作表在工作簿中的位置，从零开始。 | |
| 表 | 属于工作表的表的集合。 | |
| 知名度 | 工作表的可见性。 | |
| WorksheetCollection | 添加 (名称？： 字符串) | 向工作簿添加新工作表。 |
| getActiveWorksheet () | 获取工作簿中当前处于活动状态的工作表。 | |
| getItem(key: string) | 使用其名称或 ID 获取 worksheet 对象。 | |
| items | 获取此集合中已加载的子项。 |