d2coreui 21.0.33 → 23.0.0

package/components/grid/dataGrid.d.ts

@@ -1,206 +1,218 @@
-import React, { ReactElement } from "react";
-import 'ag-grid-community/dist/styles/ag-grid.css';
-import 'ag-grid-community/dist/styles/ag-theme-balham.css';
-import 'd2coreui/style/ag-grid/aggrid-adaptations.css';
-import { ContextMenuProps } from "d2coreui/components/grid/export/contextMenu";
-import { WildcardQuickFilter } from "d2coreui/components/grid/cell/wildcardQuickFilter";
-import { CellClassParams, CellFocusedEvent, CellMouseDownEvent, ColDef, Column, ColumnApi, ColumnEvent, ColumnState, FilterChangedEvent, FilterModifiedEvent, GridApi, GridOptions, GridReadyEvent, PaginationChangedEvent, RowClassParams, RowNode, RowStyle, ViewportChangedEvent } from "ag-grid-community";
-import { GridRowStyle, RowStyleRule } from "d2coreui/components/grid/cell/tableDefaultRowStyleRules";
-import ProgressPopup from "d2coreui/components/grid/export/progressPopup";
-export declare const EXPORT_SEPARATOR = "\n";
-export declare type MenuElement = JSX.Element;
-declare const enum NavigationEventEnum {
-    KEYBOARD = 0,
-    MOUSE = 1
-}
-export interface DataGridViewportChangedEvent extends ViewportChangedEvent {
-    rowsScrollingDelta: number;
-}
-export declare type SortMode = "asc" | "desc";
-export interface SortItem {
-    colId: string;
-    sort: SortMode;
-}
-export declare type FilterRenderer = (value: string, changeValue: (newValue: string) => void, onSearch: () => void) => React.ReactNode;
-export interface DataGridColDef extends Omit<ColDef, "cellStyle"> {
-    group: string;
-    context?: any;
-    cellStyle?: {
-        [cssProperty: string]: string | number | null;
-    } | ((cellClassParams: CellClassParams) => {
-        [cssProperty: string]: string | number | null;
-    } | undefined);
-    renderFilter?: FilterRenderer;
-}
-export interface DataGridFilterProps {
-    columnSearchVisible?: boolean;
-    onColumnSearchVisible?: (visible: boolean) => void;
-    getFilterModel?(): any;
-    onFilterChanged?(event: FilterChangedEvent): void;
-    onFilterModified?(event: FilterModifiedEvent): void;
-    onFilterConfirmed?(): void;
-}
-export interface DataGridSearchProps {
-    placeholder?: string;
-    searchString?: string;
-    searchHistory?: string[];
-    searchButtonClassName?: string;
-    searchButtonDisabled?: boolean;
-    hidden?: boolean;
-    searchRenderer?(): React.ReactNode;
-    inputReadonly?: boolean;
-    stringFormatter?(rawString: string): string;
-    onChange?(searchString: string): void;
-    onSearch?(): void;
-}
-export declare type OnLoadDataCallback = (totalRecords: number) => void;
-export interface DataGridProps extends Omit<GridOptions, "columnDefs" | "paginationPageSize" | "getRowStyle" | "cellStyle"> {
-    gridOptions?: GridOptions;
-    columnDefs: DataGridColDef[];
-    disableColumnDefsPreprocessing?: boolean;
-    onColumnDefsAdapted?(columnDefs: ColDef[]): void;
-    tableConfigVisible?: boolean;
-    columnsConfigVisible?: boolean;
-    panelStyle?: React.CSSProperties;
-    tablePanelStyle?: React.CSSProperties;
-    filter?: DataGridFilterProps;
-    search?: DataGridSearchProps;
-    paging: {
-        pageSize: number;
-        defaultPageSize?: number;
-        onPaginationChanged?: (currentPageSize: number | null, definedPageSize: number) => void;
-    };
-    onLoadData(callback: OnLoadDataCallback): void;
-    autofocus?: boolean;
-    onKeyPressed?(event: KeyboardEvent): void;
-    onEnter?: () => void;
-    selectedIds?: (number | string)[];
-    rowStyleRules: RowStyleRule[];
-    defaultRowStyleRules?: RowStyleRule[];
-    onChangeRowStyleRules?(rowStyleRules: RowStyleRule[]): void;
-    toolbar?: {
-        renderToolbar?(originalSearchBar: ReactElement): ReactElement;
-        toolbarButtons?: ReactElement;
-        hideRecordCount?: boolean;
-    };
-    onRowHeightChanged?(rowHeight: number): void;
-    onColumnsChanged?(columnModel: ColumnState[], event: ColumnEvent): void;
-    onTableConfigVisible?(visible: boolean): void;
-    onColumnsConfigVisible?(visible: boolean): void;
-    loadingOverlayRenderer?(): ReactElement | null;
-    noRecordsOverlayRenderer?(): ReactElement | null;
-    tableOverlayRenderer?(): ReactElement | null;
-    showMilliseconds?: boolean;
-    defaultShowMilliseconds?: boolean;
-    onShowMilliseconds?(show: boolean, callback: () => void): void;
-    hideYear?: boolean;
-    defaultHideYear?: boolean;
-    onShowYear?(show: boolean, callback: () => void): void;
-    exportMenu?: {
-        renderer?(menuElements: MenuElement[]): MenuElement[];
-        onClick?(key: string): void;
-    };
-    settingsMenu?: {
-        renderer?(menuElements: MenuElement[]): MenuElement[];
-        onClick?(key: string): void;
-    };
-    contextMenu?: {
-        renderer?(menuElements: MenuElement[]): MenuElement[];
-        onClick?(key: string): void;
-    };
-    getRowStyle?(params: any): GridRowStyle | undefined;
-}
-interface DataGridState {
-    pageIndex: number;
-    pageSize: number | null;
-    recordsCount?: number;
-    columnModel: ColumnState[];
-    sortModel: SortItem[];
-    tableConfigVisible: boolean;
-    columnsConfigVisible: boolean;
-    rowHeight: number;
-    viewport: [number, number];
-    contextMenuVisible: boolean;
-    firstLoadDone: boolean;
-    loading: boolean;
-    columnTransferHeight: number;
-}
-export default class DataGrid extends React.Component<DataGridProps, DataGridState> {
-    static defaultProps: {
-        paging: {
-            pageSize: number;
-            defaultPageSize: number;
-        };
-        rowStyleRules: RowStyleRule[];
-    };
-    wildcardQuickFilter: WildcardQuickFilter;
-    columnTypes: {
-        [key: string]: ColDef;
-    };
-    gridApi?: GridApi;
-    gridColumnApi?: ColumnApi;
-    columnModelBeforeEdit?: ColumnState[];
-    indexToJump: number | null;
-    columnToJump: Column | null;
-    lastCellFocus?: CellFocusedEvent;
-    lastNavigationEvent?: NavigationEventEnum;
-    table_context: any;
-    private wrappingDiv;
-    constructor(props: Readonly<DataGridProps>);
-    private static getCellValue;
-    textCustomComparator(filter: string, value: any, filterText: string): boolean;
-    componentDidUpdate(prevProps: DataGridProps): void;
-    setColumnState(columnModel: ColumnState[]): void;
-    setSortModel(sortModel: SortItem[]): void;
-    getSortModel(): SortItem[];
-    updateRowHeight(): void;
-    calculateRowHeight(rowStyleRules?: RowStyleRule[]): number | undefined;
-    static getDerivedStateFromProps(props: DataGridProps, state: DataGridState): Partial<DataGridState>;
-    onGridReady(gridReadyEvent: GridReadyEvent): void;
-    onPaginationChanged(event: PaginationChangedEvent): void;
-    onViewportChanged(event: ViewportChangedEvent): void;
-    changePagination(pageSize: number): void;
-    showMilliseconds(showMilis: boolean): void;
-    showYear(showYear: boolean): void;
-    changeRowHeight(rowHeight: number): void;
-    onGoToPage(pageIndex: number): void;
-    loadData(callback?: () => void): void;
-    focus(): void;
-    isActive(): boolean;
-    onColumnsChanged(event: ColumnEvent): void;
-    setColumnSearchVisible(visible: boolean): void;
-    private onFilterModified;
-    private onFilterChanged;
-    private onFilterConfirmed;
-    private onSortChanged;
-    showTableConfiguration(show: boolean): void;
-    showColumnsConfig(show: boolean): void;
-    private navigateToNextCell;
-    private suppressKeyboardEvent;
-    getValue(column: Column, row: RowNode, doNotReplaceNewline?: boolean): string;
-    getExportContent(progressPopup: ProgressPopup | null, props: ContextMenuProps): Promise<string[][]>;
-    onCellFocused(event: CellFocusedEvent): void;
-    onCellMouseDown(e: CellMouseDownEvent): void;
-    setFocusedCellDebounced(rowIndex: number, column: string | Column, rowPinned: string | undefined): void;
-    private onCellContextMenu;
-    private loadingOverlayRenderer;
-    private noRecordsOverlayRenderer;
-    private onRowDataUpdated;
-    private static EMPTY_STYLE;
-    _getRowStyle(params: RowClassParams): RowStyle;
-    _getRowHeight(): number;
-    _getCellStyle(params: {
-        colDef: ColDef;
-    }): {
-        [key: string]: any;
-    };
-    getDefaultColDefinition(colDef: ColDef | undefined): ColDef;
-    private getCustomFrameworkComponents;
-    renderNavigationPanel(): ReactElement;
-    renderToolBarWithSearch(): ReactElement;
-    renderSettingsMenu(): ReactElement;
-    private renderContextMenu;
-    private getAdaptedColumnDefs;
-    render(): JSX.Element;
-}
-export {};
+import React, { ReactElement } from "react";
+import { MenuProps } from "antd";
+import { AgGridReact } from "ag-grid-react";
+import 'ag-grid-community/styles/ag-grid.css';
+import 'ag-grid-community/styles/ag-theme-balham.css';
+import 'd2coreui/style/ag-grid/aggrid-adaptations.css';
+import { ContextMenuProps, PageOrientation } from "d2coreui/components/grid/export/contextMenu";
+import { CellClassParams, CellFocusedEvent, CellMouseDownEvent, ColDef, Column, ColumnEvent, ColumnState, FilterChangedEvent, FilterModifiedEvent, GridApi, GridOptions, GridReadyEvent, IRowNode, PaginationChangedEvent, RowClassParams, RowPinnedType, RowStyle, ViewportChangedEvent } from "ag-grid-community";
+import { GridRowStyle, RowStyleRule } from "d2coreui/components/grid/cell/tableDefaultRowStyleRules";
+import ProgressPopup from "d2coreui/components/grid/export/progressPopup";
+import WildcardQuickFilterEngine from "./filter/wildcardQuickFilterEngine";
+export declare const EXPORT_SEPARATOR = "\n";
+export type MenuElement = Exclude<Exclude<MenuProps["items"], undefined>[number], null>;
+declare const enum NavigationEventEnum {
+    KEYBOARD = 0,
+    MOUSE = 1
+}
+export interface DataGridViewportChangedEvent extends ViewportChangedEvent {
+    rowsScrollingDelta: number;
+}
+export type SortMode = "asc" | "desc";
+export interface SortItem {
+    colId: string;
+    sort: SortMode;
+}
+export type FilterRenderer = (value: string, changeValue: (newValue: string) => void, onSearch: () => void) => React.ReactNode;
+export interface DataGridColDef extends Omit<ColDef, "cellStyle"> {
+    group: string;
+    context?: any;
+    cellStyle?: {
+        [cssProperty: string]: string | number | null;
+    } | ((cellClassParams: CellClassParams) => {
+        [cssProperty: string]: string | number | null;
+    } | undefined);
+    renderFilter?: FilterRenderer;
+}
+export interface DataGridFilterProps {
+    columnSearchVisible?: boolean;
+    onColumnSearchVisible?: (visible: boolean) => void;
+    getFilterModel?(): any;
+    onFilterChanged?(event: FilterChangedEvent): void;
+    onFilterModified?(event: FilterModifiedEvent): void;
+    onFilterConfirmed?(): void;
+}
+export interface DataGridSearchProps {
+    placeholder?: string;
+    searchString?: string;
+    searchHistory?: string[];
+    searchButtonClassName?: string;
+    searchButtonDisabled?: boolean;
+    hidden?: boolean;
+    searchRenderer?(): React.ReactNode;
+    inputReadonly?: boolean;
+    stringFormatter?(rawString: string): string;
+    onChange?(searchString: string): void;
+    onSearch?(): void;
+}
+export type OnLoadDataCallback = (totalRecords: number) => void;
+export interface DataGridProps extends Omit<GridOptions, "columnDefs" | "paginationPageSize" | "getRowStyle" | "cellStyle"> {
+    gridOptions?: GridOptions;
+    columnDefs: DataGridColDef[];
+    disableColumnDefsPreprocessing?: boolean;
+    onColumnDefsAdapted?(columnDefs: ColDef[]): void;
+    tableConfigVisible?: boolean;
+    columnsConfigVisible?: boolean;
+    panelStyle?: React.CSSProperties;
+    tablePanelStyle?: React.CSSProperties;
+    filter?: DataGridFilterProps;
+    search?: DataGridSearchProps;
+    paging: {
+        pageSize: number;
+        defaultPageSize?: number;
+        onPaginationChanged?: (currentPageSize: number | null, definedPageSize: number) => void;
+    };
+    rowDataManualMode?: boolean;
+    onLoadData(callback: OnLoadDataCallback): void;
+    autofocus?: boolean;
+    onKeyPressed?(event: KeyboardEvent): void;
+    onEnter?: () => void;
+    selectedIds?: (number | string)[];
+    rowStyleRules: RowStyleRule[];
+    defaultRowStyleRules?: RowStyleRule[];
+    onChangeRowStyleRules?(rowStyleRules: RowStyleRule[]): void;
+    toolbar?: {
+        renderToolbar?(originalSearchBar: ReactElement): ReactElement;
+        toolbarButtons?: ReactElement;
+        hideRecordCount?: boolean;
+    };
+    onRowHeightChanged?(rowHeight: number): void;
+    onColumnsChanged?(columnModel: ColumnState[], event: ColumnEvent): void;
+    onTableConfigVisible?(visible: boolean): void;
+    onColumnsConfigVisible?(visible: boolean): void;
+    loadingOverlayRenderer?(): ReactElement | null;
+    noRecordsOverlayRenderer?(): ReactElement | null;
+    tableOverlayRenderer?(): ReactElement | null;
+    showMilliseconds?: boolean;
+    defaultShowMilliseconds?: boolean;
+    onShowMilliseconds?(show: boolean, callback: () => void): void;
+    hideYear?: boolean;
+    defaultHideYear?: boolean;
+    onShowYear?(show: boolean, callback: () => void): void;
+    exportMenu?: {
+        renderer?(menuElements: MenuElement[]): MenuElement[];
+        onClick?(key: string): void;
+    };
+    settingsMenu?: {
+        renderer?(menuElements: MenuElement[]): MenuElement[];
+        onClick?(key: string): void;
+    };
+    contextMenu?: {
+        renderer?(menuElements: MenuElement[]): MenuElement[];
+        onClick?(key: string): void;
+    };
+    getRowStyle?(params: any): GridRowStyle | undefined;
+    gridRef?: React.RefObject<AgGridReact>;
+}
+interface DataGridState {
+    pageIndex: number;
+    pageSize: number | null;
+    recordsCount?: number;
+    columnModel: ColumnState[];
+    sortModel: SortItem[];
+    tableConfigVisible: boolean;
+    columnsConfigVisible: boolean;
+    fontSize: number;
+    rowHeight: number;
+    viewport: [number, number];
+    contextMenuVisible: boolean;
+    firstLoadDone: boolean;
+    loading: boolean;
+    columnTransferHeight: number;
+    pageOrientation: PageOrientation;
+    exporting: boolean;
+}
+export default class DataGrid extends React.Component<DataGridProps, DataGridState> {
+    static defaultProps: {
+        paging: {
+            pageSize: number;
+            defaultPageSize: number;
+        };
+        rowStyleRules: RowStyleRule[];
+    };
+    wildcardQuickFilter: WildcardQuickFilterEngine;
+    columnTypes: {
+        [key: string]: ColDef;
+    };
+    gridApi?: GridApi;
+    columnModelBeforeEdit?: ColumnState[];
+    indexToJump: number | null;
+    columnToJump: Column | null;
+    lastCellFocus?: CellFocusedEvent;
+    lastNavigationEvent?: NavigationEventEnum;
+    lastPaginationEvent?: PaginationChangedEvent | null;
+    table_context: any;
+    private wrappingDiv;
+    constructor(props: Readonly<DataGridProps>);
+    private static getCellValue;
+    textCustomComparator(filter: string, value: any, filterText: string): boolean;
+    componentDidUpdate(prevProps: DataGridProps): void;
+    setColumnState(columnModel: ColumnState[]): void;
+    setSortModel(sortModel: SortItem[]): void;
+    getSortModel(): SortItem[];
+    updateRowHeight(): void;
+    calculateRowAndFontHeight(rowStyleRules?: RowStyleRule[]): {
+        fontSize: number;
+        rowHeight: number;
+    };
+    static getDerivedStateFromProps(props: DataGridProps, state: DataGridState): Partial<DataGridState>;
+    onGridReady(gridReadyEvent: GridReadyEvent): void;
+    onPaginationChanged(event: PaginationChangedEvent): void;
+    onViewportChanged(event: ViewportChangedEvent): void;
+    changePagination(pageSize: number): void;
+    showMilliseconds(showMilis: boolean): void;
+    showYear(showYear: boolean): void;
+    changeRowHeight(fontSize: number, rowHeight: number): void;
+    onGoToPage(pageIndex: number): void;
+    loadData(callback?: () => void): void;
+    focus(): void;
+    isActive(): boolean;
+    onColumnsChanged(event: ColumnEvent): void;
+    setColumnSearchVisible(visible: boolean): void;
+    private onFilterModified;
+    private onFilterChanged;
+    private onFilterConfirmed;
+    private onSortChanged;
+    showTableConfiguration(show: boolean): void;
+    showColumnsConfig(show: boolean): void;
+    private navigateToNextCell;
+    private suppressKeyboardEvent;
+    getValue(column: Column, row: IRowNode, doNotReplaceNewline?: boolean): string;
+    getExportContent(progressPopup: ProgressPopup | null, props: ContextMenuProps): Promise<string[][]>;
+    onCellFocused(event: CellFocusedEvent): void;
+    onCellMouseDown(e: CellMouseDownEvent): void;
+    setFocusedCellDebounced(rowIndex: number, column: string | Column, rowPinned: RowPinnedType): void;
+    private onCellContextMenu;
+    private loadingOverlayRenderer;
+    private noRecordsOverlayRenderer;
+    setRowData(dataArray: any[]): void;
+    private onRowDataUpdated;
+    private static EMPTY_STYLE;
+    _getRowStyle(params: RowClassParams): RowStyle;
+    _getRowHeight(): number;
+    _getCellStyle(params: {
+        colDef: ColDef;
+    }): {
+        [key: string]: any;
+    };
+    getDefaultColDefinition(colDef: ColDef | undefined): ColDef;
+    private getCustomComponents;
+    private onPageOrientationChange;
+    private onExport;
+    renderNavigationPanel(): ReactElement;
+    renderToolBarWithSearch(): ReactElement;
+    getSettingsMenu(): MenuProps;
+    private getAdaptedColumnDefs;
+    render(): React.JSX.Element;
+}
+export {};