ASPxClientDashboardItemWidgetEventArgs Class

Provides data for events related to client widgets used to visualize data in dashboard items.

Declaration

declare class ASPxClientDashboardItemWidgetEventArgs extends ASPxClientEventArgs

Remarks

The Web Dashboard uses DevExtreme widgets to visualize data within dashboard items. The ASPxClientDashboard.ItemWidgetCreated event allows you to access these widgets and customize their settings if necessary.

The ASPxClientDashboardItemWidgetEventArgs.ItemName property returns the component name of the dashboard item whose widget may be customized. Use the ASPxClientDashboardItemWidgetEventArgs.GetWidget method to access the corresponding underlying widget. You can change the widget setting or handle its events. To unsubscribe from widget events, handle the ASPxClientDashboard.ItemBeforeWidgetDisposed event.

The following table lists dashboard items for which access to client widgets is provided.

Dashboard Item	Underlying Widget(s)
GridItem	dxDataGrid
ChartItem ScatterChartItem	dxChart
PieItem	an array of dxPieChart widgets
GaugeItem	an array of dxCircularGauge or dxLinearGauge widgets
MapItem	dxVectorMap
PivotItem	dxPivotGrid
ComboBoxItem	dxSelectBox or dxTagBox
ListBoxItem	dxList
TreeViewItem	dxTreeList dxTreeView (for v17.1 and earlier)
TreemapItem	dxTreeMap
RangeFilterItem	dxRangeSelector
CardItem	CardWidget
DateFilterItem	DateFilterWidget
TextBoxItem	n/a See Note 1
ImageItem	n/a See Note 1
CustomItem	n/a See Note 2

¹ The content of the TextBoxDashboardItem and the ImageDashboardItem is an HTML element wrapped in a jQuery object.

² The CustomDashboardItem is a custom widget. You can customize it directly.

Inherited Members

constructor

Inheritance

ASPxClientEventArgs

ASPxClientDashboardItemWidgetEventArgs

Properties

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 ASPxClientDashboardItemWidgetEventArgs.GetWidget property to access the widget corresponding to the current dashboard item.

Methods

GetWidget Method

Returns an underlying widget corresponding to the current dashboard item.

Declaration

GetWidget(): any

Returns

Type	Description
any	An underlying widget.

Remarks

To learn how to configure the obtained widget, see the Working with Widgets topic.

Note

Note that the GetWidget method can return an array of widgets for some dashboard items.

• For the PieDashboardItem, GetWidget returns an array of dxPieChart widgets.
• For the GaugeDashboardItem, GetWidget returns an array of dxCircularGauge or dxLinearGauge widgets.