DataInspectorExtension Class

A Web Dashboard extension that is the Data Inspector.

Declaration

export class DataInspectorExtension extends DisposableObject implements ISupportOptionExtension<DataInspectorExtensionOptions>

Remarks

To configure the extension, refer to the DataInspectorExtensionOptions class that contains Data Inspector settings.

For more information on how to enable and customize Data Inspector, refer to the following articles based on the platform:

• Manage Data Inspector in the Dashboard Control for JavaScript Applications
• Manage Data Inspector in the ASP.NET Core Dashboard Control
• Manage Data Inspector in the ASP.NET MVC Dashboard Extension
• Manage Data Inspector in the ASP.NET Web Forms Dashboard Control

You can enable export to Excel. Refer to the following topic for details: Export Data.

Implements

ISupportOptionExtension

Inherited Members

dispose

Inheritance

DisposableObject

DataInspectorExtension

constructor(dashboardControl)

Initializes a new instance of the DataInspectorExtension class.

Declaration

constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl,
    options?: DataInspectorExtensionOptions
)

Parameters

Name	Type	Description
dashboardControl	DashboardControl	A Web Dashboard control that owns the extension.
options	DataInspectorExtensionOptions	A DataInspectorExtensionOptions object that contains the extension options.

Properties

name Property

Specifies the unique extension name.

Declaration

name: string

Property Value

Type	Description
string	The unique extension name. The return value is dataInspector.

Remarks

Use the dataInspector name in the following cases:

• Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
• Call the control’s option method to change the extension options.

Warning

Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.

off Property

Unsubscribes from the DataInspectorExtension’s events.

Declaration

off: DevExpress.Dashboard.Internal.EventSubscriber<DataInspectorExtensionEvents>

Property Value

Type	Description
EventSubscriber<DataInspectorExtensionEvents>	An event subscription.

on Property

Subscribes to DataInspectorExtension events.

Declaration

on: DevExpress.Dashboard.Internal.EventSubscriber<DataInspectorExtensionEvents>

Property Value

Type	Description
EventSubscriber<DataInspectorExtensionEvents>	An event subscription.

Remarks

The extension’s on and off methods help you subscribe to and unsubscribe from events.

Methods

currentInspectedType Method

Identifies the data type in the Data Inspector.

Declaration

currentInspectedType(): InspectedType

Returns

Type	Description
InspectedType	A InspectedType object that defines the displayed underlying data.

hideDataInspector Method

Hides the invoked Data Inspector dialog.

Declaration

hideDataInspector(): void

Remarks

Use the DataInspectorExtension.showDataInspector method to invoke the Data Inspector dialog.

showDataInspector(dashboardItemName) Method

Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.

Declaration

showDataInspector(
    dashboardItemName: string,
    inspectedType?: InspectedType
): void

Parameters

Name	Type	Description
dashboardItemName	string	A string that specifies a component name of the dashboard item for which the Data Inspector displays data.
inspectedType	InspectedType	A InspectedType object that defines the displayed underlying data.

Remarks

Use the DataInspectorExtension.hideDataInspector method to invoke the Data Inspector dialog.

start Method

Contains code that is executed when you register the dashboard extension.

Declaration

start(): void

stop Method

Contains code that is executed when you unregister the dashboard extension.

Declaration

stop(): void