DataDashboardItem Class
Serves as the base class for data-bound dashboard items.
#Declaration
export abstract class DataDashboardItem extends DashboardItem implements IDataItemProvider, IMasterFilterItemsProvider, IColorSignaturesProvider, IDataSourceConsumer
#Implements
#Inherited Members
#Inheritance
#constructor
Initializes a new instance of the DataDashboardItem
class.
#Declaration
constructor(
dashboardItemJSON?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer,
info?: DevExpress.Dashboard.Metadata.IDashboardSerializationInfoArray
)
#Parameters
Name | Type | Description |
---|---|---|
dashboard |
any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
serializer | Model |
An object used for dashboard deserialization. Do not pass this parameter directly. |
info | IDashboard |
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
coloringOptions: DevExpress.Dashboard.Model.DashboardItemColoringOptions
#Property Value
Type | Description |
---|---|
Dashboard |
The Dashboard |
#colorScheme Property
#Declaration
colorScheme: ko.ObservableArray<DevExpress.Dashboard.Model.ColorSchemeEntry>
#Property Value
Type |
---|
Observable |
#dataItems Property
#Declaration
dataItems: ko.ObservableArray<DevExpress.Dashboard.Model.DataItem>
#Property Value
Type |
---|
Observable |
#dataMember Property
#Declaration
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
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.
var dataSource = dashboardControl.dashboard().findItem("gridSalesByState").dataSource();
#filterString Property
#Declaration
filterString: ko.Observable<string>
#Property Value
Type |
---|
Observable<string> |
#formatRules Property
#Declaration
formatRules: ko.ObservableArray<DevExpress.Dashboard.Model.DashboardItemFormatRule>
#Property Value
Type |
---|
Observable |
#hiddenDimensions Property
#Declaration
hiddenDimensions: ko.ObservableArray<DevExpress.Dashboard.Model.Dimension>
#Property Value
Type |
---|
Observable |
#hiddenMeasures Property
#Declaration
hiddenMeasures: ko.ObservableArray<DevExpress.Dashboard.Model.Measure>
#Property Value
Type |
---|
Observable |
#isDisposed Property
#Declaration
isDisposed: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#isMasterFilterCrossDataSource Property
#Declaration
isMasterFilterCrossDataSource: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#visibleDataFilterString Property
#Declaration
visibleDataFilterString: ko.Observable<string>
#Property Value
Type |
---|
Observable<string> |