Excel.Interfaces.LinkedEntityDataDomainLoadOptions interface

表示共享某些共同特征或属性的特定类别或信息字段。 数据域链接到数据提供程序,该提供程序充当工作簿中对象的数据源 LinkedEntityCellValue 。 数据域是一类数据,例如股票、地理或货币。 数据提供程序是一种服务,例如必应、Power BI 或 Office 加载项。

注解

[ API 集:ExcelApi 1.19 ]

属性

$all

$all为加载选项指定将加载所有标量属性 ((例如Range.address) ,但不加载导航属性 (如 Range.format.fill.color) )。

dataProvider

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

id

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

lastRefreshed

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

loadFunctionId

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

name

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

periodicRefreshInterval

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

refreshMode

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

serviceId

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

supportedRefreshModes

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

属性详细信息

$all

$all为加载选项指定将加载所有标量属性 ((例如Range.address) ,但不加载导航属性 (如 Range.format.fill.color) )。

$all?: boolean;

属性值

boolean

dataProvider

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

dataProvider?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

id

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

id?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

lastRefreshed

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

lastRefreshed?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

loadFunctionId

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

loadFunctionId?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

name

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

name?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

periodicRefreshInterval

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

periodicRefreshInterval?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

refreshMode

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

refreshMode?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

serviceId

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

serviceId?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]

supportedRefreshModes

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

supportedRefreshModes?: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.19 ]