ExcelApi 1.19 添加了图表和形状的功能,可帮助你更好地在 Excel 中可视化数据。 它还包括对数据类型功能的更新,例如支持 链接数据类型、 点表示法和 基本单元格值的扩展选项。
下表提供了 API 的简明摘要,而后续 的 API 列表 表提供了详细的列表。
| 功能区域 | 说明 | 相关对象 |
|---|---|---|
| 图表标签 | 控制图表标签的外观。 | ChartDataLabel、 ChartDataLabelAnchor、 ChartLeaderLines、 ChartLeaderLinesFormat |
| 已链接实体 | 添加了对从外部源连接到 Excel 的数据类型的支持。 若要了解详细信息,请参阅 创建链接实体单元格值 | LinkedEntityDataDomain、 LinkedEntityDataDomainCollection、 LinkedEntityDataDomainCreateOptions、 LinkedEntityIdCulture、 LinkedEntityLoadServiceRequest |
API 列表
下表列出了 Excel JavaScript API 要求集 1.19 中的 API。 若要查看 Excel JavaScript API 要求集 1.19 或更低版本支持的所有 API 的 API 参考文档,请参阅 要求集 1.19 或更低版本中的 Excel API。
| 类 | 域 | 说明 |
|---|---|---|
| BasicCardLayout | 布局 | 表示此布局的类型。 |
| BasicCompactLayout | icon | 指定用于打开卡的图标的名称。 |
| BasicViewLayouts | 卡 | 表示此值及其属性在卡视图中的布局。 |
| 紧凑的 | 表示表示值的空间有限时使用的布局。 | |
| BooleanCellValue | 布局 | 表示此布尔值的视图的布局信息。 |
| properties | 表示此布尔值的其他属性。 | |
| 供应商 | 表示描述在此 BooleanCellValue中提供数据的服务的信息。 |
|
| referencedValues | 表示 在 中 BooleanCellValue.properties引用的单元格值。 |
|
| CardLayoutTwoColumnSection | 布局 | 表示此部分的布局类型。 |
| ChartDataLabel | geometricShapeType | 指定数据标签的几何形状类型。 |
| getSubstring(start: number, length?: number) | 返回数据标签的子字符串。 | |
| getTailAnchor () | 返回数据标签的尾定位点,该标签显示为粘滞标注。 | |
| setHeight (height: number) | 设置数据标签的高度(以磅为单位)。 | |
| setWidth (宽度:数字) | 设置数据标签的宽度(以磅为单位)。 | |
| showAsStickyCallout | 指定数据标签是否显示为标注,并将尾定位点附加到数据点。 | |
| ChartDataLabelAnchor | left | 指定从定位点到图表数据标签左边缘的距离(以磅为单位)。 |
| top | 指定从定位点到图表数据标签上边缘的距离(以磅为单位)。 | |
| ChartDataLabels | geometricShapeType | 指定数据标签的几何形状类型。 |
| leaderLines | 获取一个 对象,该对象表示数据标签的前导线。 | |
| showAsStickyCallout | 指定数据标签是否显示为带有尾锚附加到数据点的标注。 | |
| showLeaderLines | 指定是否为数据标签显示引线。 | |
| ChartLeaderLines | format | 表示序列中数据标签的引线的格式设置。 |
| ChartLeaderLinesFormat | line | 获取一个 对象,该对象表示图表前导线的折线格式。 |
| DoubleCellValue | 布局 | 表示此双精度值的视图的布局信息。 |
| numberFormat | 返回用于显示此值的数字格式字符串。 | |
| properties | 表示此双精度值的其他属性。 | |
| 供应商 | 表示描述在此 DoubleCellValue中提供数据的服务的信息。 |
|
| referencedValues | 表示 在 中 DoubleCellValue.properties引用的单元格值。 |
|
| FormattedNumberCellValue | basicType | 表示将为具有此值的单元格返回 Range.valueTypes 的值。 |
| basicValue | 表示将为具有此值的单元格返回 Range.values 的值。 |
|
| numberFormat | 返回用于显示此值的数字格式字符串。 | |
| type | 表示此单元格值的类型。 | |
| JavaScriptCustomFunctionReferenceCellValue | basicType | 表示将为具有此值的单元格返回 Range.valueTypes 的值。 |
| basicValue | 表示将为具有此值的单元格返回 Range.values 的值。 |
|
| functionType | 表示 的类型 FunctionCellValue。 |
|
| id | 表示自定义函数的 ID。 | |
| Namespace | 表示自定义函数使用的命名空间。 | |
| type | 表示此单元格值的类型。 | |
| LinkedEntityDataDomain | dataProvider | 获取链接实体数据域的数据提供程序的名称。 |
| delete() | 从 LinkedEntityDataDomainCollection中删除此对象。 |
|
| id | 获取 Office 外接程序定义的链接实体数据域的 ID。 | |
| lastRefreshed | 获取自工作簿打开 LinkedEntityCellValue 且上次刷新此链接实体数据域的对象以来本地时区) 的 (日期和时间。 |
|
| loadFunctionId | 获取按需调用的自定义函数的 ID,该函数用于解析或刷新 LinkedEntityCellValue Office 外接程序定义的链接实体数据域的对象。 |
|
| 名称 | 获取链接实体数据域的名称。 | |
| periodicRefreshInterval | 获取自动刷新此链接实体数据域对象的频率(以 LinkedEntityCellValue 秒为单位)。 |
|
| refresh() | 刷新此链接实体数据域的所有 LinkedEntityCellValue 对象。 |
|
| refreshMode | 指定刷新模式,该模式定义如何以及何时 LinkedEntityCellValue 刷新此链接实体数据域的对象。 |
|
| 服务 Id | 获取链接实体数据域的服务 ID。 | |
| supportedRefreshModes | 获取链接实体数据域支持的所有刷新模式。 | |
| LinkedEntityDataDomainAddedEventArgs | id | 获取刚刚添加到工作簿的链接实体数据域的 ID。 |
| 服务 Id | 获取刚刚添加到工作簿的链接实体数据域的服务 ID。 | |
| source | 获取事件源。 | |
| type | 获取事件的类型。 | |
| LinkedEntityDataDomainCollection | 添加 (选项:Excel.LinkedEntityDataDomainCreateOptions) | 将 Office 外接程序定义的链接实体数据域对象添加到集合。 |
| getCount() | 获取集合中链接实体数据域的数目。 | |
| getItem(id: string) | 通过其 id获取链接实体数据域。 |
|
| getItemAt(index: number) | 按集合中的索引获取链接实体数据域。 | |
| getItemByName (name: string) | 通过其 name获取链接实体数据域。 |
|
| getItemByNameOrNullObject (name: string) | 通过其 name获取链接实体数据域。 |
|
| getItemOrNullObject(id: string) | 通过其 id获取链接实体数据域。 |
|
| items | 获取此集合中已加载的子项。 | |
| onLinkedEntityDataDomainAdded | 在将新的链接实体数据域添加到工作簿时发生。 | |
| onRefreshCompleted | 在完成对链接实体数据域的对象刷新 LinkedEntityCellValue 请求时发生。 |
|
| onRefreshModeChanged | 在链接实体数据域的 更改时 refreshMode 发生。 |
|
| refreshAll () | 刷新此集合中所有链接实体数据域的所有 LinkedEntityCellValue 对象。 |
|
| LinkedEntityDataDomainCreateOptions | dataProvider | 指定链接实体数据域的数据提供程序的名称。 |
| id | 指定链接实体数据域的 ID。 | |
| loadFunctionId | 指定自定义函数的 ID,该函数将按需调用以解析或刷新 LinkedEntityCellValue 此链接实体数据域的对象。 |
|
| 名称 | 指定链接实体数据域的名称。 | |
| periodicRefreshInterval | 指定自动刷新此链接实体数据域对象的频率(以秒 LinkedEntityCellValue 为单位)。 |
|
| supportedRefreshModes | 指定链接实体数据域支持的所有刷新模式。 | |
| LinkedEntityDataDomainRefreshCompletedEventArgs | errors | 获取在请求刷新 LinkedEntityCellValue 链接实体数据域的对象期间遇到的任何错误。 |
| id | 获取对象已刷新的链接实体数据域的 LinkedEntityCellValue ID。 |
|
| 刷新 |
true如果LinkedEntityCellValue已成功刷新链接实体数据域的对象,则返回 ;否则返回 false。 |
|
| 服务 Id | 获取对象已刷新的链接实体数据域 LinkedEntityCellValue 的服务 ID。 |
|
| source | 获取事件源。 | |
| type | 获取事件的类型。 | |
| LinkedEntityDataDomainRefreshModeChangedEventArgs | id | 获取刷新模式已更改的链接实体数据域的 ID。 |
| refreshMode | 获取链接实体数据域的新刷新模式。 | |
| 服务 Id | 获取刷新模式已更改的链接实体数据域的服务 ID。 | |
| source | 获取事件源。 | |
| type | 获取事件的类型。 | |
| LinkedEntityIdCulture | 文化 | 表示用于创建 LinkedEntityCellValue 对象的语言区域性。 |
| entityId | 表示特定于用于创建 LinkedEntityCellValue 对象的服务的标识符。 |
|
| LinkedEntityLoadServiceRequest | domainId | 表示特定于用于创建 LinkedEntityCellValue 对象的服务的域。 |
| 实体 | 表示要加载的对象的 LinkedEntityCellValue 实体 ID 和区域性。 |
|
| LinkedEntityLoadServiceResult | 实体 | 表示加载 LinkedEntityCellValue 的对象。 |
| 区域 | getDisplayedCellProperties (cellPropertiesLoadOptions: CellPropertiesLoadOptions) | 返回一个 2D 数组,该数组封装每个单元格的字体、填充、边框、对齐方式和其他属性的显示数据。 |
| StringCellValue | 布局 | 表示此字符串值的视图的布局信息。 |
| properties | 表示此字符串值的其他属性。 | |
| 供应商 | 表示描述在此 StringCellValue中提供数据的服务的信息。 |
|
| referencedValues | 表示 在 中 StringCellValue.properties引用的单元格值。 |
|
| Workbook | getActiveShape () | 获取工作簿中的活动形状。 |
| getActiveShapeOrNullObject () | 获取工作簿中的活动形状。 | |
| linkedEntityDataDomains | 返回工作簿中可用的链接实体数据域的集合。 | |
| Worksheet | showDataTypeIcons | 指定数据类型图标在工作表上是否可见。 |