IClientSideWebPartStatusRenderer interface

Paquete:

@microsoft/sp-webpart-base

Interfaz que va a implementar un componente que debe mostrar el indicador de carga y los mensajes de error de un elemento web.

Métodos

clearError(domElement)	Borra el mensaje de error del elemento web.
clearLoadingIndicator(domElement)	Borra el indicador de carga.
displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)	Muestra un indicador giratorio de carga.
renderError(domElement, error, clearDomElementCallback)	Representa el mensaje de error proporcionado en el div de contenedor del elemento web.

Detalles del método

clearError(domElement)

Borra el mensaje de error del elemento web.

clearError(domElement: HTMLElement): void;

Parámetros

domElement

HTMLElement

el elemento web contenedor div.

Devoluciones

void

clearLoadingIndicator(domElement)

Borra el indicador de carga.

clearLoadingIndicator(domElement: Element): void;

Parámetros

domElement

Element

el elemento web contenedor div.

Devoluciones

void

displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)

Muestra un indicador giratorio de carga.

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

Parámetros

domElement

Element

el elemento web contenedor div.

loadingMessage

string

Mensaje que se mostrará cuando aparezca el indicador giratorio de carga.

timeout

number

Tiempo de espera para representar el indicador de carga. El valor predeterminado es 1500 ms.

clearDomElementCallback

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

Devolución de llamada para borrar el nodo dom antes de representar el indicador. La API DOM estándar se usará después de la devolución de llamada.

Devoluciones

void

renderError(domElement, error, clearDomElementCallback)

Representa el mensaje de error proporcionado en el div de contenedor del elemento web.

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

Parámetros

domElement

HTMLElement

el elemento web contenedor div.

error

Error | string

Mensaje de error.

clearDomElementCallback

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

Devolución de llamada para borrar el nodo dom antes de representar el elemento de error. La API DOM estándar se usará después de la devolución de llamada.

Devoluciones

void