DynamicDataProvider class

Пакет:

@microsoft/sp-component-base

Поставщик динамических данных позволяет компонентам использовать динамические данные. Она позволяет компонентам запрашивать источники динамических данных и регистрировать и отменять регистрацию в них.

Свойства

isDisposed

Возвращает значение true, если поставщик динамических данных удален.

Методы

dispose()	Удаляет поставщик динамических данных.
getAvailableSources()	Возвращает список со всеми доступными динамическими источниками данных.
registerAvailableSourcesChanged(callback)	Регистрирует обратный вызов к событию, которое возникает при обновлении списка доступных динамических источников данных.
registerPropertyChanged(sourceId, propertyId, callback)	Регистрирует обратный вызов для обновлений при изменении свойства в источнике динамических данных.
registerSourceChanged(sourceId, callback)	Регистрирует обратный вызов для обновлений при изменении источника динамических данных. Это происходит при обновлении любого свойства в источнике.
tryGetSource(id)	Возвращает динамический источник данных по его идентификатору. Если источник отсутствует, возвращается значение undefined.
unregisterAvailableSourcesChanged(callback)	Отменяет регистрацию обратного вызова к событию, которое возникает при обновлении списка доступных динамических источников данных.
unregisterPropertyChanged(sourceId, propertyId, callback)	Отменяет регистрацию обратного вызова для обновлений при изменении свойства в источнике динамических данных.
unregisterSourceChanged(sourceId, callback)	Отменяет регистрацию обратного вызова для обновлений при изменении источника динамических данных.

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

isDisposed

Возвращает значение true, если поставщик динамических данных удален.

get isDisposed(): boolean;

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

boolean

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

dispose()

Удаляет поставщик динамических данных.

dispose(): void;

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

void

getAvailableSources()

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

getAvailableSources(): ReadonlyArray<IDynamicDataSource>;

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

ReadonlyArray<IDynamicDataSource>

Массив только для чтения со всеми доступными источниками.

registerAvailableSourcesChanged(callback)

Регистрирует обратный вызов к событию, которое возникает при обновлении списка доступных динамических источников данных.

registerAvailableSourcesChanged(callback: () => void): void;

Параметры

callback

() => void

Функция, выполняемая при обновлении источников.

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

void

registerPropertyChanged(sourceId, propertyId, callback)

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

registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

Параметры

sourceId

string

Идентификатор динамического источника данных.

propertyId

string

Идентификатор свойства источника.

callback

() => void

Функция, выполняемая при обновлении исходных данных.

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

void

registerSourceChanged(sourceId, callback)

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

registerSourceChanged(sourceId: string, callback: () => void): void;

Параметры

sourceId

string

Идентификатор динамического источника данных.

callback

() => void

Функция, выполняемая при обновлении исходных данных.

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

void

tryGetSource(id)

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

tryGetSource(id: string): IDynamicDataSource | undefined;

Параметры

id

string

Идентификатор динамического источника данных.

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

IDynamicDataSource | undefined

unregisterAvailableSourcesChanged(callback)

Отменяет регистрацию обратного вызова к событию, которое возникает при обновлении списка доступных динамических источников данных.

unregisterAvailableSourcesChanged(callback: () => void): void;

Параметры

callback

() => void

Функция для удаления из регистрации. Должен быть таким же, как он был зарегистрирован.

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

void

unregisterPropertyChanged(sourceId, propertyId, callback)

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

unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

Параметры

sourceId

string

Идентификатор динамического источника данных.

propertyId

string

Идентификатор свойства источника.

callback

() => void

Функция для удаления из регистрации. Должен быть таким же, как он был зарегистрирован.

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

void

unregisterSourceChanged(sourceId, callback)

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

unregisterSourceChanged(sourceId: string, callback: () => void): void;

Параметры

sourceId

string

Идентификатор динамического источника данных.

callback

() => void

Функция для удаления из регистрации. Должен быть таким же, как он был зарегистрирован.

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

void