Excel.Interfaces.LinkedEntityDataDomainLoadOptions interface

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

属性

$all

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

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

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

属性详细信息

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

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