IConfigurableWidget interface

Pakiet:

azure-devops-extension-api

Konfigurowalne widżety implementują ten interfejs

Rozszerzenie

IWidget

Właściwości

reload

Po zmianie widoku konfiguracji widżet powinien zaktualizować jego widok.

Właściwości dziedziczone

disableWidgetForStakeholders	Struktura wywołuje tę metodę, aby określić, czy widżet powinien być wyłączony dla użytkowników z licencją uczestników projektu
lightbox	Uruchamianie widżetu w trybie lightboxed
listen	Nasłuchiwanie komunikatu z hosta
load	Widżety używają podanych ustawień, a także wywołań po stronie serwera w celu ukończenia renderowania. W przyszłości oczekuje się, że widżety zapewnią środowisko ładowania podczas oczekiwania na ukończenie wywołań. Do tego czasu host widżetu zapewni środowisko ładowania
onDashboardLoaded	Widżety zarządzają wszystkimi operacjami, które nie są niezbędne do początkowego ładowania, ale są wymagane w przypadku pełnego środowiska widżetu.
preload	widżety korzystają z podanych ustawień wraz ze wszystkimi buforowanymi danymi, które mogą wymagać malowania stanu interaktywnego. Widżet nie powinien wykonać żadnych wywołań sieciowych.

Szczegóły właściwości

reload

Po zmianie widoku konfiguracji widżet powinien zaktualizować jego widok.

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Wartość właściwości

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Szczegóły właściwości dziedziczonej

disableWidgetForStakeholders

Struktura wywołuje tę metodę, aby określić, czy widżet powinien być wyłączony dla użytkowników z licencją uczestników projektu

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

Wartość właściwości

(widgetSettings: WidgetSettings) => Promise<boolean>

dziedziczone zIWidget.disableWidgetForStakeholders

lightbox

Uruchamianie widżetu w trybie lightboxed

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

Wartość właściwości

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

dziedziczone zIWidget.lightbox

listen

Nasłuchiwanie komunikatu z hosta

listen?: (event: string, eventArgs: EventArgs<T>) => void

Wartość właściwości

(event: string, eventArgs: EventArgs<T>) => void

dziedziczone zIWidget.listen

load

Widżety używają podanych ustawień, a także wywołań po stronie serwera w celu ukończenia renderowania. W przyszłości oczekuje się, że widżety zapewnią środowisko ładowania podczas oczekiwania na ukończenie wywołań. Do tego czasu host widżetu zapewni środowisko ładowania

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Wartość właściwości

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

dziedziczone zIWidget.load

onDashboardLoaded

Widżety zarządzają wszystkimi operacjami, które nie są niezbędne do początkowego ładowania, ale są wymagane w przypadku pełnego środowiska widżetu.

onDashboardLoaded?: () => void

Wartość właściwości

() => void

dziedziczone zIWidget.onDashboardLoaded

preload

widżety korzystają z podanych ustawień wraz ze wszystkimi buforowanymi danymi, które mogą wymagać malowania stanu interaktywnego. Widżet nie powinien wykonać żadnych wywołań sieciowych.

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Wartość właściwości

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

dziedziczone zIWidget.preload