Excel.LinkedEntityDataDomainCreateOptions interface
Представляет параметры, которые используются для создания LinkedEntityDataDomain добавляемого LinkedEntityDataDomainCollectionв файл объекта .
Комментарии
Этот интерфейс не поддерживается в Excel в Интернете.
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-linked-entities.yaml
// Register the product, category, and supplier data sources with Excel.
await Excel.run(async (context) => {
const domains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
const refreshModes: Excel.LinkedEntityDataDomainRefreshMode[] = [
Excel.LinkedEntityDataDomainRefreshMode.manual,
Excel.LinkedEntityDataDomainRefreshMode.onLoad,
Excel.LinkedEntityDataDomainRefreshMode.periodic
];
// Script Lab prefixes the function ID with the companion sample's name, without spaces.
const loadFunctionId = "LINKEDENTITYLOADSERVICE.CONTOSOLOADSERVICE";
const options: Excel.LinkedEntityDataDomainCreateOptions[] = [
{
dataProvider: "Contoso",
id: "products",
name: "Products",
loadFunctionId,
periodicRefreshInterval: 300,
supportedRefreshModes: refreshModes
},
{
dataProvider: "Contoso",
id: "categories",
name: "Categories",
loadFunctionId,
periodicRefreshInterval: 300,
supportedRefreshModes: refreshModes
},
{
dataProvider: "Contoso",
id: "suppliers",
name: "Suppliers",
loadFunctionId
}
];
// Replace only this sample's domains so registration is repeatable.
const existingDomains: Excel.LinkedEntityDataDomain[] = options.map((options) =>
domains.getItemOrNullObject(options.id)
);
await context.sync();
existingDomains.forEach((domain) => {
if (!domain.isNullObject) {
domain.delete();
}
});
options.forEach((options) => domains.add(options));
await context.sync();
console.log("Registered Products, Categories, and Suppliers. Manual refresh is the default.");
});
Свойства
| data |
Указывает имя поставщика данных для домена данных связанного объекта. |
| id | Указывает идентификатор домена данных связанного объекта. Этот идентификатор должен быть уникальным во всех связанных доменах данных объекта, определенных этой надстройкой Office. |
| load |
Указывает идентификатор пользовательской функции, которая будет вызываться по требованию для разрешения или обновления |
| name | Указывает имя домена данных связанного объекта. Это имя должно быть уникальным во всех связанных доменах данных объекта, определенных этой надстройкой Office. |
| periodic |
Указывает частоту в секундах, с которой |
| supported |
Определяет все режимы обновления, поддерживаемые доменом данных связанного объекта. Значение по умолчанию — |
Сведения о свойстве
dataProvider
Указывает имя поставщика данных для домена данных связанного объекта.
dataProvider: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
id
Указывает идентификатор домена данных связанного объекта. Этот идентификатор должен быть уникальным во всех связанных доменах данных объекта, определенных этой надстройкой Office.
id: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
loadFunctionId
Указывает идентификатор пользовательской функции, которая будет вызываться по требованию для разрешения или обновления LinkedEntityCellValue объектов этого связанного домена данных объекта. Дополнительные сведения см. в статье Автоматическое создание метаданных JSON для пользовательских функций: ID.
loadFunctionId: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
name
Указывает имя домена данных связанного объекта. Это имя должно быть уникальным во всех связанных доменах данных объекта, определенных этой надстройкой Office.
name: string;Значение свойства
string
Комментарии
Это свойство не поддерживается в Excel в Интернете.
periodicRefreshInterval
Указывает частоту в секундах, с которой LinkedEntityCellValue объекты этого связанного домена данных объекта обновляются автоматически. Минимально допустимое значение — 300. Это свойство необходимо, если supportedRefreshModes массив содержит значение "Periodic". Это свойство применимо только в том случае, refreshMode если для связанного домена данных сущности задано значение "Периодический".
periodicRefreshInterval?: number;Значение свойства
number
Комментарии
Это свойство не поддерживается в Excel в Интернете.
supportedRefreshModes
Определяет все режимы обновления, поддерживаемые доменом данных связанного объекта. Значение по умолчанию — ["Manual"], которое всегда поддерживается, даже если оно не указано. Сохраненный в книге режим обновления загружается как режим обновления по умолчанию для домена данных связанного объекта при следующем открытии книги. Если режим обновления не был сохранен в книге, первое значение в массиве устанавливается в качестве режима обновления по умолчанию для домена данных связанного объекта. Если массив имеет значение "Periodic", свойство periodicRefreshInterval также должно быть установлено для связанного домена данных сущности.
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];Значение свойства
Комментарии
Это свойство не поддерживается в Excel в Интернете.