ItemWidgetEventArgs Interface

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

Declaration

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

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

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: