IConfigurableWidget interface

Balíček:

azure-devops-extension-api

Konfigurovatelné widgety implementují toto rozhraní.

Extends

IWidget

Vlastnosti

reload

Po změně zobrazení konfigurace se očekává, že widget aktualizuje zobrazení.

Zděděné vlastnosti

disableWidgetForStakeholders	Architektura volá tuto metodu, aby určila, jestli má být widget zakázán pro uživatele s licencí účastníka.
lightbox	Spuštění widgetu v režimu lightboxed
listen	Naslouchání zprávě z hostitele
load	Widgety používají k dokončení vykreslování nastavení poskytnutá i volání na straně serveru. V budoucnu se očekává, že widgety budou poskytovat prostředí načítání, zatímco se čekají na dokončení volání. Do té doby bude hostitel widgetu poskytovat prostředí načítání.
onDashboardLoaded	Widgety spravují všechny operace, které nejsou nezbytné pro počáteční načtení, ale vyžadují se pro úplné prostředí widgetu.
preload	widgety používají nastavení, která jsou k dispozici spolu s daty uloženými v mezipaměti, které mohou muset nakreslit interaktivní stav. Widget by neměl provádět žádná síťová volání.

Podrobnosti vlastnosti

reload

Po změně zobrazení konfigurace se očekává, že widget aktualizuje zobrazení.

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

Hodnota vlastnosti

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Podrobnosti zděděných vlastností

disableWidgetForStakeholders

Architektura volá tuto metodu, aby určila, jestli má být widget zakázán pro uživatele s licencí účastníka.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<boolean>

zděděné zIWidget.disableWidgetForStakeholders

lightbox

Spuštění widgetu v režimu lightboxed

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

Hodnota vlastnosti

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

zděděno zIWidget.lightbox

listen

Naslouchání zprávě z hostitele

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

Hodnota vlastnosti

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

zděděno zIWidget.listen

load

Widgety používají k dokončení vykreslování nastavení poskytnutá i volání na straně serveru. V budoucnu se očekává, že widgety budou poskytovat prostředí načítání, zatímco se čekají na dokončení volání. Do té doby bude hostitel widgetu poskytovat prostředí načítání.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

zděděno zIWidget.load

onDashboardLoaded

Widgety spravují všechny operace, které nejsou nezbytné pro počáteční načtení, ale vyžadují se pro úplné prostředí widgetu.

onDashboardLoaded?: () => void

Hodnota vlastnosti

() => void

zděděné zIWidget.onDashboardLoaded

preload

widgety používají nastavení, která jsou k dispozici spolu s daty uloženými v mezipaměti, které mohou muset nakreslit interaktivní stav. Widget by neměl provádět žádná síťová volání.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

zděděno zIWidget.preload