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.

constructor

Initializes a new instance of the GridOptions class.

Declaration

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

Parameters

Name	Type	Description
JSON	any
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

allowCellMerge Property

Declaration

allowCellMerge: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

columnWidthMode Property

Declaration

columnWidthMode: ko.Observable<GridColumnWidthMode>

Property Value

Type
Observable<GridColumnWidthMode>

enableBandedRows Property

Declaration

enableBandedRows: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

showColumnHeaders Property

Declaration

showColumnHeaders: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

showHorizontalLines Property

Declaration

showHorizontalLines: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

showVerticalLines Property

Declaration

showVerticalLines: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

wordWrap Property

Declaration

wordWrap: 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