Excel.LinkedEntityDataDomain class
Представляет определенную категорию или область данных с некоторыми общими характеристиками или атрибутами. Домен данных связан с поставщиком данных, который выступает в качестве источника данных для LinkedEntityCellValue объектов в книге. Домен данных — это категория данных, например акции, география или валюты. Поставщиком данных называется служба, например Bing, Power BI или надстройка Office.
- Extends
Комментарии
Этот класс не поддерживается в Excel в Интернете.
Используется
- Excel.LinkedEntityDataDomainCollection: getItem, getItemAt, getItemByName, getItemByNameOrNullObject, getItemOrNullObject, items
Примеры
// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
// Get a specific data domain by ID and refresh it.
const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
productsDomain.refresh();
await context.sync();
});
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| data |
Получает имя поставщика данных для домена данных связанного объекта. Это имя может меняться в зависимости от сведений, предоставленных поставщиком данных. |
| id | Получает идентификатор домена данных связанного объекта, определенного надстройками Office. Этот идентификатор неприменим к доменам данных связанных сущностей, определенным поставщиками данных служб, такими как Bing или Power BI. |
| last |
Получает дату и время (в локальном часовом поясе) с момента открытия книги и |
| load |
Получает идентификатор пользовательской функции, вызываемой по требованию для разрешения или обновления |
| name | Получает имя домена данных связанного объекта. Это имя может меняться в зависимости от сведений, предоставленных поставщиком данных. |
| periodic |
Получает частоту в секундах, с которой |
| refresh |
Определяет режим обновления, определяющий, как и когда |
| service |
Получает идентификатор службы домена данных связанного объекта. Этот идентификатор является постоянно зарезервированным значением для всех связанных доменов данных сущностей, которые определяются поставщиками данных служб, такими как Bing или Power BI, либо определяются надстройками Office. Этот идентификатор никогда не меняется между сеансами пользователей. |
| supported |
Получают все режимы обновления, поддерживаемые доменом данных связанного объекта. Этот массив может изменяться на основе сведений, предоставленных поставщиком данных. |
Методы
| delete() | Удаляет этот объект из |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| refresh() | Обновляет все |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
dataProvider
Получает имя поставщика данных для домена данных связанного объекта. Это имя может меняться в зависимости от сведений, предоставленных поставщиком данных.
readonly dataProvider: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
id
Получает идентификатор домена данных связанного объекта, определенного надстройками Office. Этот идентификатор неприменим к доменам данных связанных сущностей, определенным поставщиками данных служб, такими как Bing или Power BI.
readonly id: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
lastRefreshed
Получает дату и время (в локальном часовом поясе) с момента открытия книги и LinkedEntityCellValue последнего обновления объектов этого связанного домена данных сущности. Возвращает undefined , если LinkedEntityCellValue объекты не обновлялись с момента открытия книги.
readonly lastRefreshed: Date;Значение свойства
Date
Комментарии
Это свойство не поддерживается в Excel в Интернете.
loadFunctionId
Получает идентификатор пользовательской функции, вызываемой по требованию для разрешения или обновления LinkedEntityCellValue объектов связанного домена данных объекта, определенного надстройками Office. Дополнительные сведения см. в статье Автоматическое создание метаданных JSON для пользовательских функций: ID. Этот идентификатор неприменим к доменам данных связанных сущностей, определенным поставщиками данных служб, такими как Bing или Power BI.
readonly loadFunctionId: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
name
Получает имя домена данных связанного объекта. Это имя может меняться в зависимости от сведений, предоставленных поставщиком данных.
readonly name: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
periodicRefreshInterval
Получает частоту в секундах, с которой LinkedEntityCellValue объекты этого связанного домена данных объекта обновляются автоматически. Интервал обновления применяется только в том случае, если refreshMode для него задано значение "Периодический".
readonly periodicRefreshInterval: number;Значение свойства
number
Комментарии
Это свойство не поддерживается в Excel в Интернете.
refreshMode
Определяет режим обновления, определяющий, как и когда LinkedEntityCellValue обновляются объекты этого связанного домена данных объекта. Если устанавливаемый режим обновления не поддерживается этим связанным доменом данных объекта, текущий режим обновления не изменяется. Если выбран режим обновления "Периодический", интервал обновления устанавливается в periodicRefreshInterval соответствии с доменом данных этого связанного объекта.
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";Значение свойства
Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"
Комментарии
Это свойство не поддерживается в Excel в Интернете.
serviceId
Получает идентификатор службы домена данных связанного объекта. Этот идентификатор является постоянно зарезервированным значением для всех связанных доменов данных сущностей, которые определяются поставщиками данных служб, такими как Bing или Power BI, либо определяются надстройками Office. Этот идентификатор никогда не меняется между сеансами пользователей.
readonly serviceId: number;Значение свойства
number
Комментарии
Это свойство не поддерживается в Excel в Интернете.
supportedRefreshModes
Получают все режимы обновления, поддерживаемые доменом данных связанного объекта. Этот массив может изменяться на основе сведений, предоставленных поставщиком данных.
readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];Значение свойства
Комментарии
Это свойство не поддерживается в Excel в Интернете.
Сведения о методе
delete()
Удаляет этот объект из LinkedEntityDataDomainCollectionфайла . После удаления домена данных связанного объекта невозможно создать новые LinkedEntityCellValue объекты этого связанного домена данных, а существующие LinkedEntityCellValue объекты нельзя будет обновить. Надстройка Office может удалять только созданные ею домены данных.
delete(): void;Возвращаемое значение
void
Комментарии
Этот метод не поддерживается в Excel в Интернете.
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
Комментарии
Этот метод не поддерживается в Excel в Интернете.
Примеры
// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
// Get a specific data domain by ID and refresh it.
const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
productsDomain.refresh();
await context.sync();
});
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.LinkedEntityDataDomain объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.LinkedEntityDataDomainData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;