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
Property | Type | Description |
---|---|---|
cellStyleCallback | RowBarCellStyleCallback | Callbacks to style cells |
displayOrder | number | Order of appearance among check bars, status bars, and indicators (index) |
displayValue | IndicatorValue | What to display in indicator cells |
displayWidth | number | Actual displayed width |
draggableSelectedRows | boolean | Whether to move rows in the indicator cell of the selected rows |
footText | string | Text to display in foot area |
headText | string | Text to display in head area |
indexOffset | number | Interval between the number to be displayed on the indicator and the item index (row order) |
mark | StateMark | |
maxWidth | number | max width |
minWidth | number | min width |
popupMenu | PopupMenuItem[] | string | pop-up menu |
rowOffset | number | Specifies the interval between the number to be displayed on the indicator and the data row unique number. |
selectable | boolean | Whether it is possible to specify a selection area when clicking or dragging with the mouse |
showFocus | boolean | Whether or not to apply the style to the cell corresponding to the focused row |
showSelection | boolean | Whether to apply styles to related cells according to the data selection area |
sumText | string | Text to display in summary area |
visible | boolean | Visibility |
width | number | width |
zeroBase | boolean | Whether 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