The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

GridDimensionColumn Class

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.

Inheritance

GridColumn
GridDimensionColumn

constructor(dataItemProvider)

Declaration

constructor(dataItemProvider: DataDashboardItem, dashboardItemJSON?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer)

Parameters

Name Type Description
dataItemProvider DataDashboardItem

Optional Parameters

Type Name Default Description
any dashboardItemJSON null

A JSON object used for a dashboard deserialization. Do not pass this parameter directly.

DxDesigner.Analytics.Utils.ModelSerializer serializer null

An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

dimension Property

Specifies a dimension that provides cell values.

Declaration

dimension: KnockoutObservable<Dimension>

Property Value

Type Description
KnockoutObservable<Dimension>

A Dimension object specifying a dimension that provides cell values.

displayMode Property

Specifies how to display cell values.

Declaration

displayMode: KnockoutObservable<GridDimensionColumnDisplayMode>

Property Value

Type Description
KnockoutObservable<GridDimensionColumnDisplayMode>

A GridDimensionColumnDisplayMode enumeration member that specifies how to display cell values.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo