IClientSideWebPartStatusRenderer interface

Пакет:

@microsoft/sp-webpart-base

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

Методы

clearError(domElement)	Удаление сообщения об ошибке веб-части.
clearLoadingIndicator(domElement)	Удаление индикатора загрузки.
displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)	Отображение индикатора загрузки.
renderError(domElement, error, clearDomElementCallback)	Отображение указанного сообщения об ошибке в разделителе контейнера веб-части.

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

clearError(domElement)

Удаление сообщения об ошибке веб-части.

clearError(domElement: HTMLElement): void;

Параметры

domElement

HTMLElement

раздел контейнера веб-части.

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

void

clearLoadingIndicator(domElement)

Удаление индикатора загрузки.

clearLoadingIndicator(domElement: Element): void;

Параметры

domElement

Element

раздел контейнера веб-части.

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

void

displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)

Отображение индикатора загрузки.

displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number, clearDomElementCallback?: ClearDomElementCallback): void;

Параметры

domElement

Element

раздел контейнера веб-части.

loadingMessage

string

Сообщение, отображаемое вместе с идентификатором загрузки.

timeout

number

__ Время ожидания до отображения индикатора загрузки. Значение по умолчанию — 1500 мс.

clearDomElementCallback

@microsoft/sp-webpart-base!~ClearDomElementCallback:type

Обратный вызов для очистки узла dom перед отрисовкой индикатора. Стандартный API DOM будет использоваться после обратного вызова.

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

void

renderError(domElement, error, clearDomElementCallback)

Отображение указанного сообщения об ошибке в разделителе контейнера веб-части.

renderError(domElement: HTMLElement, error: Error | string, clearDomElementCallback?: ClearDomElementCallback): void;

Параметры

domElement

HTMLElement

раздел контейнера веб-части.

error

Error | string

Сообщение об ошибке.

clearDomElementCallback

@microsoft/sp-webpart-base!~ClearDomElementCallback:type

Обратный вызов для очистки узла dom перед отрисовкой элемента error. Стандартный API DOM будет использоваться после обратного вызова.

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

void