IWidget interface
All widgets implement this interface
| disable |
The framework calls this method to determine if the widget should be disabled for users with stakeholder license |
| lightbox | Run widget in lightboxed mode |
| listen | Listen to message from host |
| load | Widgets use the settings provided as well as server side calls to complete their rendering experience. In the future, widgets are expected to provide a loading experience while the calls are being waited to be completed. Until then, the widget host will provide the loading experience |
| on |
Widgets manage any operations that are not necessary for initial load but are required for the full widget experience. |
| preload | widgets use the settings provided along with the any cached data they may have to paint an interactive state. No network calls should be made by the widget. |
The framework calls this method to determine if the widget should be disabled for users with stakeholder license
disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>Property Value
(widgetSettings: WidgetSettings) => Promise<boolean>
Run widget in lightboxed mode
lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>Property Value
(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>
Listen to message from host
listen?: (event: string, eventArgs: EventArgs<T>) => voidProperty Value
(event: string, eventArgs: EventArgs<T>) => void
Widgets use the settings provided as well as server side calls to complete their rendering experience. In the future, widgets are expected to provide a loading experience while the calls are being waited to be completed. Until then, the widget host will provide the loading experience
load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>Property Value
(widgetSettings: WidgetSettings) => Promise<WidgetStatus>
Widgets manage any operations that are not necessary for initial load but are required for the full widget experience.
onDashboardLoaded?: () => voidProperty Value
() => void
widgets use the settings provided along with the any cached data they may have to paint an interactive state. No network calls should be made by the widget.
preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>Property Value
(widgetSettings: WidgetSettings) => Promise<WidgetStatus>