Excel.LinkedEntityDataDomain class
表示共享某些共同特征或属性的特定类别或信息字段。 数据域链接到数据提供程序，该提供程序充当工作簿中对象的数据源 LinkedEntityCellValue 。 数据域是一类数据，例如股票、地理或货币。 数据提供程序是一种服务，例如必应、Power BI 或 Office 加载项。
注解
属性
| 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
注解
id
获取 Office 外接程序定义的链接实体数据域的 ID。此 ID 不适用于由服务数据提供程序（如必应或 Power BI）定义的链接实体数据域。
readonly id: string;属性值
string
注解
lastRefreshed
获取自工作簿打开 LinkedEntityCellValue 且上次刷新此链接实体数据域的对象以来本地时区) 的 (日期和时间。
undefined如果LinkedEntityCellValue自工作簿打开以来未刷新对象，则返回 。
readonly lastRefreshed: Date;属性值
Date
注解
loadFunctionId
获取按需调用的自定义函数的 ID，该函数用于解析或刷新 LinkedEntityCellValue Office 外接程序定义的链接实体数据域的对象。有关详细信息，请参阅 自动生成自定义函数的 JSON 元数据：ID。 此 ID 不适用于由服务数据提供程序（如必应或 Power BI）定义的链接实体数据域。
readonly loadFunctionId: string;属性值
string
注解
name
periodicRefreshInterval
获取自动刷新此链接实体数据域对象的频率（以 LinkedEntityCellValue 秒为单位）。 仅当 设置为“定期”时， refreshMode 刷新间隔才适用。
readonly periodicRefreshInterval: number;属性值
number
注解
refreshMode
指定刷新模式，该模式定义如何以及何时 LinkedEntityCellValue 刷新此链接实体数据域的对象。 如果此链接实体数据域不支持正在设置的刷新模式，则当前刷新模式不会更改。 如果刷新模式设置为“定期”，则刷新间隔设置为 periodicRefreshInterval 此链接实体数据域的 。
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";属性值
Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"
注解
serviceId
获取链接实体数据域的服务 ID。 此 ID 是所有链接实体数据域的永久保留值，这些域由服务数据提供程序（如必应或 Power BI）定义，或由 Office 外接程序定义。此 ID 永远不会在用户会话中更改。
readonly serviceId: number;属性值
number
注解
supportedRefreshModes
获取链接实体数据域支持的所有刷新模式。 此数组可以根据数据提供程序提供的信息进行更改。
readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];属性值
注解
方法详细信息
delete()
从 LinkedEntityDataDomainCollection中删除此对象。 删除链接实体数据域后，无法创建此链接实体数据域的新 LinkedEntityCellValue 对象，并且无法刷新现有 LinkedEntityCellValue 对象。 Office 外接程序只能删除它创建的链接实体数据域。
delete(): void;返回
void
注解
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
注解
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.LinkedEntityDataDomain对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LinkedEntityDataDomainData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;