Skip to main content

DataDashboardItem Class

Serves as the base class for data-bound dashboard items.

#Declaration

TypeScript
export abstract class DataDashboardItem extends DashboardItem implements IDataItemProvider, IMasterFilterItemsProvider, IColorSignaturesProvider, IDataSourceConsumer

#Implements

IDataItemProvider
IMasterFilterItemsProvider
IColorSignaturesProvider
IDataSourceConsumer

#constructor

Initializes a new instance of the DataDashboardItem class.

#Declaration

TypeScript
constructor(
    dashboardItemJSON?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer,
    info?: DevExpress.Dashboard.Metadata.IDashboardSerializationInfoArray
)

#Parameters

Name Type Description
dashboardItemJSON any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

info IDashboardSerializationInfoArray

An array of objects that provide serialization info.

#Properties

#coloringOptions Property

Provides access to coloring options of the data dashboard items that support coloring.

#Declaration

TypeScript
coloringOptions: DevExpress.Dashboard.Model.DashboardItemColoringOptions

#Property Value

Type Description
DashboardItemColoringOptions

The DashboardItemColoringOptions object that contains coloring options of the data dashboard items that support coloring.

#colorScheme Property

#Declaration

TypeScript
colorScheme: ko.ObservableArray<DevExpress.Dashboard.Model.ColorSchemeEntry>

#Property Value

Type
ObservableArray<ColorSchemeEntry>

#dataItems Property

#Declaration

TypeScript
dataItems: ko.ObservableArray<DevExpress.Dashboard.Model.DataItem>

#Property Value

Type
ObservableArray<DataItem>

#dataMember Property

#Declaration

TypeScript
dataMember: ko.Observable<string>

#Property Value

Type
Observable<string>

#dataSource Property

Gets a data source name to which the current dashboard item is bound.

#Declaration

TypeScript
dataSource: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string that is a data source name.

#Remarks

The following code snippet shows how to obtain a data source name for a Grid dashboard item. The Dashboard.findItem method is used to define the Grid by its componentName.

javascript
var dataSource = dashboardControl.dashboard().findItem("gridSalesByState").dataSource();

#filterString Property

#Declaration

TypeScript
filterString: ko.Observable<string>

#Property Value

Type
Observable<string>

#formatRules Property

#Declaration

TypeScript
formatRules: ko.ObservableArray<DevExpress.Dashboard.Model.DashboardItemFormatRule>

#Property Value

Type
ObservableArray<DashboardItemFormatRule>

#hiddenDimensions Property

#Declaration

TypeScript
hiddenDimensions: ko.ObservableArray<DevExpress.Dashboard.Model.Dimension>

#Property Value

Type
ObservableArray<Dimension>

#hiddenMeasures Property

#Declaration

TypeScript
hiddenMeasures: ko.ObservableArray<DevExpress.Dashboard.Model.Measure>

#Property Value

Type
ObservableArray<Measure>

#isDisposed Property

#Declaration

TypeScript
isDisposed: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#isMasterFilterCrossDataSource Property

#Declaration

TypeScript
isMasterFilterCrossDataSource: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#visibleDataFilterString Property

#Declaration

TypeScript
visibleDataFilterString: ko.Observable<string>

#Property Value

Type
Observable<string>