Freigeben über

IClientSideWebPartStatusRenderer interface

Paket:
@microsoft/sp-webpart-base

Schnittstelle, die von einer Komponente implementiert werden soll, die den Ladeindikator und Fehlermeldungen für ein Webpart anzeigen soll.

Methoden

clearError(domElement)

Deaktiviert die Webpart-Fehlermeldung.
clearLoadingIndicator(domElement)

Deaktiviert die Ladeanzeige.
displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)

Zeigt eine Ladedrehfeld an.
renderError(domElement, error, clearDomElementCallback)

Rendert die bereitgestellte Fehlermeldung im div-Webpartcontainer

Details zur Methode

clearError(domElement)

Deaktiviert die Webpart-Fehlermeldung.

clearError(domElement: HTMLElement): void;

Parameter

domElement

HTMLElement

das Div des Webpartcontainers.

Gibt zurück

void

clearLoadingIndicator(domElement)

Deaktiviert die Ladeanzeige.

clearLoadingIndicator(domElement: Element): void;

Parameter

domElement

Element

das Div des Webpartcontainers.

Gibt zurück

void

displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)

Zeigt eine Ladedrehfeld an.

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

Parameter

domElement

Element

das Div des Webpartcontainers.

loadingMessage

string

Die Nachricht, die angezeigt werden soll, wenn die ID des Ladedrehfelds angezeigt wird.

timeout

number

Timeout zum Rendern des Ladeindikators. Der Standardwert ist 1500 ms.

clearDomElementCallback
_ClearDomElementCallback

Rückruf zum Löschen des DOM-Knotens vor dem Rendern des Indikators. Die DOM-Standard-API wird nach dem Rückruf verwendet.

Gibt zurück

void

renderError(domElement, error, clearDomElementCallback)

Rendert die bereitgestellte Fehlermeldung im div-Webpartcontainer

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

Parameter

domElement

HTMLElement

das Div des Webpartcontainers.

error

Error | string

Fehlermeldung:

clearDomElementCallback
_ClearDomElementCallback

Rückruf, um den DOM-Knoten vor dem Rendern des Error-Elements zu löschen. Die DOM-Standard-API wird nach dem Rückruf verwendet.

Gibt zurück

void