ItemWidgetEventArgs Interface
Provides data for events related to client widgets used to visualize data in dashboard items.
Declaration
export interface ItemWidgetEventArgs extends ItemWidgetBaseEventArgsRemarks
The Web Dashboard uses DevExtreme widgets to visualize data within dashboard items. The ViewerApiExtensionOptions.onItemWidgetUpdated, ViewerApiExtensionOptions.onItemWidgetCreated, and ViewerApiExtensionOptions.onItemWidgetOptionsPrepared handlers allow you to access these widgets and customize their settings if necessary.
Inheritance
DashboardItemBaseEventArgs
ItemWidgetBaseEventArgs
ItemWidgetEventArgs
Properties
getWidget Property
Gets an underlying widget corresponding to the current dashboard item.
Declaration
getWidget: () => DevExpress.ui.Widget<any> | ElementProperty Value
| Type | Description |
|---|---|
| () => any | An underlying widget or an array of widgets. |
Remarks
See Component Configuration Syntax topic for information on how to work with the obtained widget.
Note
The getWidget property can return an array of widgets for some dashboard items:
- For the PieItem, getWidget returns an array of dxPieChart widgets.
- For the GaugeItem, getWidget returns an array of dxCircularGauge or dxLinearGauge widgets.