ItemWidgetEventArgs Interface
In This Article
Provides data for events related to client widgets used to visualize data in dashboard items.
#Declaration
TypeScript
export interface ItemWidgetEventArgs extends ItemWidgetBaseEventArgs
#Remarks
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
TypeScript
getWidget: () => DevExpress.ui.Widget<any> | Element
#Property 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 get
- For the Pie
Item , getWidget returns an array of dxPie widgets.Chart - For the Gauge
Item , getWidget returns an array of dxCircular or dxGauge Linear widgets.Gauge