DataInspectorExtension Class

A Web Dashboard extension that is the Data Inspector.

Declaration

export class DataInspectorExtension extends DisposableObject implements IExtension

Remarks

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

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

Implements

IDisposable

IExtension

Inherited Members

dispose

Inheritance

DisposableObject

DataInspectorExtension

constructor(dashboardControl)

Initializes a new instance of the DataInspectorExtension class.

Declaration

constructor(
    dashboardControl: 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 a unique extension name.

Declaration

name: string

Property Value

Type	Description
string	A unique extension name. The return value is ‘data-inspector’.

Remarks

Warning

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

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