IClientSideWebPartStatusRenderer interface
Web パーツの読み込みインジケーターとエラー メッセージを表示するコンポーネントによって実装されるインターフェイス。
メソッド
| clear |
Web パーツのエラー メッセージを解除します。 |
| clear |
読み込みインジケーターを解除します。 |
| display |
読み込みスピナーを表示します。 |
| render |
Web パーツのコンテナーの div に提供されたエラー メッセージを表示します。 |
メソッドの詳細
clearError(domElement)
Web パーツのエラー メッセージを解除します。
clearError(domElement: HTMLElement): void;パラメーター
- domElement
-
HTMLElement
Web パーツ コンテナー div。
戻り値
void
clearLoadingIndicator(domElement)
読み込みインジケーターを解除します。
clearLoadingIndicator(domElement: Element): void;パラメーター
- domElement
-
Element
Web パーツ コンテナー div。
戻り値
void
displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)
読み込みスピナーを表示します。
displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number, clearDomElementCallback?: ClearDomElementCallback): void;パラメーター
- domElement
-
Element
Web パーツ コンテナー div。
- loadingMessage
-
string
読み込みスピナーの ID が表示されたときに表示されるメッセージ。
- timeout
-
number
読み込みインジケーターの表示のタイムアウト。 既定値は 1500 ミリ秒です。
- clearDomElementCallback
- @microsoft/sp-webpart-base!~ClearDomElementCallback:type
インジケーターをレンダリングする前に dom ノードをクリアするためのコールバック。 標準 DOM API は、コールバックの後に使用されます。
戻り値
void
renderError(domElement, error, clearDomElementCallback)
Web パーツのコンテナーの div に提供されたエラー メッセージを表示します。
renderError(domElement: HTMLElement, error: Error | string, clearDomElementCallback?: ClearDomElementCallback): void;パラメーター
- domElement
-
HTMLElement
Web パーツ コンテナー div。
- error
-
Error | string
エラー メッセージ。
- clearDomElementCallback
- @microsoft/sp-webpart-base!~ClearDomElementCallback:type
エラー要素をレンダリングする前に dom ノードをクリアするためのコールバック。 標準 DOM API は、コールバックの後に使用されます。
戻り値
void