Excel.LinkedEntityDataDomain class

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

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

Методы

delete()	Удаляет этот объект из `LinkedEntityDataDomainCollection`. После удаления домена данных связанной сущности не удается создать новые `LinkedEntityCellValue` объекты этого домена данных связанной сущности, а существующие `LinkedEntityCellValue` объекты не удастся обновить. Надстройка Office может удалять только созданные домены данных связанных сущностей.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
refresh()	Обновляет все `LinkedEntityCellValue` объекты этого домена данных связанной сущности. Запрос на обновление может завершиться ошибкой, если поставщик данных занят или временно недоступен.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.LinkedEntityDataDomain` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.LinkedEntityDataDomainData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Excel.RequestContext

dataProvider

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

readonly dataProvider: string;

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

string

id

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

readonly id: string;

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

string

lastRefreshed

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

readonly lastRefreshed: Date;

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

Date

loadFunctionId

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

readonly loadFunctionId: string;

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

string

name

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

readonly name: string;

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

string

periodicRefreshInterval

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

readonly periodicRefreshInterval: number;

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

number

refreshMode

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

refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

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

Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

serviceId

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

readonly serviceId: number;

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

number

supportedRefreshModes

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

readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];

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

Excel.LinkedEntityDataDomainRefreshMode[]

Сведения о методе

delete()

Удаляет этот объект из LinkedEntityDataDomainCollection. После удаления домена данных связанной сущности не удается создать новые LinkedEntityCellValue объекты этого домена данных связанной сущности, а существующие LinkedEntityCellValue объекты не удастся обновить. Надстройка Office может удалять только созданные домены данных связанных сущностей.

delete(): void;

Возвращаемое значение

void

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;

Параметры

options: Excel.Interfaces.LinkedEntityDataDomainLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.LinkedEntityDataDomain

load(propertyNames)

load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.LinkedEntityDataDomain

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.LinkedEntityDataDomain;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.LinkedEntityDataDomain

refresh()

Обновляет все LinkedEntityCellValue объекты этого домена данных связанной сущности. Запрос на обновление может завершиться ошибкой, если поставщик данных занят или временно недоступен.

refresh(): void;

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.LinkedEntityDataDomain объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.LinkedEntityDataDomainData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

Возвращаемое значение

Excel.Interfaces.LinkedEntityDataDomainData

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

Excel.LinkedEntityDataDomain class

Комментарии

Свойства

Методы

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

context

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

dataProvider

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

Комментарии

id

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

Комментарии

lastRefreshed

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

Комментарии

loadFunctionId

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

Комментарии

name

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

Комментарии

periodicRefreshInterval

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

Комментарии

refreshMode

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

Комментарии

serviceId

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

Комментарии

supportedRefreshModes

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

Комментарии

Сведения о методе

delete()

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

refresh()

Возвращаемое значение

Комментарии

toJSON()

Возвращаемое значение

Обратная связь