DataInspectorExtensionOptions Interface

Provides options for customizing the DataInspectorExtension.

Declaration

export interface DataInspectorExtensionOptions

Remarks

See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview

You can enable export to Excel. See Export Data for details.

Properties

allowInspectAggregatedData Property

Specifies whether to display aggregated data in the Data Inspector.

Declaration

allowInspectAggregatedData?: boolean

Property Value

Type	Description
boolean	true, to display aggregated data in the Data Inspector; otherwise, false.

Remarks

Set the allowInspectRawData property to true to display raw data in the Data Inspector.

When both properties are true, each dashboard item caption contains the “Inspect Data” button. Click the button to invoke the Data Inspector window that contains two grids with raw and aggregated data. The window caption displays the dashboard item caption text.

When only one property is true, the window contains a single grid with raw or aggregated data, depending on what property is switched on. The window caption displays the dashboard item caption text and the inspected item type (raw or aggregated) in parentheses.

allowInspectRawData Property

Specifies whether to display raw data in the Data Inspector.

Declaration

allowInspectRawData?: boolean

Property Value

Type	Description
boolean	true, to display raw data in the Data Inspector; otherwise, false.

Remarks

Set the allowInspectAggregatedData property to true to display aggregated data in the Data Inspector.

When both properties are true, each dashboard item caption contains the “Inspect Data” button. Click the button to invoke the Data Inspector window that contains two grids with raw and aggregated data. The window caption displays the dashboard item caption text.

When only one property is true, the window contains a single grid with raw or aggregated data, depending on what property is switched on. The window caption displays the dashboard item caption text and the inspected item type (raw or aggregated) in parentheses.

onDialogHidden Property

A handler for the event occurring when the Data Inspector dialog is hidden.

Declaration

onDialogHidden?: (args: DataInspectorDialogArgs) => void

Property Value

Type	Description
(args: DataInspectorDialogArgs) => void	A function that is executed when the export dialog is hidden.

onDialogShowing Property

A handler for the event occurring before the Data Inspector dialog is shown.

Declaration

onDialogShowing?: (args: DataInspectorDialogArgs) => void

Property Value

Type	Description
(args: DataInspectorDialogArgs) => void	A function that is executed before the Data Inspector dialog is shown.

onDialogShown Property

A handler for the event occurring after the Data Inspector dialog is shown.

Declaration

onDialogShown?: (args: DataInspectorDialogArgs) => void

Property Value

Type	Description
(args: DataInspectorDialogArgs) => void	A function that is executed after the Data Inspector dialog is shown.

onGridContentReady Property

A handler for the event occurring after the Grid widget’s content is loaded.

Declaration

onGridContentReady?: (args: DataInspectorGridArgs) => void

Property Value

Type	Description
(args: DataInspectorGridArgs) => void	A function that is executed after the Grid widget’s content is loaded.

Remarks

The Data Inspector uses the DevExtreme DataGrid to display raw or aggregated data. Use the component property to obtain the DataGrid instance. The following code snippet shows how to change the DataGrid options (hide the “CategoryName” column):

function onGridContentReady(args) {
    args.component.columnOption("CategoryName", "visible", false);
}

onGridInitialized Property

A handler for the event occurring before the Grid widget’s content is loaded.

Declaration

onGridInitialized?: (args: DataInspectorGridArgs) => void

Property Value

Type	Description
(args: DataInspectorGridArgs) => void	A function used in JavaScript frameworks to save the widget instance.

Remarks

The Data Inspector uses the DevExtreme DataGrid to display raw or aggregated data. Use the component property to obtain the dxGrid instance. The following code snippet shows how to change the DataGrid options (enable export to Excel):

Control

extensions:{
    "dataInspector": {
        allowInspectAggregatedData: true,
        allowInspectRawData: true,
        onGridInitialized: onGridInitialized
    }
}

Script

function onGridInitialized(args) {
    args.component.option({
        export: {
            enabled: true
        }
    });
}

Note that client-side export in the DataGrid widget requires the ExcelJS v4+ and FileSaver third-party libraries.