Excel.LinkedDataType class

Пакет:

excel

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет связанный тип данных. Связанный тип данных — это тип данных, подключенный к интернет-источнику данных.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
dataProvider	Имя поставщика данных для связанного типа данных. Это может измениться при получении сведений из службы.
lastRefreshed	Дата и время локального часового пояса с момента открытия книги при последнем обновлении связанного типа данных. Возвращает значение undefined , если связанный тип данных не был обновлен.
name	Имя связанного типа данных. Это может измениться при получении сведений из службы.
periodicRefreshInterval	Частота в секундах, с которой обновляется связанный тип данных, если refreshMode задано значение "Периодический".
refreshMode	Механизм, с помощью которого извлекаются данные для связанного типа данных.
serviceId	Уникальный идентификатор связанного типа данных.
supportedRefreshModes	Возвращает массив со всеми режимами обновления, поддерживаемыми связанным типом данных. Содержимое массива может измениться при получении сведений из службы.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
requestRefresh()	Отправляет запрос на обновление связанного типа данных. Если служба занята или иным образом временно недоступна, запрос не будет выполнен.
requestSetRefreshMode(refreshMode)	Отправляет запрос на изменение режима обновления для этого связанного типа данных. Если указанный режим обновления не поддерживается этим связанным типом данных, режим остается без изменений. Если задано значение "Периодический", для интервала обновления устанавливается предопределенное значение на основе конкретного связанного типа данных.
requestSetRefreshMode(refreshModeString)	Отправляет запрос на изменение режима обновления для этого связанного типа данных. Если указанный режим обновления не поддерживается этим связанным типом данных, режим остается без изменений. Если задано значение "Периодический", для интервала обновления устанавливается предопределенное значение на основе конкретного связанного типа данных.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.LinkedDataType является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.LinkedDataTypeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

context: RequestContext;

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

Excel.RequestContext

dataProvider

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

readonly dataProvider: string;

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

string

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

lastRefreshed

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

readonly lastRefreshed: Date;

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

Date

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

name

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Имя связанного типа данных. Это может измениться при получении сведений из службы.

readonly name: string;

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

string

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

periodicRefreshInterval

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Частота в секундах, с которой обновляется связанный тип данных, если refreshMode задано значение "Периодический".

readonly periodicRefreshInterval: number;

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

number

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

refreshMode

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Механизм, с помощью которого извлекаются данные для связанного типа данных.

readonly refreshMode: Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

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

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

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

serviceId

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Уникальный идентификатор связанного типа данных.

readonly serviceId: number;

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

number

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

supportedRefreshModes

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

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

Excel.LinkedDataTypeRefreshMode[]

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

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

load(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

load(options?: Excel.Interfaces.LinkedDataTypeLoadOptions): Excel.LinkedDataType;

Параметры

options

Excel.Interfaces.LinkedDataTypeLoadOptions

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

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

Excel.LinkedDataType

load(propertyNames)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.LinkedDataType

load(propertyNamesAndPaths)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.LinkedDataType

requestRefresh()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Отправляет запрос на обновление связанного типа данных. Если служба занята или иным образом временно недоступна, запрос не будет выполнен.

requestRefresh(): void;

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

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

requestSetRefreshMode(refreshMode)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

Параметры

refreshMode

Excel.LinkedDataTypeRefreshMode

Предполагаемый режим, в который требуется изменить этот связанный тип данных.

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

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

requestSetRefreshMode(refreshModeString)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

requestSetRefreshMode(refreshModeString: "Unknown" | "Manual" | "OnLoad" | "Periodic"): void;

Параметры

refreshModeString

"Unknown" | "Manual" | "OnLoad" | "Periodic"

Предполагаемый режим, в который требуется изменить этот связанный тип данных.

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

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

toJSON()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

toJSON(): Excel.Interfaces.LinkedDataTypeData;

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

Excel.Interfaces.LinkedDataTypeData