ASPxClientDashboardItemWidgetEventArgs Class

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

Namespace: DevExpress.DashboardWeb.Scripts

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.Scripts.dll

Declaration

public class ASPxClientDashboardItemWidgetEventArgs :
    ASPxClientEventArgs
Public Class ASPxClientDashboardItemWidgetEventArgs
    Inherits ASPxClientEventArgs

The Web Dashboard and Web Viewer uses DevExtreme widgets to visualize data within dashboard items. The ASPxClientDashboard.ItemWidgetCreated / ASPxClientDashboardViewer.ItemWidgetCreated events allow 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 / ASPxClientDashboardViewer.ItemBeforeWidgetDisposed events.

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

Dashboard Item

Underlying Widget(s)

GridDashboardItem

dxDataGrid

ChartDashboardItem

ScatterChartDashboardItem

dxChart

PieDashboardItem

an array of dxPieChart widgets

GaugeDashboardItem

an array of dxCircularGauge or dxLinearGauge widgets

MapDashboardItem

dxVectorMap

PivotDashboardItem

dxPivotGrid

ComboBoxDashboardItem

dxSelectBox or dxTagBox

ListBoxDashboardItem

dxList

TreeViewDashboardItem

dxTreeList

Note

Note that the dxTreeView widget is used in v17.1 and earlier.

TreemapDashboardItem

dxTreeMap

RangeFilterDashboardItem

dxRangeSelector

CardDashboardItem

CardWidget

TextBoxDashboardItem

n/a See Note

ImageDashboardItem

n/a See Note

CustomDashboardItem

n/a See Note

Note

The content of the TextBoxDashboardItem and ImageDashboardItem are an HTML element wrapped to a jQuery object.

Note

The CustomDashboardItem is a custom widget you can customize directly.

Inheritance

Object
ASPxClientDashboardItemWidgetEventArgs

See Also