DataDashboardItem Class

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

Declaration

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

Inherited Members

DevExpress.Dashboard.Model.DataDashboardItem.componentName

itemType

DevExpress.Dashboard.Model.DataDashboardItem.name

DevExpress.Dashboard.Model.DataDashboardItem.parentContainer

DevExpress.Dashboard.Model.DataDashboardItem.showCaption

DevExpress.Dashboard.Model.DataDashboardItem.getUniqueNamePrefix

Inheritance

Show 12 items

DataDashboardItem

CustomItem

SeriesItem

BoundImageItem

TreemapItem

TextBoxItem

ScatterChartItem

DateFilterItem

PivotItem

MapItem

GridItem

FilterElementItemBase

constructor

Initializes a new instance of the DataDashboardItem class.

Declaration

constructor(
    dashboardItemJSON?: any,
    serializer?: DxDesigner.Analytics.Utils.ModelSerializer,
    info?: DxDesigner.Analytics.Utils.ISerializationInfoArray
)

Parameters

Name	Type	Description
dashboardItemJSON	any	A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.
info	DxDesigner.Analytics.Utils.ISerializationInfoArray

Properties

coloringOptions Property

Declaration

coloringOptions: DashboardItemColoringOptions

Property Value

Type
DashboardItemColoringOptions

colorScheme Property

Declaration

colorScheme: ko.ObservableArray<ColorSchemeEntry>

Property Value

Type
ObservableArray<ColorSchemeEntry>

dataItems Property

Declaration

dataItems: ko.ObservableArray<DataItem>

Property Value

Type
ObservableArray<DataItem>

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<DashboardItemFormatRule>

Property Value

Type
ObservableArray<DashboardItemFormatRule>

hiddenDimensions Property

Declaration

hiddenDimensions: ko.ObservableArray<Dimension>

Property Value

Type
ObservableArray<Dimension>

hiddenMeasures Property

Declaration

hiddenMeasures: ko.ObservableArray<Measure>

Property Value

Type
ObservableArray<Measure>

isMasterFilterCrossDataSource Property

Declaration

isMasterFilterCrossDataSource: ko.Observable<boolean>

Property Value

Type
Observable<boolean>