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

Property Value

Type
KnockoutObservable<boolean>

columnWidthMode Property

Declaration

columnWidthMode: KnockoutObservable<GridColumnWidthMode>

Property Value

Type
KnockoutObservable<GridColumnWidthMode>

enableBandedRows Property

Declaration

enableBandedRows: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

showColumnHeaders Property

Declaration

showColumnHeaders: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

showHorizontalLines Property

Declaration

showHorizontalLines: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

showVerticalLines Property

Declaration

showVerticalLines: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

wordWrap Property

Declaration

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