React Data GridRow Numbers

Enterprise

The Row Numbers Feature adds a Column that is always present at the start of the grid where each cell of this column will work as a row header. The following example demonstrates the grid with Row Numbers and no additional configuration.

To enable Row Numbers, set the grid option rowNumbers = true.

rowNumbersCopy
boolean | RowNumbersOptions
default: false
Configure the Row Numbers Feature.
const rowNumbers = true;

<AgGridReact rowNumbers={rowNumbers} />

Cell Selection Copy

When the grid is configured with Cell Selection, clicking a Row Number will select all the currently visible cells in the row.

const rowNumbers = true;
const cellSelection = true;

<AgGridReact
    rowNumbers={rowNumbers}
    cellSelection={cellSelection}
/>

Suppressing Integration Copy

By default, clicking a row number selects a cell range including all the cells in the row. To prevent this behaviour use the suppressCellSelectionIntegration option.

const rowNumbers = useMemo(() => { 
	return {
        suppressCellSelectionIntegration: true
    };
}, []);
const cellSelection = true;

<AgGridReact
    rowNumbers={rowNumbers}
    cellSelection={cellSelection}
/>
suppressCellSelectionIntegrationCopy
boolean
default: false
Set to true to prevent selecting all the currently visible cells in the row when clicking a Row Number.

Value Export Copy

By default, when working with exporters such as CSV Export or Excel Export, the value of the Row Numbers column is not exported. This behaviour can be changed by toggling the exportRowNumbers of the export params.

const rowNumbers = true;
const cellSelection = true;
const defaultExcelExportParams = useMemo(() => { 
	return {
        exportRowNumbers: true,
    };
}, []);

<AgGridReact
    rowNumbers={rowNumbers}
    cellSelection={cellSelection}
    defaultExcelExportParams={defaultExcelExportParams}
/>

ExportParams Copy

exportRowNumbersCopy
boolean
Set to true to allow the contents of the Header Row Column to be exported.

Customising Row Numbers Copy

Row Numbers can be customised by providing a RowNumbersOptions object to the rowNumbers grid option:

suppressCellSelectionIntegrationCopy
boolean
default: false
Set to true to prevent selecting all the currently visible cells in the row when clicking a Row Number.
minWidthCopy
number
default: 60
The minimum width for the row number column.
widthCopy
number
default: 60
The default width for the row number column.
resizableCopy
boolean
default: false
Whether this column is resizable.
contextMenuItemsCopy
(DefaultMenuItem | MenuItemDef)[] | GetContextMenuItems
Customise the list of menu items available in the context menu.
contextCopy
any
Context property that can be used to associate arbitrary application data with this column definition.
onCellClickedCopy
Function
Callback called when a cell is clicked.
onCellContextMenuCopy
Function
Callback called when a cell is right clicked.
onCellDoubleClickedCopy
Function
Callback called when a cell is double clicked.
headerTooltipCopy
string
Tooltip for the column header
headerStyleCopy
HeaderStyle | HeaderStyleFunc
An object of CSS values / or function returning an object of CSS values for a particular header.
headerComponentCopy
any
The custom header component to be used for rendering the component header. If none specified the default AG Grid header component is used. See Header Component for framework specific implementation detail.
headerComponentParamsCopy
any
The parameters to be passed to the headerComponent.
suppressHeaderKeyboardEventCopy
Function
Suppress the grid taking action for the relevant keyboard event when a header is focused.
tooltipFieldCopy
ColDefField
The field of the tooltip to apply to the cell.
tooltipValueGetterCopy
Function
Callback that should return the string to use for a tooltip, tooltipField takes precedence if set. If using a custom tooltipComponent you may return any custom value to be passed to your tooltip component.
tooltipComponentCopy
any
Provide your own tooltip component for the column. See Tooltip Component for framework specific implementation details.
tooltipComponentParamsCopy
any
The params used to configure tooltipComponent.
valueGetterCopy
string | ValueGetterFunc
Function or expression. Gets the value from your data for display.
valueFormatterCopy
string | ValueFormatterFunc
A function or expression to format a value, should return a string.
maxWidthCopy
number
Maximum width in pixels for the cell.