Поделиться через


Excel.Interfaces.LinkedEntityDataDomainLoadOptions interface

Представляет определенную категорию или поле сведений, которые используют некоторые общие характеристики или атрибуты. Домен данных связан с поставщиком данных, который выступает в качестве источника данных для LinkedEntityCellValue объектов в книге. Домен данных — это категория данных, например акции, география или валюты. Поставщик данных — это служба, например Bing, Power BI или надстройка Office.

Комментарии

[ Набор API: ExcelApi 1.19 ]

Свойства

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

dataProvider

Возвращает имя поставщика данных для домена данных связанной сущности. Это имя может измениться в зависимости от сведений, предоставленных поставщиком данных.

id

Возвращает идентификатор домена данных связанной сущности, определенного надстройками Office. Этот идентификатор не применим к доменам данных связанных сущностей, определенным поставщиками данных служб, например Bing или Power BI.

lastRefreshed

Возвращает дату и время (в локальном часовом поясе) с момента открытия книги и LinkedEntityCellValue последнего обновления объектов этого домена данных связанной сущности. Возвращает значение undefined , если LinkedEntityCellValue объекты не обновлялись с момента открытия книги.

loadFunctionId

Возвращает идентификатор пользовательской функции, вызываемой по запросу для разрешения или обновления LinkedEntityCellValue объектов домена данных связанной сущности, определенного надстройками Office. Дополнительные сведения см. в разделе Автоматическое создание метаданных JSON для пользовательских функций: идентификатор. Этот идентификатор не применим к доменам данных связанных сущностей, определенным поставщиками данных служб, например Bing или Power BI.

name

Возвращает имя домена данных связанной сущности. Это имя может измениться в зависимости от сведений, предоставленных поставщиком данных.

periodicRefreshInterval

Возвращает частоту в секундах, с которой LinkedEntityCellValue объекты этого домена данных связанной сущности обновляются автоматически. Интервал обновления применяется только в том случае, refreshMode если для задано значение "Периодический".

refreshMode

Указывает режим обновления, определяющий, как и когда LinkedEntityCellValue обновляются объекты этого домена данных связанной сущности. Если заданный режим обновления не поддерживается этим доменом данных связанной сущности, текущий режим обновления не изменяется. Если для режима обновления задано значение "Периодический", для интервала обновления устанавливается periodicRefreshInterval значение этого домена данных связанной сущности.

serviceId

Возвращает идентификатор службы домена данных связанной сущности. Этот идентификатор является постоянно зарезервированным значением для всех доменов данных связанных сущностей, которые определяются поставщиками данных служб, такими как Bing или Power BI, или определяются надстройками Office. Этот идентификатор никогда не изменяется в сеансах пользователей.

supportedRefreshModes

Возвращает все режимы обновления, поддерживаемые доменом данных связанной сущности. Этот массив может изменяться в зависимости от информации, предоставленной поставщиком данных.

Сведения о свойстве

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

$all?: boolean;

Значение свойства

boolean

dataProvider

Возвращает имя поставщика данных для домена данных связанной сущности. Это имя может измениться в зависимости от сведений, предоставленных поставщиком данных.

dataProvider?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.19 ]

id

Возвращает идентификатор домена данных связанной сущности, определенного надстройками Office. Этот идентификатор не применим к доменам данных связанных сущностей, определенным поставщиками данных служб, например Bing или Power BI.

id?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.19 ]

lastRefreshed

Возвращает дату и время (в локальном часовом поясе) с момента открытия книги и LinkedEntityCellValue последнего обновления объектов этого домена данных связанной сущности. Возвращает значение undefined , если LinkedEntityCellValue объекты не обновлялись с момента открытия книги.

lastRefreshed?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.19 ]

loadFunctionId

Возвращает идентификатор пользовательской функции, вызываемой по запросу для разрешения или обновления LinkedEntityCellValue объектов домена данных связанной сущности, определенного надстройками Office. Дополнительные сведения см. в разделе Автоматическое создание метаданных JSON для пользовательских функций: идентификатор. Этот идентификатор не применим к доменам данных связанных сущностей, определенным поставщиками данных служб, например Bing или 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

Возвращает идентификатор службы домена данных связанной сущности. Этот идентификатор является постоянно зарезервированным значением для всех доменов данных связанных сущностей, которые определяются поставщиками данных служб, такими как Bing или Power BI, или определяются надстройками Office. Этот идентификатор никогда не изменяется в сеансах пользователей.

serviceId?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.19 ]

supportedRefreshModes

Возвращает все режимы обновления, поддерживаемые доменом данных связанной сущности. Этот массив может изменяться в зависимости от информации, предоставленной поставщиком данных.

supportedRefreshModes?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.19 ]