RealGrid2 API
Interface
RowIndicator

RowIndicator

Configuration model for grid indicators

Signature:

export interface RowIndicator

Remarks

The indicator displays the row index or the position of the focused row.

When using GridBase.setRowIndicator(), you only need to enter the necessary information.

Example

gridView.setRowIndicator({zeroBase: true});

Properties

PropertyTypeDescription
cellStyleCallbackRowBarCellStyleCallbackCallbacks to style cells
displayOrdernumberOrder of appearance among check bars, status bars, and indicators (index)
displayValueIndicatorValueWhat to display in indicator cells
displayWidthnumberActual displayed width
draggableSelectedRowsbooleanWhether to move rows in the indicator cell of the selected rows
footTextstringText to display in foot area
headTextstringText to display in head area
indexOffsetnumberInterval between the number to be displayed on the indicator and the item index (row order)
markStateMark
maxWidthnumbermax width
minWidthnumbermin width
popupMenuPopupMenuItem[] | stringpop-up menu
rowOffsetnumberSpecifies the interval between the number to be displayed on the indicator and the data row unique number.
selectablebooleanWhether it is possible to specify a selection area when clicking or dragging with the mouse
showFocusbooleanWhether or not to apply the style to the cell corresponding to the focused row
showSelectionbooleanWhether to apply styles to related cells according to the data selection area
sumTextstringText to display in summary area
visiblebooleanVisibility
widthnumberwidth
zeroBasebooleanWhether the indicator number starts from 0

Properties Desc

cellStyleCallback

Callbacks to style cells

Type - RowBarCellStyleCallback


displayOrder

Order of appearance among check bars, status bars, and indicators (index)

Type - number

Remarks:

The smaller the number, the more left it is placed.


displayValue

What to display in indicator cells

Type - IndicatorValue


displayWidth

Actual displayed width

Type - number

Remarks:

Width of rowIndicator when width is 0


draggableSelectedRows

Whether to move rows in indicator cell of selected rows

Type - boolean


footText

Text to display in the foot area

Type - string


headText

Text to display in head area

Type - string


indexOffset

The gap between the number to be displayed on the indicator and the item index (row order)

Type - number

Remarks:

Indicator number = item index + indexOffset


mark

Type of status displayed on the indicator

Type - StateMark


maxWidth

max width

Type - number


minWidth

minimum width

Type - number


popupMenu

pop-up menu

Type - PopupMenuItem[] | string


rowOffset

Specifies the interval between the number to be displayed on the indicator and the data row unique number.

Type - number

Remarks:

Indicator number = data row number + rowOffset


selectable

Whether it is possible to specify a selection area when clicking or dragging with the mouse

Type - boolean

Remarks:

DisplayOptions.selectionMode is not SelectionMode.NONE and DisplayOptions.selectionStyle is not single selection style must be used to specify the selection area.


showFocus

Whether to apply the style to the cell corresponding to the focused row

Type - boolean

Remarks:

If true, the cell corresponding to the focused row is displayed in the 'rg-rowindicator-focus' style.


showSelection

Whether to apply styles to related cells according to the data selection area

Type - boolean

Remarks:

If true, related cells are displayed in 'rg-rowindicator-select' style according to the data selection area.


sumText

Text to display in summary area

Type - string


visible

Visibility

Type - boolean


width

width

Type - number

Remarks:

If 0, the width changes depending on the displayed content.


zeroBase

Whether indicator numbers start from 0

Type - boolean