ag-grid-community/dist/types/src/interfaces/rowNumbers.d.ts

Advanced Data Grid / Data Table supporting Javascript / Typescript / React / Angular / Vue

import type { ColDef } from '../entities/colDef';
import type { HeaderComp } from '../headerRendering/cells/column/headerComp';
import type { CellCtrl } from '../rendering/cell/cellCtrl';
import type { CellPosition } from './iCellPosition';
import type { IColumnCollectionService } from './iColumnCollectionService';
export interface RowNumbersOptions extends Pick<ColDef, 'contextMenuItems' | 'context' | 'onCellClicked' | 'onCellContextMenu' | 'onCellDoubleClicked' | 'headerTooltip' | 'headerStyle' | 'headerComponent' | 'headerComponentParams' | 'suppressHeaderKeyboardEvent' | 'suppressNavigable' | 'tooltipField' | 'tooltipValueGetter' | 'tooltipComponent' | 'tooltipComponentParams' | 'tooltipComponentSelector' | 'valueGetter' | 'valueFormatter' | 'maxWidth' | 'cellRenderer' | 'cellRendererSelector' | 'cellRendererParams'> {
    /**
     * Set to `true` to prevent selecting all the currently visible cells in the row when clicking a Row Number.
     * @default false
     */
    suppressCellSelectionIntegration?: boolean;
    /** Set to `true` to add a resizer to each Row Number cell that allows row resizing.
     * @default false
     */
    enableRowResizer?: boolean;
    /**
     * The minimum width for the row number column.
     * @default 60
     */
    minWidth?: number;
    /**
     * The default width for the row number column.
     * @default 60
     */
    width?: number;
    /**
     * Whether this column is resizable.
     * @default false
     */
    resizable?: boolean;
}
/** @internal AG_GRID_INTERNAL - Not for public use. Can change / be removed at any time. */
export interface IRowNumbersService extends IColumnCollectionService {
    setupForHeader(comp: HeaderComp): void;
    handleMouseDownOnCell(cell: CellPosition, mouseEvent: MouseEvent): boolean;
    handleKeyDownOnCell(cell: CellPosition, event: KeyboardEvent): boolean;
    createRowNumbersRowResizerFeature(ctrl: CellCtrl): IRowNumbersRowResizeFeature | undefined;
}
export interface IRowNumbersRowResizeFeature {
    refreshRowResizer(): void;
    destroy(): void;
}