GridOptions Class
In This Article
Contains options of the GridItem.
#Declaration
TypeScript
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
TypeScript
constructor(
JSON?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
#Parameters
Name | Type | Description |
---|---|---|
JSON | any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
serializer | Model |
An object used for dashboard deserialization. Do not pass this parameter directly. |
#Properties
#allowCellMerge Property
#Declaration
TypeScript
allowCellMerge: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#columnWidthMode Property
#Declaration
TypeScript
columnWidthMode: ko.Observable<DevExpress.Dashboard.Model.GridColumnWidthMode>
#Property Value
Type |
---|
Observable<Grid |
#enableBandedRows Property
#Declaration
TypeScript
enableBandedRows: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#showColumnHeaders Property
#Declaration
TypeScript
showColumnHeaders: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#showHorizontalLines Property
#Declaration
TypeScript
showHorizontalLines: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#showVerticalLines Property
#Declaration
TypeScript
showVerticalLines: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#wordWrap Property
#Declaration
TypeScript
wordWrap: ko.Observable<boolean>
#Property Value
Type |
---|
Observable<boolean> |
#Methods
#getInfo Method
For internal use.
#Declaration
TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |