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

IDataItemProvider

IMasterFilterItemsProvider

IColorSignaturesProvider

IDataSourceConsumer

Inherited Members

componentName

customProperties

disposed

itemType

name

parentContainer

showCaption

dispose

getInfo

getUniqueNamePrefix

Inheritance

Show 15 items

SerializableModel

TypedSerializableModel

DashboardItem

DataDashboardItem

FilterElementItemBase

SeriesItem

DateFilterItem

GridItem

MapItem

PivotItem

ScatterChartItem

BoundImageItem

TextBoxItem

TreemapItem

CustomItem

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

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

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

Property Value

Type
ObservableArray<ColorSchemeEntry>

dataItems Property

Declaration

dataItems: ko.ObservableArray<DevExpress.Dashboard.Model.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<DevExpress.Dashboard.Model.DashboardItemFormatRule>

Property Value

Type
ObservableArray<DashboardItemFormatRule>

hiddenDimensions Property

Declaration

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

Property Value

Type
ObservableArray<Dimension>

hiddenMeasures Property

Declaration

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

Property Value

Type
ObservableArray<Measure>

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>