IDynamicDataCallables interface

Пакет:

@microsoft/sp-dynamic-data

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

Методы

allowedEvents()	Возвращает список разрешенных событий в динамическом источнике данных. Если эта функция возвращает непустый результат, источник должен определить API sendEvent. Если этот API не определен или возвращает пустой массив, ни один потребитель не сможет взаимодействовать с этим источником.
getAnnotatedPropertyValue(propertyId)	При указании идентификатора свойства возвращает его значение с заметками. Если источник не предоставляет значение с заметками, он возвращается к тому, что возвращает getPropertyValue, так как выборочное значение и метаданные будут неопределенными.
getPropertyDefinitions()	Возвращает все определения свойств, которые будет предоставлять DataSource.
getPropertyValue(propertyId)	При указании идентификатора свойства возвращает значение свойства .
sendEvent(eventName, data)	Если этот параметр определен, потребитель может отправлять данные в связанный динамический источник данных. Затем источник может действовать соответствующим образом. Вызов этого API выдает ошибку, если переданное в "eventName" не является одним из разрешенных событий в источнике.

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

allowedEvents()

Примечание

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

Возвращает список разрешенных событий в динамическом источнике данных.

Если эта функция возвращает непустый результат, источник должен определить API sendEvent.

Если этот API не определен или возвращает пустой массив, ни один потребитель не сможет взаимодействовать с этим источником.

allowedEvents?(): ReadonlyArray<IDynamicDataEventDefinition>;

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

ReadonlyArray<IDynamicDataEventDefinition>

getAnnotatedPropertyValue(propertyId)

При указании идентификатора свойства возвращает его значение с заметками. Если источник не предоставляет значение с заметками, он возвращается к тому, что возвращает getPropertyValue, так как выборочное значение и метаданные будут неопределенными.

getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;

Параметры

propertyId

string

Один из идентификаторов свойств, предоставляемых из динамического источника данных.

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

IDynamicDataAnnotatedPropertyValue | undefined

getPropertyDefinitions()

Возвращает все определения свойств, которые будет предоставлять DataSource.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

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

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyValue(propertyId)

При указании идентификатора свойства возвращает значение свойства .

getPropertyValue(propertyId: string): any;

Параметры

propertyId

string

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

any

Комментарии

Предполагается, что, когда эта функция возвращает массив, он является однородным.

sendEvent(eventName, data)

Примечание

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

Если этот параметр определен, потребитель может отправлять данные в связанный динамический источник данных. Затем источник может действовать соответствующим образом.

Вызов этого API выдает ошибку, если переданное в "eventName" не является одним из разрешенных событий в источнике.

sendEvent?(eventName: string, data: any): void;

Параметры

eventName

string

Строка с учетом регистра, представляющая имя события.

data

any

Данные, отправляемые в динамический источник данных.

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

void