Excel.Interfaces.LinkedEntityDataDomainData interface

一个描述通过调用 linkedEntityDataDomain.toJSON()返回的数据的接口。

注解

使用方

属性

dataProvider

获取链接实体数据域的数据提供程序的名称。 此名称可能会根据数据提供程序提供的信息而更改。

id

获取 Office 加载项定义的链接实体数据域的 ID。此 ID 不适用于服务提供商(如必应或 Power BI)定义的链接实体数据域。

lastRefreshed

获取自打开工作簿和 LinkedEntityCellValue 上次刷新此链接实体数据域的对象以来) 本地时区 (的日期和时间。 如果自打开工作簿以来尚未刷新对象,则LinkedEntityCellValue返回undefined

loadFunctionId

获取按需调用的自定义函数的 ID,该函数用于解析或刷新 LinkedEntityCellValue 由 Office 加载项定义的链接实体数据域的对象。有关详细信息,请参阅 为自定义函数自动生成 JSON 元数据:ID。 此 ID 不适用于服务提供商(如必应或 Power BI)定义的链接实体数据域。

name

获取链接的实体数据域的名称。 此名称可能会根据数据提供程序提供的信息而更改。

periodicRefreshInterval

获取此链接实体数据域的对象自动刷新的频率(以秒 LinkedEntityCellValue 为单位)。 刷新间隔仅适用于设置为“定期”的情况 refreshMode

refreshMode

指定刷新模式,该模式定义如何以及何时 LinkedEntityCellValue 刷新此链接实体数据域的对象。 如果此链接实体数据域不支持正在设置的刷新模式,则不会更改当前刷新模式。 如果刷新模式设置为“定期”,则刷新间隔设置为此链接实体数据域的刷新 periodicRefreshInterval 间隔。

serviceId

获取链接的实体数据域的服务 ID。 此 ID 是所有链接实体数据域的永久保留值,这些域由服务数据提供程序(如必应或 Power BI)定义,或由 Office 加载项定义。此 ID 永远不会跨用户会话更改。

supportedRefreshModes

获取链接实体数据域支持的所有刷新模式。 此数组可以根据数据提供程序提供的信息进行更改。

属性详细信息

dataProvider

获取链接实体数据域的数据提供程序的名称。 此名称可能会根据数据提供程序提供的信息而更改。

dataProvider?: string;

属性值

string

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

id

获取 Office 加载项定义的链接实体数据域的 ID。此 ID 不适用于服务提供商(如必应或 Power BI)定义的链接实体数据域。

id?: string;

属性值

string

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

lastRefreshed

获取自打开工作簿和 LinkedEntityCellValue 上次刷新此链接实体数据域的对象以来) 本地时区 (的日期和时间。 如果自打开工作簿以来尚未刷新对象,则LinkedEntityCellValue返回undefined

lastRefreshed?: Date;

属性值

Date

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

loadFunctionId

获取按需调用的自定义函数的 ID,该函数用于解析或刷新 LinkedEntityCellValue 由 Office 加载项定义的链接实体数据域的对象。有关详细信息,请参阅 为自定义函数自动生成 JSON 元数据:ID。 此 ID 不适用于服务提供商(如必应或 Power BI)定义的链接实体数据域。

loadFunctionId?: string;

属性值

string

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

name

获取链接的实体数据域的名称。 此名称可能会根据数据提供程序提供的信息而更改。

name?: string;

属性值

string

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

periodicRefreshInterval

获取此链接实体数据域的对象自动刷新的频率(以秒 LinkedEntityCellValue 为单位)。 刷新间隔仅适用于设置为“定期”的情况 refreshMode

periodicRefreshInterval?: number;

属性值

number

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

refreshMode

指定刷新模式,该模式定义如何以及何时 LinkedEntityCellValue 刷新此链接实体数据域的对象。 如果此链接实体数据域不支持正在设置的刷新模式,则不会更改当前刷新模式。 如果刷新模式设置为“定期”,则刷新间隔设置为此链接实体数据域的刷新 periodicRefreshInterval 间隔。

refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

属性值

Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

serviceId

获取链接的实体数据域的服务 ID。 此 ID 是所有链接实体数据域的永久保留值,这些域由服务数据提供程序(如必应或 Power BI)定义,或由 Office 加载项定义。此 ID 永远不会跨用户会话更改。

serviceId?: number;

属性值

number

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。

supportedRefreshModes

获取链接实体数据域支持的所有刷新模式。 此数组可以根据数据提供程序提供的信息进行更改。

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

属性值

注解

API 集:ExcelApi 1.19

Excel web 版不支持此属性。