Excel.LinkedEntityDataDomain class
表示具有某些共同特征或属性的特定类别或信息领域。 数据域链接到数据提供程序，该数据提供程序充当工作簿中对象的数据 LinkedEntityCellValue 源。 数据域是一类数据，例如股票、地理位置或货币。 数据提供程序是一种服务，例如必应、Power BI 或 Office 加载项。
注解
Excel Web 版不支持此类。
使用方
- Excel.LinkedEntityDataDomainCollection： getItem， getItemAt， getItemByName， getItemByNameOrNullObject， getItemOrNullObject， items
示例
// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
// Get a specific data domain by ID and refresh it.
const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
productsDomain.refresh();
await context.sync();
});
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| data |
获取链接实体数据域的数据提供程序的名称。 此名称可能会根据数据提供程序提供的信息而更改。 |
| id | 获取 Office 加载项定义的链接实体数据域的 ID。此 ID 不适用于服务提供商（如必应或 Power BI）定义的链接实体数据域。 |
| last |
获取自打开工作簿和 |
| load |
获取按需调用的自定义函数的 ID，该函数用于解析或刷新 |
| name | 获取链接的实体数据域的名称。 此名称可能会根据数据提供程序提供的信息而更改。 |
| periodic |
获取此链接实体数据域的对象自动刷新的频率（以秒 |
| refresh |
指定刷新模式，该模式定义如何以及何时 |
| service |
获取链接的实体数据域的服务 ID。 此 ID 是所有链接实体数据域的永久保留值，这些域由服务数据提供程序（如必应或 Power BI）定义，或由 Office 加载项定义。此 ID 永远不会跨用户会话更改。 |
| supported |
获取链接实体数据域支持的所有刷新模式。 此数组可以根据数据提供程序提供的信息进行更改。 |
方法
| delete() | 从 . |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| refresh() | 刷新此链接实体数据域的所有 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
dataProvider
获取链接实体数据域的数据提供程序的名称。 此名称可能会根据数据提供程序提供的信息而更改。
readonly dataProvider: string;属性值
string
注解
Excel web 版不支持此属性。
id
获取 Office 加载项定义的链接实体数据域的 ID。此 ID 不适用于服务提供商（如必应或 Power BI）定义的链接实体数据域。
readonly id: string;属性值
string
注解
Excel web 版不支持此属性。
lastRefreshed
获取自打开工作簿和 LinkedEntityCellValue 上次刷新此链接实体数据域的对象以来) 本地时区 (的日期和时间。 如果自打开工作簿以来尚未刷新对象，则LinkedEntityCellValue返回undefined。
readonly lastRefreshed: Date;属性值
Date
注解
Excel web 版不支持此属性。
loadFunctionId
获取按需调用的自定义函数的 ID，该函数用于解析或刷新 LinkedEntityCellValue 由 Office 加载项定义的链接实体数据域的对象。有关详细信息，请参阅 为自定义函数自动生成 JSON 元数据：ID。 此 ID 不适用于服务提供商（如必应或 Power BI）定义的链接实体数据域。
readonly loadFunctionId: string;属性值
string
注解
Excel web 版不支持此属性。
name
获取链接的实体数据域的名称。 此名称可能会根据数据提供程序提供的信息而更改。
readonly name: string;属性值
string
注解
Excel web 版不支持此属性。
periodicRefreshInterval
获取此链接实体数据域的对象自动刷新的频率（以秒 LinkedEntityCellValue 为单位）。 刷新间隔仅适用于设置为“定期”的情况 refreshMode 。
readonly periodicRefreshInterval: number;属性值
number
注解
Excel web 版不支持此属性。
refreshMode
指定刷新模式，该模式定义如何以及何时 LinkedEntityCellValue 刷新此链接实体数据域的对象。 如果此链接实体数据域不支持正在设置的刷新模式，则不会更改当前刷新模式。 如果刷新模式设置为“定期”，则刷新间隔设置为此链接实体数据域的刷新 periodicRefreshInterval 间隔。
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";属性值
Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"
注解
Excel web 版不支持此属性。
serviceId
获取链接的实体数据域的服务 ID。 此 ID 是所有链接实体数据域的永久保留值，这些域由服务数据提供程序（如必应或 Power BI）定义，或由 Office 加载项定义。此 ID 永远不会跨用户会话更改。
readonly serviceId: number;属性值
number
注解
Excel web 版不支持此属性。
supportedRefreshModes
获取链接实体数据域支持的所有刷新模式。 此数组可以根据数据提供程序提供的信息进行更改。
readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];属性值
注解
Excel web 版不支持此属性。
方法详细信息
delete()
从 .LinkedEntityDataDomainCollection 删除链接实体数据域后， LinkedEntityCellValue 无法创建此链接实体数据域的新对象，也无法刷新现有 LinkedEntityCellValue 对象。 Office 加载项只能删除其创建的链接实体数据域。
delete(): void;返回
void
注解
Excel web 版不支持此方法。
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.LinkedEntityDataDomain;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
refresh()
刷新此链接实体数据域的所有 LinkedEntityCellValue 对象。 如果数据提供程序繁忙或暂时无法访问，刷新请求可能会失败。
refresh(): void;返回
void
注解
Excel web 版不支持此方法。
示例
// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
// Get a specific data domain by ID and refresh it.
const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
productsDomain.refresh();
await context.sync();
});
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.LinkedEntityDataDomain 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.LinkedEntityDataDomainData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;