RealGrid2 API
Interface
GridItem

GridItem

The item's information model

Signature:

export interface GridItem

Remarks

When returning the model of an item using GridBase.getModel(), GridBase.getModelAs(), etc. It is the format of

When returning the model of an item, the format of the returned model may differ depending on whether the extended parameter in the method is true or false.

Example

let model = gridView.getModelAs(3, 'row'); // return GridItem model

Properties

PropertyTypeDescription
checkablebooleanWhether selectable
checkedbooleanChecked or not
childIndexnumberYour order based on your parents
countnumberNumber of sub-items
dataRownumberRow unique number
dataRowsnumber[]Index of child rows in case of group item
expandedbooleanExpanded or not
firstDataItemGridItemIf it is a group item, the first data item
firstItemGridItemIf it is a group item, the first item
footerIdnumberfooter id
getData(field: string | number) => anyIf the type is "row" or "tree", the value of the entered field is retrieved.
idnumberitem id
indeterminatebooleanWhether indeterminate state
indexnumberOrder on the grid
itemIndexnumberOrder on the grid
levelnumberlevel
parentIdnumberparent's id
rowStateRowStateStatus value of row
typeundefined | 'row' | 'group' | 'tree' | 'footer'Type

Properties Desc

checkable

Whether selectable

Type - boolean


checked

Checked or not

Type - boolean


childIndex

Your order based on your parents

Type - number

Remarks:

extended must be true to obtain information.


count

Number of sub-items

Type - number


dataRow

Row unique number

Type - number


dataRows

Index of child rows in case of group item

Type - number[]

Remarks:

extended must be true to obtain information.


expanded

Unfolded or not

Type - boolean

Remarks:

You can obtain the relevant information when it is an item or group item of TreeView.


firstDataItem

If it is a group item, the first data item

Type - GridItem

Remarks:

extended must be true to obtain information.


firstItem

If it is a group item, the first item

Type - GridItem

Remarks:

extended must be true to obtain information.


footerId

footer id

Type - number


getData

If the type is "row" or "tree", the value of the entered field is retrieved.

Type - (field: string | number) => any


id

item id

Type - number


indeterminate

Whether indeterminate status

Type - boolean


index

Order on the grid

Type - number


itemIndex

Order on the grid

Type - number

Remarks:

Properties reserved for compatibility with RealGridJS


level

level

Type - number

Remarks:

A row of TreeView is the tree level.

extended must be true to obtain information.


parentId

parent's id

Type - number


rowState

Status value of row

Type - RowState


type

type

Type - undefined | 'row' | 'group' | 'tree' | 'footer'