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	onItemWidgetCreated/onItemWidgetUpdated	onItemWidgetOptionsPrepared	onItemCaptionToolbarUpdated
DevExtreme-based Widgets
GridItem	dxDataGrid	dxDataGridOptions
ChartItem ScatterChartItem	dxChart	dxChartOptions
PieItem	an array of dxPieChart widgets	dxPieChartOptions (for each pie)
GaugeItem	an array of dxCircularGauge or dxLinearGauge widgets	dxCircularGaugeOptions or dxLinearGaugeOptions (for each gauge)
ChoroplethMapItem GeoPointMapItem PieMapItem BubbleMapItem	dxVectorMap	dxVectorMapOptions
PivotItem	dxPivotGrid	dxPivotGridOptions
ComboBoxItem	dxSelectBox dxTagBox	dxSelectBoxOptions dxTagBoxOptions
ListBoxItem	dxList	dxListOptions
TreeViewItem	dxTreeList dxTreeView (for v17.1 and earlier)	dxTreeListOptions dxTreeViewOptions (for v17.1 and earlier)
TreemapItem	dxTreeMap	dxTreeMapOptions
RangeFilterItem	dxRangeSelector	dxRangeSelectorOptions
Dashboard Build-in Components
CardItem	CardWidget
DateFilterItem	DateFilterWidget
TextBoxItem	HTML element / HTML element wrapped in a jQuery object
ImageItem	HTML element / HTML element wrapped in a jQuery object
BoundImageItem	HTML element / HTML element wrapped in a jQuery object
CustomItem	A custom widget. You can customize it directly.
Layout Items
GroupItem
DashboardTabPage
TabContainerItem

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

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.