Dimension Class

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

Declaration

export class Dimension extends DataItem implements IDimensionDefinition

Implements

IDimensionDefinition

Inherited Members

dataMember

dateTimeFormat

itemType

name

numericFormat

showGrandTotals

showTotals

showValues

uniqueName

typesMap

getUniqueNamePrefix

Inheritance

DataItem

Dimension

constructor

Initializes a new instance of the Dimension class.

Declaration

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

Parameters

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

Properties

coloringMode Property

Declaration

coloringMode: ko.Observable<ColoringMode>

Property Value

Type
Observable<ColoringMode>

dateTimeGroupInterval Property

Specifies the group interval for date-time dimensions.

Declaration

dateTimeGroupInterval: ko.Observable<DateTimeGroupInterval>

Property Value

Type	Description
Observable<DateTimeGroupInterval>	The DateTimeGroupInterval value that specifies the group interval for date-time dimensions.

groupChildValues Property

Declaration

groupChildValues: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

groupIndex Property

Declaration

groupIndex: ko.Observable<number>

Property Value

Type
Observable<number>

isDiscreteNumericScale Property

Declaration

isDiscreteNumericScale: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

realSortMode Property

Declaration

realSortMode: ko.Computed<string>

Property Value

Type
Computed<string>

sortMeasure Property

Declaration

sortMeasure: ko.Observable<string>

Property Value

Type
Observable<string>

sortMode Property

Declaration

sortMode: ko.Observable<DimensionSortMode>

Property Value

Type
Observable<DimensionSortMode>

sortOrder Property

Declaration

sortOrder: ko.Observable<DimensionSortOrder>

Property Value

Type
Observable<DimensionSortOrder>

textGroupInterval Property

Declaration

textGroupInterval: ko.Observable<TextGroupInterval>

Property Value

Type
Observable<TextGroupInterval>

topNOptionsCount Property

Declaration

topNOptionsCount: ko.Observable<number>

Property Value

Type
Observable<number>

topNOptionsEnabled Property

Declaration

topNOptionsEnabled: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

topNOptionsMeasureName Property

Declaration

topNOptionsMeasureName: ko.Observable<string>

Property Value

Type
Observable<string>

topNOptionsMode Property

Declaration

topNOptionsMode: ko.Observable<DimensionTopNMode>

Property Value

Type
Observable<DimensionTopNMode>

topNOptionsShowOthers Property

Declaration

topNOptionsShowOthers: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationInfoArray

grabFrom(dataItem) Method

Declaration

grabFrom(
    dataItem: Dimension
): void

Parameters

Name	Type
dataItem	Dimension

isDefinitionEquals(dataItem) Method

Declaration

isDefinitionEquals(
    dataItem: DataItem
): any

Parameters

Name	Type
dataItem	DataItem

Returns

Type
any