primereact/components/datatable/DataTable.d.ts

[](https://opensource.org/licenses/MIT) [](https://badge.fury.io/js/primereact) [![Discord Chat](https://img.shields.io/discord/5579

import * as React from 'react';

interface DataTableProps {
    id?: string;
    value?: any[];
    header?: any;
    footer?: any;
    style?: object;
    className?: string;
    tableStyle?: object;
    tableClassName?: string;
    paginator?: boolean;
    paginatorPosition?: string;
    alwaysShowPaginator?: boolean;
    paginatorClassName?: string;
    paginatorTemplate?: string | object;
    paginatorLeft?: any;
    paginatorRight?: any;
    pageLinkSize?: number;
    paginatorDropdownAppendTo?: any;
    rowsPerPageOptions?: number[];
    currentPageReportTemplate?: string;
    first?: number;
    rows?: number;
    totalRecords?: number;
    lazy?: boolean;
    sortField?: string;
    sortOrder?: number;
    multiSortMeta?: any[];
    sortMode?: string;
    defaultSortOrder?: number;
    removableSort?: boolean;
    emptyMessage?: any;
    selectionMode?: string;
    selection?: any;
    contextMenuSelection?: any;
    compareSelectionBy?: string;
    dataKey?: string;
    metaKeySelection?: boolean;
    selectOnEdit?: boolean;
    headerColumnGroup?: any;
    footerColumnGroup?: any;
    frozenHeaderColumnGroup?: any;
    frozenFooterColumnGroup?: any;
    expandedRows?: any[] | object;
    resizableColumns?: boolean;
    columnResizeMode?: string;
    reorderableColumns?: boolean;
    filters?: object;
    globalFilter?: any;
    filterDelay?: number;
    filterLocale?: string;
    scrollable?: boolean;
    scrollHeight?: string;
    virtualScroll?: boolean;
    virtualScrollDelay?: number;
    virtualRowHeight?: number;
    frozenWidth?: string;
    frozenValue?: any[];
    csvSeparator?: string;
    exportFilename?: string;
    rowGroupMode?: string;
    autoLayout?:boolean;
    loading?:boolean;
    loadingIcon?:string;
    tabIndex?:number;
    stateKey?:string;
    stateStorage?:string;
    groupField?:string;
    editMode?:string;
    editingRows?: any[] | object;
    expandableRowGroups?:boolean;
    rowHover?:boolean;
    showSelectionElement?(e: {data: any}): boolean;
    showReorderElement?(e: {data: any}): boolean;
    onSelectionChange?(e: {originalEvent: Event, value: any}): void;
    onContextMenuSelectionChange?(e: {originalEvent: Event, value: any}): void;
    rowExpansionTemplate?(data: any): JSX.Element | undefined;
    onRowToggle?(e: {data: any[]}): void;
    rowClassName?(rowData: any): object;
    rowGroupHeaderTemplate?(data: any, index: number): React.ReactNode | undefined;
    rowGroupFooterTemplate?(data: any, index: number): React.ReactNode | undefined;
    onColumnResizeEnd?(e: {element: HTMLElement, delta: number}): void;
    onSort?(e: {sortField: string, sortOrder: number, multiSortMeta: any}): void;
    onPage?(e: {first: number, rows: number}): void;
    onFilter?(e: {filters: any}): void;
    onVirtualScroll?(e: {first: number, rows: number}): void;
    onRowClick?(e: {originalEvent: Event, data: any, index: number}): void;
    onRowDoubleClick?(e: {originalEvent: Event, data: any, index: number}): void;
    onRowSelect?(e: {originalEvent: Event, data: any, type: string}): void;
    onRowUnselect?(e: {originalEvent: Event, data: any, type: string}): void;
    onRowExpand?(e: {originalEvent: Event, data: any}): void;
    onRowCollapse?(e: {originalEvent: Event, data: any}): void;
    onContextMenu?(e: {originalEvent: Event, data: any}): void;
    onColReorder?(e: {originalEvent: Event, dragIndex: number, dropIndex: number, columns: any}): void;
    onRowReorder?(e: {originalEvent: Event, value: any, dragIndex: number, dropIndex: number}): void;
    onValueChange?(value: any[]): void;
    rowEditorValidator?(rowData: any): boolean;
    onRowEditInit?(e: {originalEvent: Event, data: any, index: number}): void;
    onRowEditSave?(e: {originalEvent: Event, data: any, index: number, valid: boolean}): void;
    onRowEditCancel?(e: {originalEvent: Event, data: any, index: number}): void;
    onRowEditChange?(e: {originalEvent: Event, data: any, index: number}): void;
    exportFunction?(e: {data: any, field: string}): any;
    customSaveState?(state: any): void;
    customRestoreState?(): any;
    onStateSave?(state: any): void;
    onStateRestore?(state: any): void;
}

export class DataTable extends React.Component<DataTableProps,any> {
    public reset():void;
    public exportCSV(options?: {selectionOnly: boolean}):void;
    public filter<T>(value:T, field:string, mode:string):void;
    public resetColumnOrder():void;
    public closeEditingCell():void;
}