Dimension Class

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

Declaration

export class Dimension extends DataItem implements IDimensionDefinition
See Also

constructor

Initializes a new instance of the Dimension class.

Declaration

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

Optional Parameters

Name Type Default Description
dataItemJSON any null
serializer IModelSerializer null

Properties

coloringMode Property

Declaration

coloringMode: ko.Observable<ColoringMode>

Property Value

Type Description
ko.Observable<ColoringMode>

dateTimeGroupInterval Property

Specifies the group interval for date-time dimensions.

Declaration

dateTimeGroupInterval: ko.Observable<DateTimeGroupInterval>

Property Value

Type Description
ko.Observable<DateTimeGroupInterval>

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

groupChildValues Property

Declaration

groupChildValues: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

groupIndex Property

Declaration

groupIndex: ko.Observable<number>

Property Value

Type Description
ko.Observable<number>

isDiscreteNumericScale Property

Declaration

isDiscreteNumericScale: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

realSortMode Property

Declaration

realSortMode: ko.Computed<string>

Property Value

Type Description
ko.Computed<string>

sortMeasure Property

Declaration

sortMeasure: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

sortMode Property

Declaration

sortMode: ko.Observable<DimensionSortMode>

Property Value

Type Description
ko.Observable<DimensionSortMode>

sortOrder Property

Declaration

sortOrder: ko.Observable<DimensionSortOrder>

Property Value

Type Description
ko.Observable<DimensionSortOrder>

textGroupInterval Property

Declaration

textGroupInterval: ko.Observable<TextGroupInterval>

Property Value

Type Description
ko.Observable<TextGroupInterval>

topNOptionsCount Property

Declaration

topNOptionsCount: ko.Observable<number>

Property Value

Type Description
ko.Observable<number>

topNOptionsEnabled Property

Declaration

topNOptionsEnabled: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

topNOptionsMeasureName Property

Declaration

topNOptionsMeasureName: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

topNOptionsMode Property

Declaration

topNOptionsMode: ko.Observable<DimensionTopNMode>

Property Value

Type Description
ko.Observable<DimensionTopNMode>

topNOptionsShowOthers Property

Declaration

topNOptionsShowOthers: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

grabFrom(dataItem) Method

Declaration

grabFrom(dataItem: Dimension): void

Parameters

Name Type Description
dataItem Dimension

isDefinitionEquals(dataItem) Method

Declaration

isDefinitionEquals(dataItem: DataItem): any

Parameters

Name Type Description
dataItem DataItem

Returns

Type Description
any