Optional
properties: WidgetProperties & { showDownload?: boolean }Optional
showDownload?: booleanShow download button.
Icon which represents the widget.
The unique ID assigned to the widget when the widget is created.
The widget's label.
Indicates whether the widget is visible.
The ID or node representing the DOM element containing the widget.
The ID or node representing the DOM element containing the widget.
Protected
_Protected
_Optional
groupKey: Exclude<T, IHandle>A utility method used for building the value for a widget's class
property.
The class names.
Destroys the widget instance.
Download an image (or any data url file).
File name to be downloaded
Data url
Emits an event on the instance.
The name of the event.
Optional
event: anyThe event payload.
Indicates whether there is an event listener on the instance that matches the provided event name.
The name of the event.
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
isRejected()
may be used to verify if creating an instance of the class is rejected.
isResolved()
may be used to verify if creating an instance of the class is resolved.
Protected
notifyRegisters an event handler on the instance.
An event or an array of events to listen for.
The function to call when the event fires.
Executes after widget is ready for rendering.
This method is implemented by subclasses for rendering.
Renders widget to the DOM immediately.
Schedules widget rendering.
Show image in modal.
File name of image
Data url
Optional
sync: booleanwhen()
may be leveraged once an instance of the class is created.
Optional
callback: FunctionThe function to call when the promise resolves.
Optional
errback: FunctionThe function to execute when the promise fails.
Modal dialog for viewing and downloading images.