GridDeltaColumn Class

Declaration

export class GridDeltaColumn extends GridColumn

Remarks

A delta column binds to two measures, calculates summaries for both and displays the difference between these summaries.

Measures to which a delta column is bound are called Actual and Target values. Use the GridDeltaColumn.actualValue and GridDeltaColumn.targetValue properties to specify these measures.

The dashboard calculates summaries against both measures using functions specified by their Measure.summaryType properties and displays the difference between these summary values in the delta column.

Values in the delta column can be displayed as text or represented by bars. To select between these modes, use the GridDeltaColumn.displayMode property.

GridWeb_DeltaColumn_Bars

Note

If bars are displayed, use the GridDeltaColumn.alwaysShowZeroLevel property to specify whether the zero level is always shown.

Use the GridDeltaColumn.deltaOptions property to access options that control the calculation of column values and define the delta indication.

Inheritance

GridColumn
GridDeltaColumn

constructor(dataItemProvider)

Declaration

constructor(dataItemProvider: DataDashboardItem, dashboardItemJSON?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer)

Parameters

Type Name Description
DataDashboardItem dataItemProvider
any dashboardItemJSON
DxDesigner.Analytics.Utils.ModelSerializer serializer

Properties

absoluteVariationNumericFormat Property

Declaration

absoluteVariationNumericFormat: AbsoluteVariationNumericFormat

Property Value

Type Description
AbsoluteVariationNumericFormat

actualValue Property

Declaration

actualValue: KnockoutObservable<Measure>

Property Value

Type Description
KnockoutObservable<Measure>

alwaysShowZeroLevel Property

Declaration

alwaysShowZeroLevel: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

deltaOptions Property

Provides access to options that control the calculation of column values and define the delta indication.

Declaration

deltaOptions: DeltaOptions

Property Value

Type Description
DeltaOptions

A DeltaOptions object that contains delta settings.

displayMode Property

Declaration

displayMode: KnockoutObservable<GridColumnValueBarDisplayMode>

Property Value

Type Description
KnockoutObservable<GridColumnValueBarDisplayMode>

percentOfTargetNumericFormat Property

Declaration

percentOfTargetNumericFormat: PercentOfTargetNumericFormat

Property Value

Type Description
PercentOfTargetNumericFormat

percentVariationNumericFormat Property

Declaration

percentVariationNumericFormat: PercentVariationNumericFormat

Property Value

Type Description
PercentVariationNumericFormat

targetValue Property

Declaration

targetValue: KnockoutObservable<Measure>

Property Value

Type Description
KnockoutObservable<Measure>

Methods

getInfo Method

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo