GridOptions Class

Contains options of the GridItem.

Declaration

export class GridOptions extends SerializableModel

Remarks

The GridOptions class contains various grid options, such as grid line visibility, banded rows, cell merging, etc.

To access grid options, use the GridItem.gridOptions property.

Inheritance

SerializableModel
GridOptions

constructor

Declaration

constructor(JSON?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer)

Parameters

Type Name Description
any JSON
DxDesigner.Analytics.Utils.ModelSerializer serializer

Properties

allowCellMerge Property

Declaration

allowCellMerge: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

columnWidthMode Property

Declaration

columnWidthMode: KnockoutObservable<GridColumnWidthMode>

Property Value

Type Description
KnockoutObservable<GridColumnWidthMode>

enableBandedRows Property

Declaration

enableBandedRows: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

showColumnHeaders Property

Declaration

showColumnHeaders: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

showHorizontalLines Property

Declaration

showHorizontalLines: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

showVerticalLines Property

Declaration

showVerticalLines: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

wordWrap Property

Declaration

wordWrap: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

Methods

getInfo Method

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo