The requested page is not available for the requested platform. You are viewing the content for Default platform.

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

Initializes a new instance of the GridOptions class.

Declaration

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

Optional Parameters

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

An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

allowCellMerge Property

Declaration

allowCellMerge: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

columnWidthMode Property

Declaration

columnWidthMode: ko.Observable<GridColumnWidthMode>

Property Value

Type Description
ko.Observable<GridColumnWidthMode>

enableBandedRows Property

Declaration

enableBandedRows: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

showColumnHeaders Property

Declaration

showColumnHeaders: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

showHorizontalLines Property

Declaration

showHorizontalLines: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

showVerticalLines Property

Declaration

showVerticalLines: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

wordWrap Property

Declaration

wordWrap: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfoArray