GridDimensionColumn Class

A dimension column in a GridItem.

Declaration

export class GridDimensionColumn extends GridColumn

Remarks

This column displays grouped values from the bound data item and allows you to provide discrete categorical information.

A dimension column accepts values of any type:

Type	Example	Description
string		Displays string values.
numeric		Displays numeric (integer or float) values.
date		Displays date-time values. For these values, you can change a group interval. Open the relevant data item’s menu and use the Group Interval property in the Binding group.
boolean		Displays boolean values as true or false.
object		The dimension column can display images if it is bound to a data source containing images. You can choose whether the dimension column shows data as images or text (strings that encode images in the base64 format). To do this, open the relevant data item’s menu and use the Display Mode property in the Options group.

Use the GridDimensionColumn.dimension property to specify the dimensions to which the column is bound.

If the bound dimension contains image data, the dimension column can display images. Set the GridDimensionColumn.displayMode property to Image to specify that the column should display images.

Inherited Members

customProperties

disposed

fixedWidth

itemType

name

totals

weight

widthType

actualDataItem

dispose

getInfo

grabFrom(column)

Inheritance

SerializableModel

TypedSerializableModel

DataItemContainer

GridColumn

GridDimensionColumn

constructor(dataItemProvider)

Initializes a new instance of the GridDimensionColumn class with specified settings.

Declaration

constructor(
    dataItemProvider: DevExpress.Dashboard.Model.DataDashboardItem,
    dashboardItemJSON?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

Parameters

Name	Type	Description
dataItemProvider	DataDashboardItem
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.

Properties

dimension Property

Specifies a dimension that provides cell values.

Declaration

dimension: ko.Observable<DevExpress.Dashboard.Model.Dimension>

Property Value

Type	Description
Observable<Dimension>	A Dimension object specifying a dimension that provides cell values.

displayMode Property

Specifies how to display cell values.

Declaration

displayMode: ko.Observable<DevExpress.Dashboard.Model.GridDimensionColumnDisplayMode>

Property Value

Type	Description
Observable<GridDimensionColumnDisplayMode>	A GridDimensionColumnDisplayMode enumeration member that specifies how to display cell values.