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: KnockoutObservable<ColoringMode>

Property Value

Type
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
KnockoutObservable<boolean>

groupIndex Property

Declaration

groupIndex: KnockoutObservable<number>

Property Value

Type
KnockoutObservable<number>

isDiscreteNumericScale Property

Declaration

isDiscreteNumericScale: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

realSortMode Property

Declaration

realSortMode: KnockoutComputed<string>

Property Value

Type
KnockoutComputed<string>

sortMeasure Property

Declaration

sortMeasure: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

sortMode Property

Declaration

sortMode: KnockoutObservable<DimensionSortMode>

Property Value

Type
KnockoutObservable<DimensionSortMode>

sortOrder Property

Declaration

sortOrder: KnockoutObservable<DimensionSortOrder>

Property Value

Type
KnockoutObservable<DimensionSortOrder>

textGroupInterval Property

Declaration

textGroupInterval: KnockoutObservable<TextGroupInterval>

Property Value

Type
KnockoutObservable<TextGroupInterval>

topNOptionsCount Property

Declaration

topNOptionsCount: KnockoutObservable<number>

Property Value

Type
KnockoutObservable<number>

topNOptionsEnabled Property

Declaration

topNOptionsEnabled: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

topNOptionsMeasureName Property

Declaration

topNOptionsMeasureName: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

topNOptionsMode Property

Declaration

topNOptionsMode: KnockoutObservable<DimensionTopNMode>

Property Value

Type
KnockoutObservable<DimensionTopNMode>

topNOptionsShowOthers Property

Declaration

topNOptionsShowOthers: KnockoutObservable<boolean>

Property Value

Type
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

Name	Type
dataItem	Dimension

isDefinitionEquals(dataItem) Method

Declaration

isDefinitionEquals(
    dataItem: DataItem
): any

Parameters

Name	Type
dataItem	DataItem

Returns

Type
any