DataItemContainer Class

Serves as the base class for data item containers.

Declaration

export abstract class DataItemContainer extends TypedSerializableModel implements IBindingModelProvider, ICustomPropertiesProvider

Remarks

In most scenarios, dashboard items use collections of data items (DataItem) to define their data bindings. In more advanced cases, dashboard items require a collection of data item sets (pairs) to bind to data. For instance, dashboard items that calculate the difference between two measurements need a collection of measurement pairs.

DataItemContainer class descendants implement these data item sets.

The image below shows the Sales vs Target data item container that calculates the difference between two measures – Sales and SalesTarget:

Implements

IBindingModelProvider

ICustomPropertiesProvider

Inherited Members

constructor

disposed

itemType

Inheritance

SerializableModel

TypedSerializableModel

DataItemContainer

ChartSeries

KpiElement

GridColumn

ChoroplethMap

Properties

customProperties Property

Gets custom properties available for the current data item container.

Declaration

customProperties: DevExpress.Dashboard.Model.CustomProperties

Property Value

Type	Description
CustomProperties	A CustomProperties object that provides access to the data item container’s custom properties.

Remarks

Tip

Documentation: Custom Properties

name Property

Declaration

name: ko.Observable<string>

Property Value

Type
Observable<string>

Methods

getInfo Method

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type
ISerializationInfoArray

grabFrom(dataItemContainer) Method

Declaration

grabFrom(
    dataItemContainer: DataItemContainer
): void

Parameters

Name	Type
dataItemContainer	DataItemContainer