IConfigurableWidget interface
構成可能なウィジェットは、このインターフェイスを実装します
- Extends
プロパティ
reload | 構成ビューが変更されると、ウィジェットはそのビューを更新する必要があります。 |
継承されたプロパティ
disable |
フレームワークは、このメソッドを呼び出して、利害関係者ライセンスを持つユーザーに対してウィジェットを無効にする必要があるかどうかを判断します |
lightbox | ライトボックス モードでウィジェットを実行する |
listen | ホストからのメッセージをリッスンする |
load | ウィジェットでは、提供された設定とサーバー側の呼び出しを使用して、レンダリング エクスペリエンスを完了します。 今後、ウィジェットは、呼び出しの完了を待機している間に読み込みエクスペリエンスを提供することが期待されます。 それまでは、ウィジェット ホストによって読み込みエクスペリエンスが提供されます |
on |
ウィジェットは、初期読み込みに必要ないが、完全なウィジェット エクスペリエンスに必要なすべての操作を管理します。 |
preload | ウィジェットは、提供された設定と、対話型の状態を描画するために必要なキャッシュされたデータを使用します。 ウィジェットでネットワーク呼び出しを行う必要はありません。 |
プロパティの詳細
reload
構成ビューが変更されると、ウィジェットはそのビューを更新する必要があります。
reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>
プロパティ値
(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>
継承されたプロパティの詳細
disableWidgetForStakeholders
フレームワークは、このメソッドを呼び出して、利害関係者ライセンスを持つユーザーに対してウィジェットを無効にする必要があるかどうかを判断します
disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>
プロパティ値
(widgetSettings: WidgetSettings) => Promise<boolean>
lightbox
ライトボックス モードでウィジェットを実行する
lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>
プロパティ値
(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>
listen
ホストからのメッセージをリッスンする
listen?: (event: string, eventArgs: EventArgs<T>) => void
プロパティ値
(event: string, eventArgs: EventArgs<T>) => void
load
ウィジェットでは、提供された設定とサーバー側の呼び出しを使用して、レンダリング エクスペリエンスを完了します。 今後、ウィジェットは、呼び出しの完了を待機している間に読み込みエクスペリエンスを提供することが期待されます。 それまでは、ウィジェット ホストによって読み込みエクスペリエンスが提供されます
load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>
プロパティ値
(widgetSettings: WidgetSettings) => Promise<WidgetStatus>
IWidget.load から継承
onDashboardLoaded
ウィジェットは、初期読み込みに必要ないが、完全なウィジェット エクスペリエンスに必要なすべての操作を管理します。
onDashboardLoaded?: () => void
プロパティ値
() => void
preload
ウィジェットは、提供された設定と、対話型の状態を描画するために必要なキャッシュされたデータを使用します。 ウィジェットでネットワーク呼び出しを行う必要はありません。
preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>
プロパティ値
(widgetSettings: WidgetSettings) => Promise<WidgetStatus>