Skip to main content

Dimension Class

A dimension that is a DataItem whose values are used to categorize data.

#Declaration

TypeScript
export class Dimension extends DataItem implements IDimensionDefinition

#Implements

IDimensionDefinition
See Also

#constructor

Initializes a new instance of the Dimension class.

#Declaration

TypeScript
constructor(
    dataItemJSON?: any,
    serializer?: DevExpress.Analytics.Utils.IModelSerializer
)

#Parameters

Name Type
dataItemJSON any
serializer IModelSerializer

#Properties

#coloringMode Property

Specifies coloring mode for the current dimension.

#Declaration

TypeScript
coloringMode: ko.Observable<DevExpress.Dashboard.Model.ColoringMode>

#Property Value

Type Description
Observable<ColoringMode>

A value that specifies a coloring mode for the current dimension.

#dateTimeGroupInterval Property

Specifies the group interval for date-time dimensions.

#Declaration

TypeScript
dateTimeGroupInterval: ko.Observable<DevExpress.Dashboard.Model.DateTimeGroupInterval>

#Property Value

Type Description
Observable<DateTimeGroupInterval>

The DateTimeGroupInterval value that specifies the group interval for date-time dimensions.

#groupChildValues Property

#Declaration

TypeScript
groupChildValues: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#groupIndex Property

#Declaration

TypeScript
groupIndex: ko.Observable<number>

#Property Value

Type
Observable<number>

#isDiscreteNumericScale Property

#Declaration

TypeScript
isDiscreteNumericScale: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#realSortMode Property

#Declaration

TypeScript
realSortMode: ko.Computed<string>

#Property Value

Type
Computed<string>

#sortMeasure Property

#Declaration

TypeScript
sortMeasure: ko.Observable<string>

#Property Value

Type
Observable<string>

#sortMode Property

#Declaration

TypeScript
sortMode: ko.Observable<DevExpress.Dashboard.Model.DimensionSortMode>

#Property Value

Type
Observable<DimensionSortMode>

#sortOrder Property

Specifies the sort order for dimension values.

#Declaration

TypeScript
sortOrder: ko.Observable<DevExpress.Dashboard.Model.DimensionSortOrder>

#Property Value

Type Description
Observable<DimensionSortOrder>

The DimensionSortOrder value that specifies the sort order for values.

#textGroupInterval Property

#Declaration

TypeScript
textGroupInterval: ko.Observable<DevExpress.Dashboard.Model.TextGroupInterval>

#Property Value

Type
Observable<TextGroupInterval>

#topNOptionsCount Property

#Declaration

TypeScript
topNOptionsCount: ko.Observable<number>

#Property Value

Type
Observable<number>

#topNOptionsEnabled Property

#Declaration

TypeScript
topNOptionsEnabled: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#topNOptionsMeasureName Property

#Declaration

TypeScript
topNOptionsMeasureName: ko.Observable<string>

#Property Value

Type
Observable<string>

#topNOptionsMode Property

#Declaration

TypeScript
topNOptionsMode: ko.Observable<DevExpress.Dashboard.Model.DimensionTopNMode>

#Property Value

Type
Observable<DimensionTopNMode>

#topNOptionsShowOthers Property

#Declaration

TypeScript
topNOptionsShowOthers: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#Methods

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

#grabFrom(dataItem) Method

#Declaration

TypeScript
grabFrom(
    dataItem: Dimension
): void

#Parameters

Name Type
dataItem Dimension

#isDefinitionEquals(dataItem) Method

#Declaration

TypeScript
isDefinitionEquals(
    dataItem: DevExpress.Dashboard.Model.DataItem
): boolean

#Parameters

Name Type
dataItem DataItem

#Returns

Type
boolean