ItemWidgetEventArgs Interface
Provides data for events related to client widgets used to visualize data in dashboard items.
Declaration
export interface ItemWidgetEventArgs
Remarks
The Web Dashboard uses DevExtreme widgets to visualize data within dashboard items. The onItemWidgetUpdated / onItemWidgetCreated handlers allow you to access these widgets and customize their settings if necessary.
Properties
getWidget Property
Gets an underlying widget corresponding to the current dashboard item.
Declaration
getWidget: () => Widget | Element
Property Value
Type | Description |
---|---|
() => Widget | Element | An underlying widget that is used in the corresponding dashboard item. |
Remarks
To learn how to configure the obtained widget, see Working with Widgets topic.
Note
The getWidget property can return an array of widgets for some dashboard items:
- For the pieDashboardItem, getWidget returns an array of PieChart widgets.
- For the gaugeDashboardItem, getWidget returns an array of CircularGauge or LinearGauge widgets.
itemName Property
Gets the component name of the dashboard item for which the event was raised.
Declaration
itemName: string
Property Value
Type | Description |
---|---|
string | A string value that is the component name of the dashboard item. |
Remarks
Use the getWidget property to access the widget corresponding to the current dashboard item.