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.

Dimension Class

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

Declaration

export class Dimension extends DataItem implements IDimensionDefinition

Inheritance

DataItem
Dimension
See Also

constructor

Initializes a new instance of the Dimension class.

Declaration

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

Parameters

Type Name Description
any dataItemJSON
DxDesigner.Analytics.Utils.IModelSerializer serializer

Properties

coloringMode Property

Declaration

coloringMode: KnockoutObservable<ColoringMode>

Property Value

Type Description
KnockoutObservable<ColoringMode>

dateTimeGroupInterval Property

Specifies the group interval for date-time dimensions.

Declaration

dateTimeGroupInterval: KnockoutObservable<DateTimeGroupInterval>

Property Value

Type Description
KnockoutObservable<DateTimeGroupInterval>

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

groupChildValues Property

Declaration

groupChildValues: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

groupIndex Property

Declaration

groupIndex: KnockoutObservable<number>

Property Value

Type Description
KnockoutObservable<number>

isDiscreteNumericScale Property

Declaration

isDiscreteNumericScale: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

realSortMode Property

Declaration

realSortMode: KnockoutComputed<string>

Property Value

Type Description
KnockoutComputed<string>

sortMeasure Property

Declaration

sortMeasure: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<string>

sortMode Property

Declaration

sortMode: KnockoutObservable<DimensionSortMode>

Property Value

Type Description
KnockoutObservable<DimensionSortMode>

sortOrder Property

Declaration

sortOrder: KnockoutObservable<DimensionSortOrder>

Property Value

Type Description
KnockoutObservable<DimensionSortOrder>

textGroupInterval Property

Declaration

textGroupInterval: KnockoutObservable<TextGroupInterval>

Property Value

Type Description
KnockoutObservable<TextGroupInterval>

topNOptionsCount Property

Declaration

topNOptionsCount: KnockoutObservable<number>

Property Value

Type Description
KnockoutObservable<number>

topNOptionsEnabled Property

Declaration

topNOptionsEnabled: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

topNOptionsMeasureName Property

Declaration

topNOptionsMeasureName: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<string>

topNOptionsMode Property

Declaration

topNOptionsMode: KnockoutObservable<DimensionTopNMode>

Property Value

Type Description
KnockoutObservable<DimensionTopNMode>

topNOptionsShowOthers Property

Declaration

topNOptionsShowOthers: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo

 

grabFrom(dataItem) Method

Declaration

grabFrom(dataItem: Dimension): void

Parameters

Type Name Description
Dimension dataItem

isDefinitionEquals(dataItem) Method

Declaration

isDefinitionEquals(dataItem: DataItem): any

Parameters

Type Name Description
DataItem dataItem

Returns

Type Description
any